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.
Modifier and Type | Method and 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. |
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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchSourceId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearSourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getSourceQuery()
OR
term.UnimplementedException
- supportsSourceQuery()
is false
optional
- This method must be implemented if
supportsSourceQuery()
is true.
void matchAnySource(boolean match)
match
- true
to match shipments with any source,
false
to match shipments with no sourcemandatory
- This method must be implemented. void clearSourceTerms()
mandatory
- This method must be implemented. void matchOrderId(Id orderId, boolean match)
Id
for this query.orderId
- an order Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- orderId
is
null
mandatory
- This method must be implemented. void clearOrderIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsOrderQuery()
OrderQuery
is available. true
if an order query is available,
false
otherwisemandatory
- This method must be implemented. OrderQuery getOrderQuery()
OR
term.UnimplementedException
- supportsOrderQuery()
is false
optional
- This method must be implemented if
supportsOrderQuery()
is true.
void matchAnyOrder(boolean match)
match
- true
to match shipments with any related
order, false
to match shipments with no ordermandatory
- This method must be implemented. void clearOrderTerms()
mandatory
- This method must be implemented. void matchDate(DateTime from, DateTime to, boolean match)
from
- start of rangeto
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyDate(boolean match)
match
- true
to match shipments with any date,
false
to match shipments with no datemandatory
- This method must be implemented. void clearDateTerms()
mandatory
- This method must be implemented. void matchEntryId(Id entryId, boolean match)
Id
for this query.entryId
- an entry Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- entryId
is
null
mandatory
- This method must be implemented. void clearEntryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsEntryQuery()
EntryQuery
is available. true
if an entry query is available,
false
otherwisemandatory
- This method must be implemented. EntryQuery getEntryQuery()
OR
term.UnimplementedException
- supportsEntryQuery()
is false
optional
- This method must be implemented if
supportsEntryQuery()
is true.
void matchAnyEntry(boolean match)
match
- true
to match shipments with any entry,
false
to match shipments with no entriesmandatory
- This method must be implemented. void clearEntryTerms()
mandatory
- This method must be implemented. void matchWarehouseId(Id warehouseId, boolean match)
Id
for this query to match shipments
assigned to warehouses.warehouseId
- the warehouse Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- warehouseId
is
null
mandatory
- This method must be implemented. void clearWarehouseIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsWarehouseQuery()
WarehouseQuery
is available. true
if a warehouse query is available,
false
otherwisemandatory
- This method must be implemented. WarehouseQuery getWarehouseQuery()
OR
term.UnimplementedException
-
supportsWarehouseQuery()
is false
optional
- This method must be implemented if
supportsWarehouseQuery()
is true.
void clearWarehouseTerms()
mandatory
- This method must be implemented. ShipmentQueryRecord getShipmentQueryRecord(Type shipmentRecordType) throws OperationFailedException
Shipment
record Type.
Multiple record
retrievals produce a nested OR
term.shipmentRecordType
- a shipment record typeNullArgumentException
- shipmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(shipmentRecordType)
is false
mandatory
- This method must be implemented.