Interface TodoSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidContainableSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface TodoSearchOrder
extends OsidObjectSearchOrder, OsidContainableSearchOrder, OsidTemporalSearchOrder, OsidFederateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
TodoSearchOrderRecord	getTodoSearchOrderRecord(Type todoRecordType)	Gets the todo search order record corresponding to the given todo record Type .
void	orderByComplete(SearchOrderStyle style)	Specifies a preference for ordering the result set by the completed status.
void	orderByDueDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the due date.
void	orderByPriority(SearchOrderStyle style)	Specifies a preference for ordering the result set by the priority.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidContainableSearchOrder

orderBySequestered

Modifier and Type	Method	Description
void	orderBySequestered(SearchOrderStyle style)	Specifies a preference for ordering the result set by the sequestered flag.

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Modifier and Type	Method	Description
void	orderByEffective(SearchOrderStyle style)	Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

Method Details

orderByComplete

void orderByComplete(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByPriority

void orderByPriority(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDueDate

void orderByDueDate(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getTodoSearchOrderRecord

TodoSearchOrderRecord getTodoSearchOrderRecord(Type todoRecordType)
                                        throws OperationFailedException

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

Parameters:

todoRecordType - a todo record type

Returns:

the todo search order record

Throws:

NullArgumentException - todoRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoRecordType) is false

Compliance:

mandatory - This method must be implemented.