Interface WorkSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable

public interface WorkSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
JobSearchOrder	getJobSearchOrder()	Gets the job search order.
WorkSearchOrderRecord	getWorkSearchOrderRecord(Type workRecordType)	Gets the work search order record corresponding to the given work record Type .
void	orderByCompletionDate(SearchOrderStyle style)	Orders the results by the completion date.
void	orderByCreatedDate(SearchOrderStyle style)	Orders the results by the created date.
void	orderByJob(SearchOrderStyle style)	Orders the results by the job.
boolean	supportsJobSearchOrder()	Tests if a job search order is available.

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 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 .

Method Details

orderByJob

void orderByJob(SearchOrderStyle style)

Orders the results by the job.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsJobSearchOrder

boolean supportsJobSearchOrder()

Tests if a job search order is available.

Returns:

true if a job search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getJobSearchOrder

JobSearchOrder getJobSearchOrder()

Gets the job search order.

Returns:

the job search order

Throws:

IllegalStateException - supportsJobSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByCreatedDate

void orderByCreatedDate(SearchOrderStyle style)

Orders the results by the created date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCompletionDate

void orderByCompletionDate(SearchOrderStyle style)

Orders the results by the completion date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getWorkSearchOrderRecord

WorkSearchOrderRecord getWorkSearchOrderRecord(Type workRecordType)
                                        throws OperationFailedException

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

Parameters:

workRecordType - a work record type

Returns:

the work search order record

Throws:

NullArgumentException - workRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workRecordType) is false

Compliance:

mandatory - This method must be implemented.