org.osid.recognition

Interface ConferralSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface ConferralSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByAward

void orderByAward(SearchOrderStyle style)

Specifies a preference for ordering the result set by the award.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAwardSearchOrder

boolean supportsAwardSearchOrder()

Tests if an award order is available.

Returns:

true if an award order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAwardSearchOrder

AwardSearchOrder getAwardSearchOrder()

Gets the award order.

Returns:

the award search order

Throws:

UnimplementedException - supportsAwardSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsAwardSearchOrder() is true.

orderByRecipient

void orderByRecipient(SearchOrderStyle style)

Specifies a preference for ordering the result set by the recipient.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRecipientSearchOrder

boolean supportsRecipientSearchOrder()

Tests if a recipient order is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRecipientSearchOrder

ResourceSearchOrder getRecipientSearchOrder()

Gets the recipient order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsRecipientSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsRecipientSearchOrder() is true.

orderByReference

void orderByReference(SearchOrderStyle style)

Specifies a preference for ordering the result set by the reference.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByConvocation

void orderByConvocation(SearchOrderStyle style)

Specifies a preference for ordering the result set by the convocation.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsConvocationSearchOrder

boolean supportsConvocationSearchOrder()

Tests if a convocation order is available.

Returns:

true if a convocation order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getConvocationSearchOrder

ConvocationSearchOrder getConvocationSearchOrder()

Gets the convocation order.

Returns:

the convocation search order

Throws:

UnimplementedException - supportsConvocationSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsConvocationSearchOrder() is true.

getConferralSearchOrderRecord

ConferralSearchOrderRecord getConferralSearchOrderRecord(Type conferralRecordType)
                                                         throws OperationFailedException

Gets the conferral search order record corresponding to the given conferral record Type. Multiple retrievals return the same underlying object.

Parameters:

conferralRecordType - a conferral record type

Returns:

the conferral search order record

Throws:

NullArgumentException - conferralRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(conferralRecordType) is false

Compliance:

mandatory - This method must be implemented.