Interface ShipmentSearchOrder

All Superinterfaces:
Extensible, OsidAggregateableSearchOrder, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable
public interface ShipmentSearchOrder extends OsidObjectSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderBySource

      void orderBySource(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the source.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsSourceSearchOrder

      boolean supportsSourceSearchOrder()
      Tests if a resource search order is available.
      Returns:
      true if a resource search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSourceSearchOrder

      ResourceSearchOrder getSourceSearchOrder()
      Specifies a preference for ordering the result set by the source.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsSourceSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSourceSearchOrder()} is {@code true} .

    • orderByOrder

      void orderByOrder(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the order.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderSearchOrder

      boolean supportsOrderSearchOrder()
      Tests if an order search order is available.
      Returns:
      true if an order search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getOrderSearchOrder

      OrderSearchOrder getOrderSearchOrder()
      Specifies a preference for ordering the result set by the order.
      Returns:
      the order search order
      Throws:
      UnimplementedException - supportsOrderSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOrderSearchOrder()} is {@code true} .

    • orderByDate

      void orderByDate(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the shipment date.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getShipmentSearchOrderRecord

      ShipmentSearchOrderRecord getShipmentSearchOrderRecord(Type shipmentRecordType) throws OperationFailedException
      Gets the shipment search order record corresponding to the given shipment record Type . Multiple retrievals return the same underlying object.
      Parameters:
      shipmentRecordType - a shipment record type
      Returns:
      the shipment search order record
      Throws:
      NullArgumentException - shipmentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(shipmentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.