public interface RequestTransactionSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
BrokerSearchOrder |
getBrokerSearchOrder()
Gets the broker search order.
|
RequestTransactionSearchOrderRecord |
getRequestTransactionSearchOrderRecord(Type requestTransactionRecordType)
Gets the request transaction search order record corresponding to the
given request record
Type. |
ResourceSearchOrder |
getSubmitterSearchOrder()
Gets the resource search order.
|
AgentSearchOrder |
getSubmittingAgentSearchOrder()
Gets the agent search order.
|
void |
orderByBroker(SearchOrderStyle style)
Orders the results by the broker.
|
void |
orderBySubmitDate(SearchOrderStyle style)
Orders the results by the submit date.
|
void |
orderBySubmitter(SearchOrderStyle style)
Orders the results by the submitter.
|
void |
orderBySubmittingAgent(SearchOrderStyle style)
Orders the results by submitting agent.
|
boolean |
supportsBrokerSearchOrder()
Tests if a broker search order is available.
|
boolean |
supportsSubmitterSearchOrder()
Tests if a resource search order is available.
|
boolean |
supportsSubmittingAgentSearchOrder()
Tests if an agent search order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByBroker(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsBrokerSearchOrder()
true
if a broker search order is available,
false
otherwisemandatory
- This method must be implemented. BrokerSearchOrder getBrokerSearchOrder()
IllegalStateException
-
supportsBrokerSearchOrder()
is false
mandatory
- This method must be implemented. void orderBySubmitDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySubmitter(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSubmitterSearchOrder()
true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getSubmitterSearchOrder()
IllegalStateException
-
supportsSubmitterSearchOrder()
is false
mandatory
- This method must be implemented. void orderBySubmittingAgent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSubmittingAgentSearchOrder()
true
if an agent search order is available,
false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getSubmittingAgentSearchOrder()
IllegalStateException
-
supportsSubmittingAgentSearchOrder()
is false
mandatory
- This method must be implemented. RequestTransactionSearchOrderRecord getRequestTransactionSearchOrderRecord(Type requestTransactionRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.requestTransactionRecordType
- a request transaction record typeNullArgumentException
-
requestTransactionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(requestTransactionRecordType)
is
false
mandatory
- This method must be implemented.