Interface OrderHistoryItem

All Known Implementing Classes:
OrderHistoryItemJson
public interface OrderHistoryItem
A single order history record (order-header) returned by an order history search.

  • Method Details

    • getOrderNumber

      String getOrderNumber()
      Returns the order number.
      Returns:
      the order number

    • getType

      List<String> getType()
      Returns the list of products ordered in the order.
      Returns:
      the product types

    • getOrderStatus

      OrderHistoryStatus getOrderStatus()
      Returns the order status (see OrderHistoryStatus for the values the live service uses; unrecognised values read as UNKNOWN).
      Returns:
      the order status

    • getCreatedAt

      String getCreatedAt()
      Returns the order created date and time in ISO date format.
      Returns:
      the created date and time

    • getSubmittedDate

      String getSubmittedDate()
      Returns the submitted date.
      Returns:
      the submitted date

    • getAccount

      OrderHistoryAccount getAccount()
      Returns the account associated with the order.
      Returns:
      the account

    • getOrderingContact

      OrderHistoryContact getOrderingContact()
      Returns the ordering contact.
      Returns:
      the ordering contact

    • getNotificationContact

      OrderHistoryContact getNotificationContact()
      Returns the notification contact.
      Returns:
      the notification contact

    • getNotificationContacts

      List<OrderHistoryContact> getNotificationContacts()
      Returns the notification contacts, as the live service returns them (notificationContacts array). Not in the orderhistoryv1 spec.
      Returns:
      the notification contacts, or null

    • getTechnicalContacts

      List<OrderHistoryContact> getTechnicalContacts()
      Returns the technical contacts (technicalContacts). Not in the orderhistoryv1 spec.
      Returns:
      the technical contacts, or null

    • getOrderSource

      String getOrderSource()
      Returns where the order was placed, for example Portal (orderSource). Not in the orderhistoryv1 spec.
      Returns:
      the order source, or null

    • getIbx

      List<String> getIbx()
      Returns the list of IBXs for the order lines.
      Returns:
      the IBXs

    • getCustomerReferenceNumbers

      List<String> getCustomerReferenceNumbers()
      Returns the list of customer reference numbers for the order lines.
      Returns:
      the customer reference numbers

    • getLinks

      List<OrderHistoryLink> getLinks()
      Returns the HATEOAS links for the order.
      Returns:
      the links