Interface | osid.ordering.OrderQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidAggregateableQuery | |||
Description |
This is the query for searching orders. Each method
specifies an | ||
Method | matchCustomerId | ||
Description |
Sets the item | ||
Parameters | osid.id.Id | customerId | a customer Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | itemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCustomerIdTerms | ||
Description |
Clears the customer | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCustomerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a customer query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCustomerQuery | ||
Description |
Gets the query for a customer query. Multiple
retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the customer query | |
Errors | UNIMPLEMENTED | supportsCustomerQuery() is false | |
Compliance | optional | This method must be implemented if supportsCustomerQuery()
is true. | |
Method | clearCustomerTerms | ||
Description |
Clears the customer terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchItemId | ||
Description |
Sets the item | ||
Parameters | osid.id.Id | itemId | an item Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | itemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearItemIdTerms | ||
Description |
Clears the item | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsItemQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an item query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemQuery | ||
Description |
Gets the query for an item query. Multiple retrievals
produce a nested | ||
Return | osid.ordering.ItemQuery | the item query | |
Errors | UNIMPLEMENTED | supportsItemQuery() is false | |
Compliance | optional | This method must be implemented if supportsItemQuery() is
true. | |
Method | matchAnyItem | ||
Description |
Matches orders with any item. | ||
Parameters | boolean | 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. | |
Method | clearItemTerms | ||
Description |
Clears the item terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTotalCost | ||
Description |
Matches total costs between the given range inclusive. | ||
Parameters | osid.financials.Currency | low | low range |
osid.financials.Currency | high | high range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearTotalCostTerms | ||
Description |
Clears the total cost terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumTotalCost | ||
Description |
Matches total costs greter than or equal to the given cost. | ||
Parameters | osid.financials.Currency | cost | a cost |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumTotalCostTerms | ||
Description |
Clears the minimum total cost terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAtomic | ||
Description |
Matches atomic orders. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearAtomicTerms | ||
Description |
Clears the atomic terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSubmitDate | ||
Description |
Matches orders submitted between the given time range inclusive. | ||
Parameters | osid.calendaring.DateTime | from | starting time range |
osid.calendaring.DateTime | to | ending time range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | itemId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSubmitDateTerms | ||
Description |
Clears the submit date terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSubmitterId | ||
Description |
Sets a submitting resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubmitterIdTerms | ||
Description |
Clears the submitter | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSubmitterQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubmitterQuery | ||
Description |
Gets the query for a submitting agent query. Multiple
retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsSubmitterQuery() is false | |
Compliance | optional | This method must be implemented if supportsSubmitterQuery()
is true. | |
Method | matchAnySubmitter | ||
Description |
Matches any submitted order. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubmitterTerms | ||
Description |
Clears the submitter terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSubmittingAgentId | ||
Description |
Sets a submitting agent | ||
Parameters | osid.id.Id | agentId | an agent Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubmittingAgentIdTerms | ||
Description |
Clears the submitter | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSubmittingAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubmittingAgentQuery | ||
Description |
Gets the query for a submitting agent query. Multiple
retrievals produce a nested | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsSubmittingAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsSubmittingAgentQuery()
is true. | |
Method | matchAnySubmittingAgent | ||
Description |
Matches any submitted order. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubmittingAgentTerms | ||
Description |
Clears the submitter terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchClosedDate | ||
Description |
Matches orders closed between the given time range inclusive. | ||
Parameters | osid.calendaring.DateTime | from | starting time range |
osid.calendaring.DateTime | to | ending time range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | itemId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearClosedDateTerms | ||
Description |
Clears the closed date terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCloserId | ||
Description |
Sets a closer resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCloserIdTerms | ||
Description |
Clears the closer | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCloserQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCloserQuery | ||
Description |
Gets the query for a closer resource query. Multiple
retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsCloserQuery() is false | |
Compliance | optional | This method must be implemented if supportsCloserQuery() is
true. | |
Method | matchAnyCloser | ||
Description |
Matches any closed order. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearCloserTerms | ||
Description |
Clears the closer terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchClosingAgentId | ||
Description |
Sets a closing agent | ||
Parameters | osid.id.Id | agentId | an agent Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearClosingAgentIdTerms | ||
Description |
Clears the closer | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsClosingAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getClosingAgentQuery | ||
Description |
Gets the query for a closing agent query. Multiple
retrievals produce a nested | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsClosingAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsClosingAgentQuery()
is true. | |
Method | matchAnyClosingAgent | ||
Description |
Matches any closed order. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearClosingAgentTerms | ||
Description |
Clears the closer terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchStoreId | ||
Description |
Sets the item | ||
Parameters | osid.id.Id | storeId | a store Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | storeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearStoreIdTerms | ||
Description |
Clears the store | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsStoreQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a store query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStoreQuery | ||
Description |
Gets the query for a store query. Multiple retrievals
produce a nested | ||
Return | osid.ordering.StoreQuery | the store query | |
Errors | UNIMPLEMENTED | supportsStoreQuery() is false | |
Compliance | optional | This method must be implemented if supportsStoreQuery() is
true. | |
Method | clearStoreTerms | ||
Description |
Clears the store terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrderQueryRecord | ||
Description |
Gets the order query record corresponding to the given
| ||
Parameters | osid.type.Type | orderRecordType | a order record type |
Return | osid.ordering.records.OrderQueryRecord | the order query record | |
Errors | NULL_ARGUMENT | orderRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(orderRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |