OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CredentialEntrySearch
Implementsosid.OsidSearch
Description

The search interface for governing credential entry searches.

MethodsearchAmongCredentialEntries
Description

Execute this search among the given list of credential entries.

Parametersosid.id.IdListcredentialEntryIdslist of credential entry Ids
ErrorsNULL_ARGUMENT credentialEntryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCredentialEntryResults
Description

Specify an ordering to the search results.

Parametersosid.course.chronicle.CredentialEntrySearchOrdercredentialEntrySearchOrdercredential entry search order
ErrorsNULL_ARGUMENT credentialEntrySearchOrder is null
UNSUPPORTED credentialEntrySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCredentialEntrySearchRecord
Description

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

Parametersosid.type.TypecredentialEntrySearchRecordTypea credential entry search record type
Returnosid.course.chronicle.records.CredentialEntrySearchRecordthe credential entry search record
ErrorsNULL_ARGUMENT credentialEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.