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.
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. |
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
- a stock Id
match
- true
if 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 matchModelId(Id modelId, boolean match)
Id
for this query.modelId
- a model Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- modelId
is
null
mandatory
- This method must be implemented. void clearModelIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsModelQuery()
ModelQuery
is available. true
if a model query is available,
false
otherwisemandatory
- This method must be implemented. ModelQuery getModelQuery()
OR
term.UnimplementedException
- supportsModelQuery()
is false
optional
- This method must be implemented if
supportsModelQuery()
is true.
void matchAnyModel(boolean match)
match
- true
to match entries with any model,
false
to match entries with no modelmandatory
- This method must be implemented. void clearModelTerms()
mandatory
- This method must be implemented. void matchItemId(Id itemId, boolean match)
Id
for this query.itemId
- an item Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- itemId
is
null
mandatory
- This method must be implemented. void clearItemIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsItemQuery()
ItemQuery
is available. true
if an item query is available,
false
otherwisemandatory
- This method must be implemented. ItemQuery getItemQuery()
OR
term.UnimplementedException
- supportsItemQuery()
is false
optional
- This method must be implemented if
supportsItemQuery()
is true.
void matchAnyItem(boolean match)
match
- true
to match entries with any item,
false
to match entries with no itemmandatory
- This method must be implemented. void clearItemTerms()
mandatory
- This method must be implemented. void matchQuantity(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- start of rangehigh
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void matchAnyQuantity(boolean match)
match
- true
to match entries with any quantity,
false
to match entries with no quantitymandatory
- This method must be implemented. void clearQuantityTerms()
mandatory
- This method must be implemented. void matchUnitType(Type type, boolean match)
type
- a unit tytpematch
- true
for a positive match, false
for a negative matchNullArgumentException
- type
is
null
mandatory
- This method must be implemented. void matchAnyUnitType(boolean match)
match
- true
to match entries with any unit type,
false
to match entries with no unit typemandatory
- This method must be implemented. void clearUnitTypeTerms()
mandatory
- This method must be implemented. void matchWarehouseId(Id warehouseId, boolean match)
Id
for this query to match entries
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. EntryQueryRecord getEntryQueryRecord(Type entryRecordType) throws OperationFailedException
Entry
record Type.
Multiple record retrievals produce
a nested OR
term.entryRecordType
- an entry record typeNullArgumentException
- entryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(entryRecordType)
is false
mandatory
- This method must be implemented.