public interface ConferralSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AwardSearchOrder |
getAwardSearchOrder()
Gets the award order.
|
ConferralSearchOrderRecord |
getConferralSearchOrderRecord(Type conferralRecordType)
Gets the conferral search order record corresponding to the given
conferral record
Type. |
ConvocationSearchOrder |
getConvocationSearchOrder()
Gets the convocation order.
|
ResourceSearchOrder |
getRecipientSearchOrder()
Gets the recipient order.
|
void |
orderByAward(SearchOrderStyle style)
Specifies a preference for ordering the result set by the award.
|
void |
orderByConvocation(SearchOrderStyle style)
Specifies a preference for ordering the result set by the convocation.
|
void |
orderByRecipient(SearchOrderStyle style)
Specifies a preference for ordering the result set by the recipient.
|
void |
orderByReference(SearchOrderStyle style)
Specifies a preference for ordering the result set by the reference.
|
boolean |
supportsAwardSearchOrder()
Tests if an award order is available.
|
boolean |
supportsConvocationSearchOrder()
Tests if a convocation order is available.
|
boolean |
supportsRecipientSearchOrder()
Tests if a recipient order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByAward(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAwardSearchOrder()
true
if an award order is available,
false
otherwisemandatory
- This method must be implemented. AwardSearchOrder getAwardSearchOrder()
UnimplementedException
-
supportsAwardSearchOrder()
is false
optional
- This method must be implemented if
supportsAwardSearchOrder()
is true.
void orderByRecipient(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsRecipientSearchOrder()
true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getRecipientSearchOrder()
UnimplementedException
-
supportsRecipientSearchOrder()
is false
optional
- This method must be implemented if
supportsRecipientSearchOrder()
is true.
void orderByReference(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByConvocation(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsConvocationSearchOrder()
true
if a convocation order is available,
false
otherwisemandatory
- This method must be implemented. ConvocationSearchOrder getConvocationSearchOrder()
UnimplementedException
-
supportsConvocationSearchOrder()
is false
optional
- This method must be implemented if
supportsConvocationSearchOrder()
is true.
ConferralSearchOrderRecord getConferralSearchOrderRecord(Type conferralRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.conferralRecordType
- a conferral record typeNullArgumentException
- conferralRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(conferralRecordType)
is false
mandatory
- This method must be implemented.