public interface InventoryQuery extends OsidObjectQuery, OsidSubjugateableQuery
This is the query for searching inventories. 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 |
clearDateInclusiveTerms()
Clears the date inclusive terms.
|
void |
clearDateTerms()
Clears the meeting time terms.
|
void |
clearQuantityTerms()
Clears the quantity terms.
|
void |
clearStockIdTerms()
Clears the stock
Id terms. |
void |
clearStockTerms()
Clears the stock terms.
|
void |
clearWarehouseIdTerms()
Clears the warehouse
Id query terms. |
void |
clearWarehouseTerms()
Clears the warehouse terms.
|
InventoryQueryRecord |
getInventoryQueryRecord(Type inventoryRecordType)
Gets the inventory query record corresponding to the given
Inventory record Type. |
StockQuery |
getStockQuery()
Gets the query for a stocjk.
|
WarehouseQuery |
getWarehouseQuery()
Gets the query for a warehouse.
|
void |
matchDate(DateTime date,
boolean match)
Matches inventories where the given time falls within a denormalized
inventory date inclusive.
|
void |
matchDateInclusive(DateTime start,
DateTime end,
boolean match)
Matches inventories with any denormalized date within the given date
range inclusive.
|
void |
matchQuantity(java.math.BigDecimal start,
java.math.BigDecimal end,
boolean match)
Matches inventories with a quantity within the given range inclusive.
|
void |
matchStockId(Id stockId,
boolean match)
Sets the stock
Id for this query. |
void |
matchWarehouseId(Id warehouseId,
boolean match)
Sets the warehouse
Id for this query to match
inventories assigned to warehouses. |
boolean |
supportsStockQuery()
Tests if a
StockQuery 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 matchStockId(Id stockId, boolean match)
Id
for this query.stockId
- the stock Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stockId
is
null
mandatory
- This method must be implemented. void clearStockIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsStockQuery()
StockQuery
is available. true
if a stock query is available,
false
otherwisemandatory
- This method must be implemented. StockQuery getStockQuery()
OR
term.UnimplementedException
- supportsStockQuery()
is false
optional
- This method must be implemented if
supportsStockQuery()
is true.
void clearStockTerms()
mandatory
- This method must be implemented. void matchDate(DateTime date, boolean match)
date
- a datematch
- true
if a positive match, false
for a negative matchNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDateTerms()
mandatory
- This method must be implemented. void matchDateInclusive(DateTime start, DateTime end, boolean match)
start
- a start dateend
- an end datematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- start
is
greater than end
NullArgumentException
- start
or
end
is null
mandatory
- This method must be implemented. void clearDateInclusiveTerms()
mandatory
- This method must be implemented. void matchQuantity(java.math.BigDecimal start, java.math.BigDecimal end, boolean match)
start
- start rangeend
- end rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- start
is
greater than end
mandatory
- This method must be implemented. void clearQuantityTerms()
mandatory
- This method must be implemented. void matchWarehouseId(Id warehouseId, boolean match)
Id
for this query to match
inventories 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
query 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. InventoryQueryRecord getInventoryQueryRecord(Type inventoryRecordType) throws OperationFailedException
Inventory
record Type.
Multiple record
retrievals produce a nested OR
term.inventoryRecordType
- an inventory record typeNullArgumentException
- inventoryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inventoryRecordType)
is false
mandatory
- This method must be implemented.