public interface ProvisionableSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
PoolSearchOrder |
getPoolSearchOrder()
Gets the pool search order.
|
ProvisionableSearchOrderRecord |
getProvisionableSearchOrderRecord(Type provisionableRecordType)
Gets the provisionable search order record corresponding to the given
provisionable record
Type. |
ResourceSearchOrder |
getResourceSearchOrder()
Gets the resource search order.
|
void |
orderByPool(SearchOrderStyle style)
Orders the results by pool.
|
void |
orderByResource(SearchOrderStyle style)
Orders the results by resource.
|
void |
orderByUse(SearchOrderStyle style)
Orders the results by use.
|
boolean |
supportsPoolSearchOrder()
Tests if a pool 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 orderByPool(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPoolSearchOrder()
true
if a pool search order is available,
false
otherwisemandatory
- This method must be implemented. PoolSearchOrder getPoolSearchOrder()
IllegalStateException
-
supportsPoolSearchOrder()
is false
mandatory
- This method must be implemented. 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 orderByUse(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ProvisionableSearchOrderRecord getProvisionableSearchOrderRecord(Type provisionableRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.provisionableRecordType
- a provisionable record typeNullArgumentException
- provisionableRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionableRecordType)
is false
mandatory
- This method must be implemented.