OSID Logo
OSID Specifications
acknowledgement package
Version 3.1.0
Interfaceosid.acknowledgement.CreditSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Used Byosid.acknowledgement.CreditSearchSession
osid.acknowledgement.CreditSmartBillingSession
Description

An interface for specifying the ordering of search results.

MethodorderByReference
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByResource
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsResourceSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetResourceSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrder the resource search order
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
Complianceoptional This method must be implemented if supportsResourceSearchOrder() is true.
MethodgetCreditSearchOrderRecord
Description

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

Parametersosid.type.TypecreditRecordType a credit record type
Returnosid.acknowledgement.records.CreditSearchOrderRecord the credit search order record
ErrorsNULL_ARGUMENT creditRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(creditRecordType) is false
Compliancemandatory This method must be implemented.