Interface ShipmentQueryInspector

All Superinterfaces:
Extensible, OsidAggregateableQueryInspector, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
public interface ShipmentQueryInspector extends OsidObjectQueryInspector, OsidAggregateableQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

  • Method Details

    • getSourceIdTerms

      IdTerm[] getSourceIdTerms()
      Gets the resource Id query terms.
      Returns:
      the resource Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getSourceTerms

      ResourceQueryInspector[] getSourceTerms()
      Gets the resource query terms.
      Returns:
      the resource query terms
      Compliance:
      mandatory - This method must be implemented.

    • getOrderIdTerms

      IdTerm[] getOrderIdTerms()
      Gets the order Id query terms.
      Returns:
      the order Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getOrderTerms

      OrderQueryInspector[] getOrderTerms()
      Gets the order query terms.
      Returns:
      the order query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDateTerms

      DateTimeRangeTerm[] getDateTerms()
      Gets the date terms.
      Returns:
      the date terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntryIdTerms

      IdTerm[] getEntryIdTerms()
      Gets the entry Id query terms.
      Returns:
      the entry Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntryTerms

      EntryQueryInspector[] getEntryTerms()
      Gets the entry query terms.
      Returns:
      the entry query terms
      Compliance:
      mandatory - This method must be implemented.

    • getWarehouseIdTerms

      IdTerm[] getWarehouseIdTerms()
      Gets the warehouse Id query terms.
      Returns:
      the warehouse Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getWarehouseTerms

      WarehouseQueryInspector[] getWarehouseTerms()
      Gets the warehouse query terms.
      Returns:
      the warehouse query terms
      Compliance:
      mandatory - This method must be implemented.

    • getShipmentQueryInspectorRecord

      ShipmentQueryInspectorRecord getShipmentQueryInspectorRecord(Type shipmentRecordType) throws OperationFailedException
      Gets the shipment query inspector record corresponding to the given Shipment record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      shipmentRecordType - a shipment record type
      Returns:
      the shipment query inspector record
      Throws:
      NullArgumentException - shipmentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(shipmentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.