org.osid.ordering

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

Methods

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.

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

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 supportsCustomerQuery() is 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 supportsItemQuery() is 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 supportsSubmitterQuery() is 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 supportsSubmittingAgentQuery() is 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 supportsCloserQuery() is 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 supportsClosingAgentQuery() is 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 supportsStoreQuery() is 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 - a 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.