All Superinterfaces:: Extensible, OsidAggregateableQuery, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface ShipmentQuery extends OsidObjectQuery, OsidAggregateableQuery

This is the query for searching shipments. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type

Method

Description

void

clearDateTerms()

Clears the shipment date.

void

clearEntryIdTerms()

Clears the entry Id terms.

void

clearEntryTerms()

Clears the entry terms.

void

clearOrderIdTerms()

Clears the order Id terms.

void

clearOrderTerms()

Clears the order terms.

void

clearSourceIdTerms()

Clears the resource Id terms.

void

clearSourceTerms()

Clears the source terms.

void

clearWarehouseIdTerms()

Clears the warehouse Id terms.

void

clearWarehouseTerms()

Clears the warehouse terms.

EntryQuery

getEntryQuery()

Gets the query for an entry.

OrderQuery

getOrderQuery()

Gets the query for an order.

ShipmentQueryRecord

getShipmentQueryRecord(Type shipmentRecordType)

Gets the shipment query record corresponding to the given Shipment record Type .Multiple record retrievals produce a nested OR term.

ResourceQuery

getSourceQuery()

Gets the query for a source.

WarehouseQuery

getWarehouseQuery()

Gets the query for a warehouse.

void

matchAnyDate(boolean match)

Matches shipments with any date.

void

matchAnyEntry(boolean match)

Matches shipments that have any entry.

void

matchAnyOrder(boolean match)

Matches shipments with any related order.

void

matchAnySource(boolean match)

Matches shipments with any source.

void

matchDate(DateTime from, DateTime to, boolean match)

Matches shipment dates within the given date range inclusive.

void

matchEntryId(Id entryId, boolean match)

Sets the entry Id for this query.

void

matchOrderId(Id orderId, boolean match)

Sets the order Id for this query.

void

matchSourceId(Id resourceId, boolean match)

Sets the resource Id for this query.

void

matchWarehouseId(Id warehouseId, boolean match)

Sets the warehouse Id for this query to match shipments assigned to warehouses.

boolean

supportsEntryQuery()

Tests if an EntryQuery is available.

boolean

supportsOrderQuery()

Tests if an OrderQuery is available.

boolean

supportsSourceQuery()

Tests if a ResourceQuery is available.

boolean

supportsWarehouseQuery()

Tests if a WarehouseQuery is available.

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Modifier and Type

Method

Description

TypeList

getRecordTypes()

Gets the record types available in this object.

boolean

hasRecordType(Type recordType)

Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery
clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type

Method

Description

void

clearRecordTerms()

Clears all record Type terms.

void

matchAnyRecord(boolean match)

Matches an object that has any record.

void

matchRecordType(Type recordType, boolean match)

Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery
clearIdTerms, matchId

Modifier and Type

Method

Description

void

clearIdTerms()

Clears all Id terms.

void

matchId(Id id, boolean match)

Adds an Id to match.

Methods inherited from interface OsidObjectQuery
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Modifier and Type

Method

Description

void

clearCommentIdTerms()

Clears all comment Id terms.

void

clearCommentTerms()

Clears all comment terms.

void

clearCreditIdTerms()

Clears all credit Id terms.

void

clearCreditTerms()

Clears all credit terms.

void

clearDescriptionTerms()

Clears all description terms.

void

clearDisplayNameTerms()

Clears all display name terms.

void

clearGenusTypeTerms()

Clears all genus type terms.

void

clearJournalEntryIdTerms()

Clears all journal entry Id terms.

void

clearJournalEntryTerms()

Clears all journal entry terms.

void

clearParentGenusTypeTerms()

Clears all genus type terms.

void

clearRelationshipIdTerms()

Clears all relationship Id terms.

void

clearRelationshipPeerIdTerms()

Clears all relationship Id terms.

void

clearRelationshipTerms()

Clears all relationship terms.

void

clearStateIdTerms()

Clears all state Id terms.

void

clearStateTerms()

