public interface ProvisionReturnSearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ProvisionReturnSearchOrderRecord |
getProvisionReturnSearchOrderRecord(Type provisionReturnRecordType)
Gets the provision return search order record corresponding to the
given provision return record
Type. |
ResourceSearchOrder |
getReturnerSearchOrder()
Gets the resource search order.
|
AgentSearchOrder |
getReturningAgentSearchOrder()
Gets the agent search order.
|
void |
orderByReturnDate(SearchOrderStyle style)
Orders the results by the return date.
|
void |
orderByReturner(SearchOrderStyle style)
Orders the results by the returner.
|
void |
orderByReturningAgent(SearchOrderStyle style)
Orders the results by the returning agent.
|
boolean |
supportsReturnerSearchOrder()
Tests if a resource search order is available.
|
boolean |
supportsReturningAgentSearchOrder()
Tests if an agent search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByReturnDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByReturner(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsReturnerSearchOrder()
true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getReturnerSearchOrder()
IllegalStateException
-
supportsReturnerSearchOrder()
is false
mandatory
- This method must be implemented. void orderByReturningAgent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsReturningAgentSearchOrder()
true
if an agent search order is available,
false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getReturningAgentSearchOrder()
IllegalStateException
-
supportsReturningAgentSearchOrder()
is false
mandatory
- This method must be implemented. ProvisionReturnSearchOrderRecord getProvisionReturnSearchOrderRecord(Type provisionReturnRecordType) throws OperationFailedException
Type.
Multiple retrievals
return the same underlying object.provisionReturnRecordType
- a provision return record typeNullArgumentException
-
provisionReturnRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionReturnRecordType)
is
false
mandatory
- This method must be implemented.