OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.CreditSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByReference
Description

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

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

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

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodgetResourceSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
ComplianceoptionalThis 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.TypecreditRecordTypea credit record type
Returnosid.acknowledgement.records.CreditSearchOrderRecordthe credit search order record
ErrorsNULL_ARGUMENT creditRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(creditRecordType) is false
CompliancemandatoryThis method must be implemented.