OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CredentialSearch
Implementsosid.OsidSearch
Description

The search interface for governing credential searches.

MethodsearchAmongCredentials
Description

Execute this search among the given list of credentials.

Parametersosid.id.IdListcredentialIdslist of credentials
ErrorsNULL_ARGUMENT credentialIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCredentialResults
Description

Specify an ordering to the search results.

Parametersosid.course.program.CredentialSearchOrdercredentialSearchOrdercredential search order
ErrorsNULL_ARGUMENT credentialSearchOrder is null
UNSUPPORTED credentialSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCredentialSearchRecord
Description

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

Parametersosid.type.TypecredentialSearchRecordTypea credential search record type
Returnosid.course.program.records.CredentialSearchRecordthe credential search record
ErrorsNULL_ARGUMENT credentialSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialSearchRecordType) is false
CompliancemandatoryThis method must be implemented.