OSID Logo
OSID Specifications
acknowledgement package
Version 3.1.0
Interfaceosid.acknowledgement.CreditSearchResults
Implementsosid.OsidSearchResults
Used Byosid.acknowledgement.CreditSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetCredits
Description

Gets the credit list resulting from a search.

Returnosid.acknowledgement.CreditList the credit list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCreditQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.acknowledgement.CreditQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetCreditSearchResultsRecord
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.CreditSearchResultsRecord the credit search results record
ErrorsNULL_ARGUMENT creditSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(creditSearchRecordType) is false
Compliancemandatory This method must be implemented.