public interface HoldSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AgentSearchOrder |
getAgentSearchOrder()
Gets the agent search order.
|
HoldSearchOrderRecord |
getHoldSearchOrderRecord(Type holdRecordType)
Gets the hold search order record corresponding to the given hold
record
Type. |
IssueSearchOrder |
getIssueSearchOrder()
Gets the issue search order.
|
ResourceSearchOrder |
getResourceSearchOrder()
Gets the resource search order.
|
void |
orderByAgent(SearchOrderStyle style)
Orders the results by agent.
|
void |
orderByIssue(SearchOrderStyle style)
Orders the results by issue.
|
void |
orderByResource(SearchOrderStyle style)
Orders the results by resource.
|
boolean |
supportsAgentSearchOrder()
Tests if an agent search order is available.
|
boolean |
supportsIssueSearchOrder()
Tests if an issue search order is available.
|
boolean |
supportsResourceSearchOrder()
Tests if a resource search order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByResource(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsResourceSearchOrder()
true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getResourceSearchOrder()
IllegalStateException
-
supportsResourceSearchOrder()
is false
mandatory
- This method must be implemented. void orderByAgent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAgentSearchOrder()
true
if an agent search order is available,
false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getAgentSearchOrder()
IllegalStateException
-
supportsAgentSearchOrder()
is false
mandatory
- This method must be implemented. void orderByIssue(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsIssueSearchOrder()
true
if an issue search order is available,
false
otherwisemandatory
- This method must be implemented. IssueSearchOrder getIssueSearchOrder()
IllegalStateException
-
supportsIssueSearchOrder()
is false
mandatory
- This method must be implemented. HoldSearchOrderRecord getHoldSearchOrderRecord(Type holdRecordType) throws OperationFailedException, PermissionDeniedException
Type.
Multiple retrievals return the same
underlying object.holdRecordType
- a hold record typeNullArgumentException
- holdRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(holdRecordType)
is false
mandatory
- This method must be implemented.