org.osid.inventory.shipment

Interface EntryQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

public interface EntryQuery
extends OsidObjectQuery, OsidSubjugateableQuery

This is the query for searching entries. 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	clearItemIdTerms() Clears the item Id terms.
void	clearItemTerms() Clears the item terms.
void	clearModelIdTerms() Clears the model Id terms.
void	clearModelTerms() Clears the model terms.
void	clearQuantityTerms() Clears the quantity terms.
void	clearStockIdTerms() Clears the stock Id terms.
void	clearStockTerms() Clears the stock terms.
void	clearUnitTypeTerms() Clears the unit type terms.
void	clearWarehouseIdTerms() Clears the warehouse Id terms.
void	clearWarehouseTerms() Clears the warehouse terms.
EntryQueryRecord	getEntryQueryRecord(Type entryRecordType) Gets the entry query record corresponding to the given Entry record Type.
ItemQuery	getItemQuery() Gets the query for an item.
ModelQuery	getModelQuery() Gets the query for a model.
StockQuery	getStockQuery() Gets the query for a stock.
WarehouseQuery	getWarehouseQuery() Gets the query for a warehouse.
void	matchAnyItem(boolean match) Matches entries that have any item set.
void	matchAnyModel(boolean match) Matches entries that have any model set.
void	matchAnyQuantity(boolean match) Matches entries that have any quantity set.
void	matchAnyUnitType(boolean match) Matches entries that have any unit type set.
void	matchItemId(Id itemId, boolean match) Sets the item Id for this query.
void	matchModelId(Id modelId, boolean match) Sets the model Id for this query.
void	matchQuantity(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches entries with a quantity between the given range inclusive.
void	matchStockId(Id stockId, boolean match) Sets the stock Id for this query.
void	matchUnitType(Type type, boolean match) Matches the a unit type.
void	matchWarehouseId(Id warehouseId, boolean match) Sets the warehouse Id for this query to match entries assigned to warehouses.
boolean	supportsItemQuery() Tests if an ItemQuery is available.
boolean	supportsModelQuery() Tests if a ModelQuery is available.
boolean	supportsStockQuery() Tests if a StockQuery 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

matchStockId

void matchStockId(Id stockId,
                boolean match)

Sets the stock Id for this query.

Parameters:

stockId - a stock Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - stockId is null

Compliance:

mandatory - This method must be implemented.

clearStockIdTerms

void clearStockIdTerms()

Clears the stock Id terms.

Compliance:

mandatory - This method must be implemented.

supportsStockQuery

boolean supportsStockQuery()

Tests if a StockQuery is available.

Returns:

true if a stock query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStockQuery

StockQuery getStockQuery()

Gets the query for a stock. Multiple retrievals produce a nested OR term.

Returns:

the stock query

Throws:

UnimplementedException - supportsStockQuery() is false

Compliance:

optional - This method must be implemented if supportsStockQuery() is true.

clearStockTerms

void clearStockTerms()

Clears the stock terms.

Compliance:

mandatory - This method must be implemented.

matchModelId

void matchModelId(Id modelId,
                boolean match)

Sets the model Id for this query.

Parameters:

modelId - a model Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - modelId is null

Compliance:

mandatory - This method must be implemented.

clearModelIdTerms

void clearModelIdTerms()

Clears the model Id terms.

Compliance:

mandatory - This method must be implemented.

supportsModelQuery

boolean supportsModelQuery()

Tests if a ModelQuery is available.

Returns:

true if a model query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getModelQuery

ModelQuery getModelQuery()

Gets the query for a model. Multiple retrievals produce a nested OR term.

Returns:

the model query

Throws:

UnimplementedException - supportsModelQuery() is false

Compliance:

optional - This method must be implemented if supportsModelQuery() is true.

matchAnyModel

void matchAnyModel(boolean match)

Matches entries that have any model set.

Parameters:

match - true to match entries with any model, false to match entries with no model

Compliance:

mandatory - This method must be implemented.

clearModelTerms

void clearModelTerms()

Clears the model terms.

Compliance:

mandatory - This method must be implemented.

matchItemId

void matchItemId(Id itemId,
               boolean match)

Sets the item Id for this query.

Parameters:

itemId - an item Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - itemId is null

Compliance:

mandatory - This method must be implemented.

clearItemIdTerms

void clearItemIdTerms()

Clears the item Id terms.

Compliance:

mandatory - This method must be implemented.

supportsItemQuery

boolean supportsItemQuery()

Tests if an ItemQuery is available.

Returns:

true if an item query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getItemQuery

ItemQuery getItemQuery()

Gets the query for an item. Multiple retrievals produce a nested OR term.

Returns:

the item query

Throws:

UnimplementedException - supportsItemQuery() is false

Compliance:

optional - This method must be implemented if supportsItemQuery() is true.

matchAnyItem

void matchAnyItem(boolean match)

Matches entries that have any item set.

Parameters:

match - true to match entries with any item, false to match entries with no item

Compliance:

mandatory - This method must be implemented.

clearItemTerms

void clearItemTerms()

Clears the item terms.

Compliance:

mandatory - This method must be implemented.

matchQuantity

void matchQuantity(java.math.BigDecimal low,
                 java.math.BigDecimal high,
                 boolean match)

Matches entries with a quantity between the given range inclusive.

Parameters:

low - start of range

high - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

matchAnyQuantity

void matchAnyQuantity(boolean match)

Matches entries that have any quantity set.

Parameters:

match - true to match entries with any quantity, false to match entries with no quantity

Compliance:

mandatory - This method must be implemented.

clearQuantityTerms

void clearQuantityTerms()

Clears the quantity terms.

Compliance:

mandatory - This method must be implemented.

matchUnitType

void matchUnitType(Type type,
                 boolean match)

Matches the a unit type.

Parameters:

type - a unit tytpe

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - type is null

Compliance:

mandatory - This method must be implemented.

matchAnyUnitType

void matchAnyUnitType(boolean match)

Matches entries that have any unit type set.

Parameters:

match - true to match entries with any unit type, false to match entries with no unit type

Compliance:

mandatory - This method must be implemented.

clearUnitTypeTerms

void clearUnitTypeTerms()

Clears the unit type terms.

Compliance:

mandatory - This method must be implemented.

matchWarehouseId

void matchWarehouseId(Id warehouseId,
                    boolean match)

Sets the warehouse Id for this query to match entries 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.

getEntryQueryRecord

EntryQueryRecord getEntryQueryRecord(Type entryRecordType)
                                     throws OperationFailedException

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

Parameters:

entryRecordType - an entry record type

Returns:

the entry query record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.