Clears all state terms.

void

clearStatisticTerms()

Clears all statistic terms.

void

clearSubjectIdTerms()

Clears all subject Id terms.

void

clearSubjectRelevancyTerms()

Clears all subject relevancy terms.

void

clearSubjectTerms()

Clears all subject terms.

CommentQuery

getCommentQuery()

Gets the query for a comment.

CreditQuery

getCreditQuery()

Gets the query for an ackowledgement credit.

JournalEntryQuery

getJournalEntryQuery()

Gets the query for a journal entry.

RelationshipQuery

getRelationshipQuery()

Gets the query for relationship.

StateQuery

getStateQuery()

Gets the query for a state.

StatisticQuery

getStatisticQuery()

Gets the query for a statistic.

SubjectQuery

getSubjectQuery()

Gets the query for a subject.

RelevancyQuery

getSubjectRelevancyQuery()

Gets the query for a subject relevancy.

void

matchAnyComment(boolean match)

Matches an object that has any Comment in the given Book .

void

matchAnyCredit(boolean match)

Matches an object that has any Credit .

void

matchAnyDescription(boolean match)

Matches a description that has any value.

void

matchAnyDisplayName(boolean match)

Matches any object with a display name.

void

matchAnyGenusType(boolean match)

Matches an object that has any genus type.

void

matchAnyJournalEntry(boolean match)

Matches an object that has any JournalEntry in the given Journal .

void

matchAnyRelationship(boolean match)

Matches an object that has any Relationship .

void

matchAnyState(boolean match)

Matches an object that has any mapping to a State in the given Process .

void

matchAnyStatistic(boolean match)

Matches an object that has any Statistic .

void

matchAnySubject(boolean match)

Matches an object that has any relationship to a Subject .

void

matchCommentId(Id commentId, boolean match)

Matches an object that has the given comment.

void

matchCreditId(Id creditId, boolean match)

Matches an object that has the given credit.

void

matchDescription(String description, Type stringMatchType, boolean match)

Adds a description name to match.

void

matchDisplayName(String displayName, Type stringMatchType, boolean match)

Adds a display name to match.

void

matchGenusType(Type genusType, boolean match)

Sets a Type for querying objects of a given genus.

void

matchJournalEntryId(Id journalEntryId, boolean match)

Matches an object that has the given journal entry.

void

matchParentGenusType(Type genusType, boolean match)

Sets a Type for querying objects of a given genus.

void

matchRelationshipId(Id relationshipId, boolean match)

Matches an object that has the given relationship.

void

matchRelationshipPeerId(Id peerId, boolean match)

Matches an object that has a relationship to the given peer Id .

void

matchStateId(Id stateId, boolean match)

Matches an object mapped to the given state.

void

matchSubjectId(Id subjectId, boolean match)

Matches an object with a relationship to the given subject.

boolean

supportsCommentQuery()

Tests if a CommentQuery is available.

boolean

supportsCreditQuery()

Tests if a CreditQuery is available to provide queries of related acknowledgements.

boolean

supportsJournalEntryQuery()

Tests if a JournalEntry is available to provide queries of journaled OsidObjects .

boolean

supportsRelationshipQuery()

Tests if a RelationshipQuery is available.

boolean

supportsStateQuery()

Tests if a StateQuery is available to provide queries of processed objects.

boolean

supportsStatisticQuery()

Tests if a StatisticQuery is available to provide statistical queries.

boolean

supportsSubjectQuery()

Tests if a SubjectQuery is available.

boolean

supportsSubjectRelevancyQuery()

Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type

Method

Description

void

clearAnyTerms()

Clears the match any terms.

void

clearKeywordTerms()

Clears all keyword terms.

TypeList

getStringMatchTypes()

Gets the string matching types supported.

void

matchAny(boolean match)

Matches any object.

void

matchKeyword(String keyword, Type stringMatchType, boolean match)

Adds a keyword to match.

boolean

supportsStringMatchType(Type stringMatchType)

