OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConferralSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByAward
Description

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

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

Tests if an award order is available.

Returnboolean true if an award order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAwardSearchOrder
Description

Gets the award order.

Returnosid.recognition.AwardSearchOrderthe award search order
ErrorsUNIMPLEMENTED supportsAwardSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAwardSearchOrder() is true.
MethodorderByRecipient
Description

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

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

Tests if a recipient order is available.

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

Gets the recipient order.

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

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

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

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

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

Tests if a convocation order is available.

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

Gets the convocation order.

Returnosid.recognition.ConvocationSearchOrderthe convocation search order
ErrorsUNIMPLEMENTED supportsConvocationSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsConvocationSearchOrder() is true.
MethodgetConferralSearchOrderRecord
Description

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

Parametersosid.type.TypeconferralRecordTypea conferral record type
Returnosid.recognition.records.ConferralSearchOrderRecordthe conferral search order record
ErrorsNULL_ARGUMENT conferralRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(conferralRecordType) is false
CompliancemandatoryThis method must be implemented.