org.osid.inventory.shipment

Interface ShipmentQuery

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

Methods

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.

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

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 supportsSourceQuery() is 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 supportsOrderQuery() is 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 supportsEntryQuery() is 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 supportsWarehouseQuery() is 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.