public interface CommitmentSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CommitmentSearchOrderRecord |
getCommitmentSearchOrderRecord(Type commitmentRecordType)
Gets the commitment search order record corresponding to the given
commitment record
Type. |
EventSearchOrder |
getEventSearchOrder()
Gets the search order for an event.
|
ResourceSearchOrder |
getResourceSearchOrder()
Gets the search order for a resource.
|
void |
orderByEvent(SearchOrderStyle style)
Specified a preference for ordering results by the event.
|
void |
orderByResource(SearchOrderStyle style)
Specified a preference for ordering results by the resource.
|
boolean |
supportsEventSearchOrder()
Tests if an
EventSearchOrder is available. |
boolean |
supportsResourceSearchOrder()
Tests if a
ResourceSearchOrder is available. |
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByEvent(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsEventSearchOrder()
EventSearchOrder
is available. true
if an event search order is available,
false
otherwisemandatory
- This method must be implemented. EventSearchOrder getEventSearchOrder()
UnimplementedException
-
supportsEventSearchOrder()
is false
optional
- This method must be implemented if
supportsEventSearchOrder()
is true.
void orderByResource(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsResourceSearchOrder()
ResourceSearchOrder
is available. true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getResourceSearchOrder()
UnimplementedException
-
supportsResourceSearchOrder()
is false
optional
- This method must be implemented if
supportsResourceSearchOrder()
is true.
CommitmentSearchOrderRecord getCommitmentSearchOrderRecord(Type commitmentRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.commitmentRecordType
- a commitment record typeNullArgumentException
- commitmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commitmentRecordType)
is false
mandatory
- This method must be implemented.