OSID Logo
OSID Specifications
checklist package
Version 3.1.0
Interfaceosid.checklist.TodoSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidContainableSearchOrder
osid.OsidTemporalSearchOrder
osid.OsidFederateableSearchOrder
Used Byosid.checklist.TodoSearchSession
osid.checklist.TodoSmartChecklistSession
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.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByPriority
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByDueDate
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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.TypetodoRecordType a todo record type
Returnosid.checklist.records.TodoSearchOrderRecord the todo search order record
ErrorsNULL_ARGUMENT todoRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(todoRecordType) is false
Compliancemandatory This method must be implemented.