OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.TodoSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidContainableSearchOrder
osid.OsidTemporalSearchOrder
osid.OsidFederateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByComplete
Description

Specifies a preference for ordering the result set by the completed status.

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

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

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

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

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

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

Parametersosid.type.TypetodoRecordTypea todo record type
Returnosid.checklist.records.TodoSearchOrderRecordthe todo search order record
ErrorsNULL_ARGUMENT todoRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(todoRecordType) is false
CompliancemandatoryThis method must be implemented.