public interface WorkSearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and 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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByJob(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsJobSearchOrder()
true
if a job search order is available,
false
otherwisemandatory
- This method must be implemented. JobSearchOrder getJobSearchOrder()
IllegalStateException
- supportsJobSearchOrder()
is false
mandatory
- This method must be implemented. void orderByCreatedDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCompletionDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. WorkSearchOrderRecord getWorkSearchOrderRecord(Type workRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.workRecordType
- a work record typeNullArgumentException
- workRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(workRecordType)
is false
mandatory
- This method must be implemented.