public interface OrderQuery extends OsidObjectQuery, OsidAggregateableQuery
This is the query for searching orders. Each method specifies an
AND
term while multiple invocations of the same method produce a
nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAtomicTerms()
Clears the atomic terms.
|
void |
clearClosedDateTerms()
Clears the closed date terms.
|
void |
clearCloserIdTerms()
Clears the closer
Id terms. |
void |
clearCloserTerms()
Clears the closer terms.
|
void |
clearClosingAgentIdTerms()
Clears the closer
Id terms. |
void |
clearClosingAgentTerms()
Clears the closer terms.
|
void |
clearCustomerIdTerms()
Clears the customer
Id terms. |
void |
clearCustomerTerms()
Clears the customer terms.
|
void |
clearItemIdTerms()
Clears the item
Id terms. |
void |
clearItemTerms()
Clears the item terms.
|
void |
clearMinimumTotalCostTerms()
Clears the minimum total cost terms.
|
void |
clearStoreIdTerms()
Clears the store
Id terms. |
void |
clearStoreTerms()
Clears the store terms.
|
void |
clearSubmitDateTerms()
Clears the submit date terms.
|
void |
clearSubmitterIdTerms()
Clears the submitter
Id terms. |
void |
clearSubmitterTerms()
Clears the submitter terms.
|
void |
clearSubmittingAgentIdTerms()
Clears the submitter
Id terms. |
void |
clearSubmittingAgentTerms()
Clears the submitter terms.
|
void |
clearTotalCostTerms()
Clears the total cost terms.
|
ResourceQuery |
getCloserQuery()
Gets the query for a closer resource query.
|
AgentQuery |
getClosingAgentQuery()
Gets the query for a closing agent query.
|
ResourceQuery |
getCustomerQuery()
Gets the query for a customer query.
|
ItemQuery |
getItemQuery()
Gets the query for an item query.
|
OrderQueryRecord |
getOrderQueryRecord(Type orderRecordType)
Gets the order query record corresponding to the given
Order
record Type. |
StoreQuery |
getStoreQuery()
Gets the query for a store query.
|
ResourceQuery |
getSubmitterQuery()
Gets the query for a submitting agent query.
|
AgentQuery |
getSubmittingAgentQuery()
Gets the query for a submitting agent query.
|
void |
matchAnyCloser(boolean match)
Matches any closed order.
|
void |
matchAnyClosingAgent(boolean match)
Matches any closed order.
|
void |
matchAnyItem(boolean match)
Matches orders with any item.
|
void |
matchAnySubmitter(boolean match)
Matches any submitted order.
|
void |
matchAnySubmittingAgent(boolean match)
Matches any submitted order.
|
void |
matchAtomic(boolean match)
Matches atomic orders.
|
void |
matchClosedDate(DateTime from,
DateTime to,
boolean match)
Matches orders closed between the given time range inclusive.
|
void |
matchCloserId(Id resourceId,
boolean match)
Sets a closer resource
Id. |
void |
matchClosingAgentId(Id agentId,
boolean match)
Sets a closing agent
Id. |
void |
matchCustomerId(Id customerId,
boolean match)
Sets the item
Id for this query to match orders by
customers. |
void |
matchItemId(Id itemId,
boolean match)
Sets the item
Id for this query to match orders
assigned to items. |
void |
matchMinimumTotalCost(Currency cost,
boolean match)
Matches total costs greter than or equal to the given cost.
|
void |
matchStoreId(Id storeId,
boolean match)
Sets the item
Id for this query to match orders
assigned to stores. |
void |
matchSubmitDate(DateTime from,
DateTime to,
boolean match)
Matches orders submitted between the given time range inclusive.
|
void |
matchSubmitterId(Id resourceId,
boolean match)
Sets a submitting resource
Id. |
void |
matchSubmittingAgentId(Id agentId,
boolean match)
Sets a submitting agent
Id. |
void |
matchTotalCost(Currency low,
Currency high,
boolean match)
Matches total costs between the given range inclusive.
|
boolean |
supportsCloserQuery()
Tests if a
ResourceQuery is available. |
boolean |
supportsClosingAgentQuery()
Tests if an
AgentQuery is available. |
boolean |
supportsCustomerQuery()
Tests if a
CustomerQuery is available. |
boolean |
supportsItemQuery()
Tests if an
ItemQuery is available. |
boolean |
supportsStoreQuery()
Tests if a
StoreQuery is available. |
boolean |
supportsSubmitterQuery()
Tests if a
ResourceQuery is available. |
boolean |
supportsSubmittingAgentQuery()
Tests if an
AgentQuery 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 matchCustomerId(Id customerId, boolean match)
Id
for this query to match orders by
customers.customerId
- a customer Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- itemId
is
null
mandatory
- This method must be implemented. void clearCustomerIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCustomerQuery()
CustomerQuery
is available. true
if a customer query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getCustomerQuery()
OR
term.UnimplementedException
- supportsCustomerQuery()
is false
optional
- This method must be implemented if
supportsCustomerQuery()
is true.
void clearCustomerTerms()
mandatory
- This method must be implemented. void matchItemId(Id itemId, boolean match)
Id
for this query to match orders
assigned to items.itemId
- an item Id
match
- true
for 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
for a to matc h odrers with any
items, false
to match orders with no itemsmandatory
- This method must be implemented. void clearItemTerms()
mandatory
- This method must be implemented. void matchTotalCost(Currency low, Currency high, boolean match)
low
- low rangehigh
- high rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void clearTotalCostTerms()
mandatory
- This method must be implemented. void matchMinimumTotalCost(Currency cost, boolean match)
cost
- a costmatch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumTotalCostTerms()
mandatory
- This method must be implemented. void matchAtomic(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearAtomicTerms()
mandatory
- This method must be implemented. void matchSubmitDate(DateTime from, DateTime to, boolean match)
from
- starting time rangeto
- ending time rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- itemId
is
null
mandatory
- This method must be implemented. void clearSubmitDateTerms()
mandatory
- This method must be implemented. void matchSubmitterId(Id resourceId, boolean match)
Id.
resourceId
- a resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearSubmitterIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSubmitterQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getSubmitterQuery()
OR
term.UnimplementedException
-
supportsSubmitterQuery()
is false
optional
- This method must be implemented if
supportsSubmitterQuery()
is true.
void matchAnySubmitter(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearSubmitterTerms()
mandatory
- This method must be implemented. void matchSubmittingAgentId(Id agentId, boolean match)
Id.
agentId
- an agent Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- agentId
is
null
mandatory
- This method must be implemented. void clearSubmittingAgentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSubmittingAgentQuery()
AgentQuery
is available. true
if an agent query is available,
false
otherwisemandatory
- This method must be implemented. AgentQuery getSubmittingAgentQuery()
OR
term.UnimplementedException
-
supportsSubmittingAgentQuery()
is false
optional
- This method must be implemented if
supportsSubmittingAgentQuery()
is true.
void matchAnySubmittingAgent(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearSubmittingAgentTerms()
mandatory
- This method must be implemented. void matchClosedDate(DateTime from, DateTime to, boolean match)
from
- starting time rangeto
- ending time rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- itemId
is
null
mandatory
- This method must be implemented. void clearClosedDateTerms()
mandatory
- This method must be implemented. void matchCloserId(Id resourceId, boolean match)
Id.
resourceId
- a resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearCloserIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCloserQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getCloserQuery()
OR
term.UnimplementedException
- supportsCloserQuery()
is false
optional
- This method must be implemented if
supportsCloserQuery()
is true.
void matchAnyCloser(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearCloserTerms()
mandatory
- This method must be implemented. void matchClosingAgentId(Id agentId, boolean match)
Id.
agentId
- an agent Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- agentId
is
null
mandatory
- This method must be implemented. void clearClosingAgentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsClosingAgentQuery()
AgentQuery
is available. true
if an agent query is available,
false
otherwisemandatory
- This method must be implemented. AgentQuery getClosingAgentQuery()
OR
term.UnimplementedException
-
supportsClosingAgentQuery()
is false
optional
- This method must be implemented if
supportsClosingAgentQuery()
is true.
void matchAnyClosingAgent(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearClosingAgentTerms()
mandatory
- This method must be implemented. void matchStoreId(Id storeId, boolean match)
Id
for this query to match orders
assigned to stores.storeId
- a store Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- storeId
is
null
mandatory
- This method must be implemented. void clearStoreIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsStoreQuery()
StoreQuery
is available. true
if a store query is available,
false
otherwisemandatory
- This method must be implemented. StoreQuery getStoreQuery()
OR
term.UnimplementedException
- supportsStoreQuery()
is false
optional
- This method must be implemented if
supportsStoreQuery()
is true.
void clearStoreTerms()
mandatory
- This method must be implemented. OrderQueryRecord getOrderQueryRecord(Type orderRecordType) throws OperationFailedException
Order
record Type.
Multiple record retrievals produce
a nested OR
term.orderRecordType
- a order record typeNullArgumentException
- orderRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(orderRecordType)
is false
mandatory
- This method must be implemented.