OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.OrderQuery
Implementsosid.OsidObjectQuery
osid.OsidAggregateableQuery
Description

This is the query for searching orders. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchCustomerId
Description

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

Parametersosid.id.IdcustomerIda customer Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT itemId is null
CompliancemandatoryThis method must be implemented.
MethodclearCustomerIdTerms
Description

Clears the customer Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCustomerQuery
Description

Tests if a CustomerQuery is available.

Returnboolean true if a customer query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCustomerQuery
Description

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

Returnosid.resource.ResourceQuerythe customer query
ErrorsUNIMPLEMENTED supportsCustomerQuery() is false
ComplianceoptionalThis method must be implemented if supportsCustomerQuery() is true.
MethodclearCustomerTerms
Description

Clears the customer terms.

CompliancemandatoryThis method must be implemented.
MethodmatchItemId
Description

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

Parametersosid.id.IditemIdan item Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT itemId is null
CompliancemandatoryThis method must be implemented.
MethodclearItemIdTerms
Description

Clears the item Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsItemQuery
Description

Tests if an ItemQuery is available.

Returnboolean true if an item query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemQuery
Description

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

Returnosid.ordering.ItemQuerythe item query
ErrorsUNIMPLEMENTED supportsItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() is true.
MethodmatchAnyItem
Description

Matches orders with any item.

Parametersbooleanmatch true for a to matc h odrers with any items, false to match orders with no items
CompliancemandatoryThis method must be implemented.
MethodclearItemTerms
Description

Clears the item terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTotalCost
Description

Matches total costs between the given range inclusive.

Parametersosid.financials.Currencylowlow range
osid.financials.Currencyhighhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearTotalCostTerms
Description

Clears the total cost terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumTotalCost
Description

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

Parametersosid.financials.Currencycosta cost
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumTotalCostTerms
Description

Clears the minimum total cost terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAtomic
Description

Matches atomic orders.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearAtomicTerms
Description

Clears the atomic terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSubmitDate
Description

Matches orders submitted between the given time range inclusive.

Parametersosid.calendaring.DateTimefromstarting time range
osid.calendaring.DateTimetoending time range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT itemId is null
CompliancemandatoryThis method must be implemented.
MethodclearSubmitDateTerms
Description

Clears the submit date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSubmitterId
Description

Sets a submitting resource Id.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearSubmitterIdTerms
Description

Clears the submitter Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSubmitterQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSubmitterQuery
Description

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsSubmitterQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubmitterQuery() is true.
MethodmatchAnySubmitter
Description

Matches any submitted order.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearSubmitterTerms
Description

Clears the submitter terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSubmittingAgentId
Description

Sets a submitting agent Id.

Parametersosid.id.IdagentIdan agent Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearSubmittingAgentIdTerms
Description

Clears the submitter Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSubmittingAgentQuery
Description

Tests if an AgentQuery is available.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSubmittingAgentQuery
Description

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

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsSubmittingAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubmittingAgentQuery() is true.
MethodmatchAnySubmittingAgent
Description

Matches any submitted order.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearSubmittingAgentTerms
Description

Clears the submitter terms.

CompliancemandatoryThis method must be implemented.
MethodmatchClosedDate
Description

Matches orders closed between the given time range inclusive.

Parametersosid.calendaring.DateTimefromstarting time range
osid.calendaring.DateTimetoending time range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT itemId is null
CompliancemandatoryThis method must be implemented.
MethodclearClosedDateTerms
Description

Clears the closed date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCloserId
Description

Sets a closer resource Id.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearCloserIdTerms
Description

Clears the closer Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCloserQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCloserQuery
Description

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsCloserQuery() is false
ComplianceoptionalThis method must be implemented if supportsCloserQuery() is true.
MethodmatchAnyCloser
Description

Matches any closed order.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearCloserTerms
Description

Clears the closer terms.

CompliancemandatoryThis method must be implemented.
MethodmatchClosingAgentId
Description

Sets a closing agent Id.

Parametersosid.id.IdagentIdan agent Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearClosingAgentIdTerms
Description

Clears the closer Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsClosingAgentQuery
Description

Tests if an AgentQuery is available.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetClosingAgentQuery
Description

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

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsClosingAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsClosingAgentQuery() is true.
MethodmatchAnyClosingAgent
Description

Matches any closed order.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearClosingAgentTerms
Description

Clears the closer terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStoreId
Description

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

Parametersosid.id.IdstoreIda store Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT storeId is null
CompliancemandatoryThis method must be implemented.
MethodclearStoreIdTerms
Description

Clears the store Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsStoreQuery
Description

Tests if a StoreQuery is available.

Returnboolean true if a store query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStoreQuery
Description

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

Returnosid.ordering.StoreQuerythe store query
ErrorsUNIMPLEMENTED supportsStoreQuery() is false
ComplianceoptionalThis method must be implemented if supportsStoreQuery() is true.
MethodclearStoreTerms
Description

Clears the store terms.

CompliancemandatoryThis method must be implemented.
MethodgetOrderQueryRecord
Description

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

Parametersosid.type.TypeorderRecordTypea order record type
Returnosid.ordering.records.OrderQueryRecordthe order query record
ErrorsNULL_ARGUMENT orderRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(orderRecordType) is false
CompliancemandatoryThis method must be implemented.