OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CredentialEntrySearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByStudent
Description

Specifies a preference for ordering the result set by the resource.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsStudentSearchOrder
Description

Tests if a resource order is available.

Returnboolean true if a resource order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStudentSearchOrder
Description

Gets the resource order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsStudentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsStudentSearchOrder() is true.
MethodorderByCredential
Description

Specifies a preference for ordering the result set by the credential.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialSearchOrder
Description

Tests if a credential order is available.

Returnboolean true if a credential order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCredentialSearchOrder
Description

Gets the credential order.

Returnosid.course.program.CredentialSearchOrderthe credential search order
ErrorsUNIMPLEMENTED supportsCredentialSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCredentialSearchOrder() is true.
MethodorderByDateAwarded
Description

Specifies a preference for ordering the result set by the award date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByProgram
Description

Specifies a preference for ordering the result set by the program.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsProgramSearchOrder
Description

Tests if a program order is available.

Returnboolean true if a program order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProgramSearchOrder
Description

Gets the program order.

Returnosid.course.program.ProgramSearchOrderthe program search order
ErrorsUNIMPLEMENTED supportsProgramSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsProgramSearchOrder() is true.
MethodgetCredentialEntrySearchOrderRecord
Description

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

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