public interface ResourceRelationshipSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ResourceSearchOrder |
getDestinationResourceSearchOrder()
Gets the search order for a peer resource.
|
ResourceRelationshipSearchOrderRecord |
getResourceRelationshipSearchOrderRecord(Type resourceRelationshipRecordType)
Gets the resource relationship search order record corresponding to
the given resource relationship record
Type. |
ResourceSearchOrder |
getSourceResourceSearchOrder()
Gets the search order for a resource.
|
void |
orderByDestinationResource(SearchOrderStyle style)
Specified a preference for ordering results by the resource.
|
void |
orderBySourceResource(SearchOrderStyle style)
Specified a preference for ordering results by the resource.
|
boolean |
supportsDestinationResourceSearchOrder()
Tests if a
ResourceSearchOrder is available. |
boolean |
supportsSourceResourceSearchOrder()
Tests if a
ResourceSearchOrder is available. |
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderBySourceResource(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSourceResourceSearchOrder()
ResourceSearchOrder
is available. true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getSourceResourceSearchOrder()
UnimplementedException
-
supportsSourceResourceSearchOrder()
is false
optional
- This method must be implemented if
supportsSourceResourceSearchOrder()
is
true.
void orderByDestinationResource(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsDestinationResourceSearchOrder()
ResourceSearchOrder
is available. true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getDestinationResourceSearchOrder()
UnimplementedException
-
supportsDestinationResourceSearchOrder()
is
false
optional
- This method must be implemented if
supportsDestinationResourceSearchOrder()
is
true.
ResourceRelationshipSearchOrderRecord getResourceRelationshipSearchOrderRecord(Type resourceRelationshipRecordType) throws OperationFailedException
Type.
Multiple
retrievals return the same underlying object.resourceRelationshipRecordType
- a resource relationship record
typeNullArgumentException
-
resourceRelationshipRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(ResourceRelationshipRecordType)
is
false
mandatory
- This method must be implemented.