public interface CreditSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CreditSearchOrderRecord |
getCreditSearchOrderRecord(Type creditRecordType)
Gets the credit search order record corresponding to the given credit
record
Type. |
ResourceSearchOrder |
getResourceSearchOrder()
Gets the resource search order.
|
void |
orderByReference(SearchOrderStyle style)
Specifies a preference for ordering the result set by the reference.
|
void |
orderByResource(SearchOrderStyle style)
Specifies a preference for ordering the result set by the resource.
|
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 orderByReference(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
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()
UnimplementedException
-
supportsResourceSearchOrder()
is false
optional
- This method must be implemented if
supportsResourceSearchOrder()
is true.
CreditSearchOrderRecord getCreditSearchOrderRecord(Type creditRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.creditRecordType
- a credit record typeNullArgumentException
- creditRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(creditRecordType)
is false
mandatory
- This method must be implemented.