Interface RelationshipSearchOrder

All Superinterfaces:

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

public interface RelationshipSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
RelationshipSearchOrderRecord	getRelationshipSearchOrderRecord(Type relationshipRecordType)	Gets the relationship search order record corresponding to the given relationship record Type .
void	orderByDestination(SearchOrderStyle style)	Specifies a preference for ordering the result set by the destination peer.
void	orderBySource(SearchOrderStyle style)	Specifies a preference for ordering the result set by the source peer.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Modifier and Type	Method	Description
StateSearchOrder	getEndReasonSearchOrder()	Gets the search order for a state.
void	orderByEndReason(SearchOrderStyle style)	Specifies a preference for ordering the results by the end reason state.
boolean	supportsEndReasonSearchOrder()	Tests if a StateSearchOrder is available.

Methods inherited from interface OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Modifier and Type	Method	Description
void	orderByEffective(SearchOrderStyle style)	Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

Method Details

orderBySource

void orderBySource(SearchOrderStyle style)

Specifies a preference for ordering the result set by the source peer.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDestination

void orderByDestination(SearchOrderStyle style)

Specifies a preference for ordering the result set by the destination peer.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getRelationshipSearchOrderRecord

RelationshipSearchOrderRecord getRelationshipSearchOrderRecord(Type relationshipRecordType)
                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

relationshipRecordType - a relationship record type

Returns:

the relationship search order record

Throws:

NullArgumentException - relationshipRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(relationshipRecordType) is false

Compliance:

mandatory - This method must be implemented.