OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CredentialSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByLifetime
Description

Specifies a preference for ordering the result set by lifetime.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetCredentialSearchOrderRecord
Description

Gets the credential search order record corresponding to the given credential record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypecredentialRecordTypea credential record type
Returnosid.course.program.records.CredentialSearchOrderRecordthe credential search order record
ErrorsNULL_ARGUMENT credentialRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialRecordType) is false
CompliancemandatoryThis method must be implemented.