OSID Logo
OSID Specifications
acknowledgement package
Version 3.1.0
Interfaceosid.acknowledgement.CreditSearch
Implementsosid.OsidSearch
Used Byosid.acknowledgement.CreditSearchSession
Description

The search interface for governing credit searches.

MethodsearchAmongCredits
Description

Execute this search among the given list of credits.

Parametersosid.id.IdListcreditIds list of credits
ErrorsNULL_ARGUMENT creditIds is null
Compliancemandatory This method must be implemented.
MethodorderCreditResults
Description

Specify an ordering to the search results.

Parametersosid.acknowledgement.CreditSearchOrdercreditSearchOrder credit search order
ErrorsNULL_ARGUMENT creditSearchOrder is null
UNSUPPORTED creditSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetCreditSearchRecord
Description

Gets the record corresponding to the given credit search record Type. This method is used to retrieve an object implementing the requested record.

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