Tests if the given string matching type is supported.

Method Details
- matchSourceId
  
  void matchSourceId(Id resourceId, boolean match)
  
  Sets the resource Id for this query.
  
  Parameters:
  
  resourceId - a resource Id
  
  match - true if a positive match, false for a negative match
  
  Throws:
  
  NullArgumentException - resourceId is null
  
  Compliance:
  mandatory - This method must be implemented.
- clearSourceIdTerms
  
  void clearSourceIdTerms()
  
  Clears the resource Id terms.
  
  Compliance:
  mandatory - This method must be implemented.
- supportsSourceQuery
  
  boolean supportsSourceQuery()
  
  Tests if a ResourceQuery is available.
  
  Returns:
  
  true if a resource query is available, false otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getSourceQuery
  
  ResourceQuery getSourceQuery()
  
  Gets the query for a source. Multiple retrievals produce a nested OR term.
  
  Returns:
  
  a resource query
  
  Throws:
  
  UnimplementedException - supportsSourceQuery() is false
  
  Compliance:
  optional - This method must be implemented if {@code supportsSourceQuery()} is {@code true} .
- matchAnySource
  
  void matchAnySource(boolean match)
  
  Matches shipments with any source.
  
  Parameters:
  
  match - true to match shipments with any source, false to match shipments with no source
  
  Compliance:
  mandatory - This method must be implemented.
- clearSourceTerms
  
  void clearSourceTerms()
  
  Clears the source terms.
  
  Compliance:
  mandatory - This method must be implemented.
- matchOrderId
  
  void matchOrderId(Id orderId, boolean match)
  
  Sets the order Id for this query.
  
  Parameters:
  
  orderId - an order Id
  
  match - true if a positive match, false for a negative match
  
  Throws:
  
  NullArgumentException - orderId is null
  
  Compliance:
  mandatory - This method must be implemented.
- clearOrderIdTerms
  
  void clearOrderIdTerms()
  
  Clears the order Id terms.
  
  Compliance:
  mandatory - This method must be implemented.
- supportsOrderQuery
  
  boolean supportsOrderQuery()
  
  Tests if an OrderQuery is available.
  
  Returns:
  
  true if an order query is available, false otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getOrderQuery
  
  OrderQuery getOrderQuery()
  
  Gets the query for an order. Multiple retrievals produce a nested OR term.
  
  Returns:
  
  an odrer query
  
  Throws:
  
  UnimplementedException - supportsOrderQuery() is false
  
  Compliance:
  optional - This method must be implemented if {@code supportsOrderQuery()} is {@code true} .
- matchAnyOrder
  
  void matchAnyOrder(boolean match)
  
  Matches shipments with any related order.
  
  Parameters:
  
  match - true to match shipments with any related order, false to match shipments with no order
  
  Compliance:
  mandatory - This method must be implemented.
- clearOrderTerms
  
  void clearOrderTerms()
  
  Clears the order terms.
  
  Compliance:
  mandatory - This method must be implemented.
- matchDate
  
  void matchDate(DateTime from, DateTime to, boolean match)
  
  Matches shipment dates within the given date range inclusive.
  
  Parameters:
  
  from - start of range
  
  to - end of range
  
  match - true for a positive match, false for a negative match
  
  Throws:
  
  InvalidArgumentException - from is greater than to
  
  NullArgumentException - from or to is null
  
  Compliance:
  mandatory - This method must be implemented.
- matchAnyDate
  
  void matchAnyDate(boolean match)
  
  Matches shipments with any date.
  
  Parameters:
  
  match - true to match shipments with any date, false to match shipments with no date
  
  Compliance:
  mandatory - This method must be implemented.
- clearDateTerms
  
  void clearDateTerms()
  
  Clears the shipment date.
  
  Compliance:
  mandatory - This method must be implemented.
