OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.CommitmentSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByEvent
Description

Specified a preference for ordering results by the event.

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

Tests if an EventSearchOrder is available.

Returnboolean true if an event search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEventSearchOrder
Description

Gets the search order for an event.

Returnosid.calendaring.EventSearchOrderthe event search order
ErrorsUNIMPLEMENTED supportsEventSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsEventSearchOrder() is true.
MethodorderByResource
Description

Specified a preference for ordering results by the resource.

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

Tests if a ResourceSearchOrder is available.

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

Gets the search order for a resource.

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

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

Parametersosid.type.TypecommitmentRecordTypea commitment record type
Returnosid.calendaring.records.CommitmentSearchOrderRecordthe commitment search order record
ErrorsNULL_ARGUMENT commitmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commitmentRecordType) is false
CompliancemandatoryThis method must be implemented.