org.osid.relationship

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

Methods

Modifier and Type	Method and 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 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

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.