- matchEntryId
  
  void matchEntryId(Id entryId, boolean match)
  
  Sets the entry Id for this query.
  
  Parameters:
  
  entryId - an entry Id
  
  match - true if a positive match, false for a negative match
  
  Throws:
  
  NullArgumentException - entryId is null
  
  Compliance:
  mandatory - This method must be implemented.
- clearEntryIdTerms
  
  void clearEntryIdTerms()
  
  Clears the entry Id terms.
  
  Compliance:
  mandatory - This method must be implemented.
- supportsEntryQuery
  
  boolean supportsEntryQuery()
  
  Tests if an EntryQuery is available.
  
  Returns:
  
  true if an entry query is available, false otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getEntryQuery
  
  EntryQuery getEntryQuery()
  
  Gets the query for an entry. Multiple retrievals produce a nested OR term.
  
  Returns:
  
  an entry query
  
  Throws:
  
  UnimplementedException - supportsEntryQuery() is false
  
  Compliance:
  optional - This method must be implemented if {@code supportsEntryQuery()} is {@code true} .
- matchAnyEntry
  
  void matchAnyEntry(boolean match)
  
  Matches shipments that have any entry.
  
  Parameters:
  
  match - true to match shipments with any entry, false to match shipments with no entries
  
  Compliance:
  mandatory - This method must be implemented.
- clearEntryTerms
  
  void clearEntryTerms()
  
  Clears the entry terms.
  
  Compliance:
  mandatory - This method must be implemented.
- matchWarehouseId
  
  void matchWarehouseId(Id warehouseId, boolean match)
  
  Sets the warehouse Id for this query to match shipments assigned to warehouses.
  
  Parameters:
  
  warehouseId - the warehouse Id
  
  match - true for a positive match, false for a negative match
  
  Throws:
  
  NullArgumentException - warehouseId is null
  
  Compliance:
  mandatory - This method must be implemented.
- clearWarehouseIdTerms
  
  void clearWarehouseIdTerms()
  
  Clears the warehouse Id terms.
  
  Compliance:
  mandatory - This method must be implemented.
- supportsWarehouseQuery
  
  boolean supportsWarehouseQuery()
  
  Tests if a WarehouseQuery is available.
  
  Returns:
  
  true if a warehouse query is available, false otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getWarehouseQuery
  
  WarehouseQuery getWarehouseQuery()
  
  Gets the query for a warehouse. Multiple retrievals produce a nested OR term.
  
  Returns:
  
  the warehouse query
  
  Throws:
  
  UnimplementedException - supportsWarehouseQuery() is false
  
  Compliance:
  optional - This method must be implemented if {@code supportsWarehouseQuery()} is {@code true} .
- clearWarehouseTerms
  
  void clearWarehouseTerms()
  
  Clears the warehouse terms.
  
  Compliance:
  mandatory - This method must be implemented.
- getShipmentQueryRecord
  
  ShipmentQueryRecord getShipmentQueryRecord(Type shipmentRecordType) throws OperationFailedException
  
  Gets the shipment query 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 record
  
  Throws:
  
  NullArgumentException - shipmentRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(shipmentRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.

Interface ShipmentQuery

Method Summary

Methods inherited from interface Extensible

Methods inherited from interface OsidExtensibleQuery

Methods inherited from interface OsidIdentifiableQuery

Methods inherited from interface OsidObjectQuery

Methods inherited from interface OsidQuery

Method Details

matchSourceId

clearSourceIdTerms

supportsSourceQuery

getSourceQuery

matchAnySource

clearSourceTerms

matchOrderId

clearOrderIdTerms

supportsOrderQuery

getOrderQuery

matchAnyOrder

clearOrderTerms

matchDate

matchAnyDate

clearDateTerms

matchEntryId

clearEntryIdTerms

supportsEntryQuery

getEntryQuery

matchAnyEntry

clearEntryTerms

matchWarehouseId

clearWarehouseIdTerms

supportsWarehouseQuery

getWarehouseQuery

clearWarehouseTerms

getShipmentQueryRecord