Interface OrderQuery

All Superinterfaces:

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

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 .

Method Summary

Modifier and Type	Method	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 .Multiple record retrievals produce a nested OR term.
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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchCustomerId

void matchCustomerId(Id customerId,
 boolean match)

Sets the item Id for this query to match orders by customers.

Parameters:

customerId - a customer Id

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

Throws:

NullArgumentException - itemId is null

Compliance:

mandatory - This method must be implemented.

clearCustomerIdTerms

void clearCustomerIdTerms()

Clears the customer Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCustomerQuery

boolean supportsCustomerQuery()

Tests if a CustomerQuery is available.

Returns:

true if a customer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCustomerQuery

ResourceQuery getCustomerQuery()

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

Returns:

the customer query

Throws:

UnimplementedException - supportsCustomerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCustomerQuery()} is {@code true} .

clearCustomerTerms

void clearCustomerTerms()

Clears the customer terms.

Compliance:

mandatory - This method must be implemented.

matchItemId

void matchItemId(Id itemId,
 boolean match)

Sets the item Id for this query to match orders assigned to items.

Parameters:

itemId - an item Id

match - true for 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 query. Multiple retrievals produce a nested OR term.

Returns:

the item query

Throws:

UnimplementedException - supportsItemQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsItemQuery()} is {@code true} .

matchAnyItem

void matchAnyItem(boolean match)

Matches orders with any item.

Parameters:

match - true for a to matc h odrers with any items, false to match orders with no items

Compliance:

mandatory - This method must be implemented.

clearItemTerms

void clearItemTerms()

Clears the item terms.

Compliance:

mandatory - This method must be implemented.

matchTotalCost

void matchTotalCost(Currency low,
 Currency high,
 boolean match)

Matches total costs between the given range inclusive.

Parameters:

low - low range

high - high range

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

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

clearTotalCostTerms

void clearTotalCostTerms()

Clears the total cost terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumTotalCost

void matchMinimumTotalCost(Currency cost,
 boolean match)

Matches total costs greter than or equal to the given cost.

Parameters:

cost - a cost

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

Compliance:

mandatory - This method must be implemented.

clearMinimumTotalCostTerms

void clearMinimumTotalCostTerms()

Clears the minimum total cost terms.

Compliance:

mandatory - This method must be implemented.

matchAtomic

void matchAtomic(boolean match)

Matches atomic orders.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAtomicTerms

void clearAtomicTerms()

Clears the atomic terms.

Compliance:

mandatory - This method must be implemented.

matchSubmitDate

void matchSubmitDate(DateTime from,
 DateTime to,
 boolean match)

Matches orders submitted between the given time range inclusive.

Parameters:

from - starting time range

to - ending time range

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - itemId is null

Compliance:

mandatory - This method must be implemented.

clearSubmitDateTerms

void clearSubmitDateTerms()

Clears the submit date terms.

Compliance:

mandatory - This method must be implemented.

matchSubmitterId

void matchSubmitterId(Id resourceId,
 boolean match)

Sets a submitting resource Id .

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearSubmitterIdTerms

void clearSubmitterIdTerms()

Clears the submitter Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSubmitterQuery

boolean supportsSubmitterQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubmitterQuery

ResourceQuery getSubmitterQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsSubmitterQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSubmitterQuery()} is {@code true} .

matchAnySubmitter

void matchAnySubmitter(boolean match)

Matches any submitted order.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearSubmitterTerms

void clearSubmitterTerms()

Clears the submitter terms.

Compliance:

mandatory - This method must be implemented.

matchSubmittingAgentId

void matchSubmittingAgentId(Id agentId,
 boolean match)

Sets a submitting agent Id .

Parameters:

agentId - an agent Id

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearSubmittingAgentIdTerms

void clearSubmittingAgentIdTerms()

Clears the submitter Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSubmittingAgentQuery

boolean supportsSubmittingAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubmittingAgentQuery

AgentQuery getSubmittingAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsSubmittingAgentQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSubmittingAgentQuery()} is {@code true} .

matchAnySubmittingAgent

void matchAnySubmittingAgent(boolean match)

Matches any submitted order.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearSubmittingAgentTerms

void clearSubmittingAgentTerms()

Clears the submitter terms.

Compliance:

mandatory - This method must be implemented.

matchClosedDate

void matchClosedDate(DateTime from,
 DateTime to,
 boolean match)

Matches orders closed between the given time range inclusive.

Parameters:

from - starting time range

to - ending time range

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - itemId is null

Compliance:

mandatory - This method must be implemented.

clearClosedDateTerms

void clearClosedDateTerms()

Clears the closed date terms.

Compliance:

mandatory - This method must be implemented.

matchCloserId

void matchCloserId(Id resourceId,
 boolean match)

Sets a closer resource Id .

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearCloserIdTerms

void clearCloserIdTerms()

Clears the closer Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCloserQuery

boolean supportsCloserQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCloserQuery

ResourceQuery getCloserQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsCloserQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCloserQuery()} is {@code true} .

matchAnyCloser

void matchAnyCloser(boolean match)

Matches any closed order.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearCloserTerms

void clearCloserTerms()

Clears the closer terms.

Compliance:

mandatory - This method must be implemented.

matchClosingAgentId

void matchClosingAgentId(Id agentId,
 boolean match)

Sets a closing agent Id .

Parameters:

agentId - an agent Id

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearClosingAgentIdTerms

void clearClosingAgentIdTerms()

Clears the closer Id terms.

Compliance:

mandatory - This method must be implemented.

supportsClosingAgentQuery

boolean supportsClosingAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getClosingAgentQuery

AgentQuery getClosingAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsClosingAgentQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsClosingAgentQuery()} is {@code true} .

matchAnyClosingAgent

void matchAnyClosingAgent(boolean match)

Matches any closed order.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearClosingAgentTerms

void clearClosingAgentTerms()

Clears the closer terms.

Compliance:

mandatory - This method must be implemented.

matchStoreId

void matchStoreId(Id storeId,
 boolean match)

Sets the item Id for this query to match orders assigned to stores.

Parameters:

storeId - a store Id

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

Throws:

NullArgumentException - storeId is null

Compliance:

mandatory - This method must be implemented.

clearStoreIdTerms

void clearStoreIdTerms()

Clears the store Id terms.

Compliance:

mandatory - This method must be implemented.

supportsStoreQuery

boolean supportsStoreQuery()

Tests if a StoreQuery is available.

Returns:

true if a store query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStoreQuery

StoreQuery getStoreQuery()

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

Returns:

the store query

Throws:

UnimplementedException - supportsStoreQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsStoreQuery()} is {@code true} .

clearStoreTerms

void clearStoreTerms()

Clears the store terms.

Compliance:

mandatory - This method must be implemented.

getOrderQueryRecord

OrderQueryRecord getOrderQueryRecord(Type orderRecordType)
                              throws OperationFailedException

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

Parameters:

orderRecordType - an order record type

Returns:

the order query record

Throws:

NullArgumentException - orderRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(orderRecordType) is false

Compliance:

mandatory - This method must be implemented.