OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.OrderSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidAggregateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByCustomer
Description

Specifies a preference for ordering the result set by the customer.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCustomerSearchOrder
Description

Tests if a customer search order is available.

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

Gets the customer search order.

Returnosid.resource.ResourceSearchOrderthe customer search order
ErrorsUNIMPLEMENTED supportsCustomerSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCustomerSearchOrder() is true.
MethodorderByTotalCost
Description

Specifies a preference for ordering the result set by the total cost.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderBySubmitDate
Description

Specifies a preference for ordering the result set by the submitted date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderBySubmitter
Description

Specifies a preference for ordering the result set by the submitter.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsSubmitterSearchOrder
Description

Tests if a submitter search order is available.

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

Gets the submitter search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsSubmitterSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsSubmitterSearchOrder() is true.
MethodorderBySubmittingAgent
Description

Specifies a preference for ordering the result set by the submitting agent.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsSubmittingAgentSearchOrder
Description

Tests if a submitting agent search order is available.

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

Gets the submitting agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsUNIMPLEMENTED supportsSubmittingAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsSubmittingAgentSearchOrder() is true.
MethodorderByClosedDate
Description

Specifies a preference for ordering the result set by the closed date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCloser
Description

Specifies a preference for ordering the result set by the closer.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCloserSearchOrder
Description

Tests if a closer search order is available.

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

Gets the closer search order.

Returnosid.authentication.AgentSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsCloserSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCloserSearchOrder() is true.
MethodorderByClosingAgent
Description

Specifies a preference for ordering the result set by the closer.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsClosingAgentSearchOrder
Description

Tests if a closing agent search order is available.

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

Gets the closing agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsUNIMPLEMENTED supportsClosingAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsClosingAgentSearchOrder() is true.
MethodgetOrderSearchOrderRecord
Description

Gets the order search order record corresponding to the given order record Type. Multiple retrievals return the same underlying object.

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