OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConvocationSearchOrder
Implementsosid.OsidGovernatorSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByDate
Description

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

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

Specifies a preference for ordering the result set by the time period.

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

Tests if a time period order is available.

Returnboolean true if a time period order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodSearchOrder
Description

Gets the time period order.

Returnosid.calendaring.TimePeriodSearchOrderthe time period search order
ErrorsUNIMPLEMENTED supportsTimePeriodSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodSearchOrder() is true.
MethodgetConvocationSearchOrderRecord
Description

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

Parametersosid.type.TypeconvocationRecordTypea convocation record type
Returnosid.recognition.records.ConvocationSearchOrderRecordthe convocation search order record
ErrorsNULL_ARGUMENT convocationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(convocationRecordType) is false
CompliancemandatoryThis method must be implemented.