org.osid.resource

Interface ResourceRelationshipSearchOrder

All Superinterfaces:

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

public interface ResourceRelationshipSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ResourceSearchOrder	getDestinationResourceSearchOrder() Gets the search order for a peer resource.
ResourceRelationshipSearchOrderRecord	getResourceRelationshipSearchOrderRecord(Type resourceRelationshipRecordType) Gets the resource relationship search order record corresponding to the given resource relationship record Type.
ResourceSearchOrder	getSourceResourceSearchOrder() Gets the search order for a resource.
void	orderByDestinationResource(SearchOrderStyle style) Specified a preference for ordering results by the resource.
void	orderBySourceResource(SearchOrderStyle style) Specified a preference for ordering results by the resource.
boolean	supportsDestinationResourceSearchOrder() Tests if a ResourceSearchOrder is available.
boolean	supportsSourceResourceSearchOrder() Tests if a ResourceSearchOrder 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

orderBySourceResource

void orderBySourceResource(SearchOrderStyle style)

Specified a preference for ordering results by the resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSourceResourceSearchOrder

boolean supportsSourceResourceSearchOrder()

Tests if a ResourceSearchOrder is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSourceResourceSearchOrder

ResourceSearchOrder getSourceResourceSearchOrder()

Gets the search order for a resource.

Returns:

the resource search order

Throws:

UnimplementedException - supportsSourceResourceSearchOrder() is false

Compliance:

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

orderByDestinationResource

void orderByDestinationResource(SearchOrderStyle style)

Specified a preference for ordering results by the resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsDestinationResourceSearchOrder

boolean supportsDestinationResourceSearchOrder()

Tests if a ResourceSearchOrder is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDestinationResourceSearchOrder

ResourceSearchOrder getDestinationResourceSearchOrder()

Gets the search order for a peer resource.

Returns:

the resource search order

Throws:

UnimplementedException - supportsDestinationResourceSearchOrder() is false

Compliance:

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

getResourceRelationshipSearchOrderRecord

ResourceRelationshipSearchOrderRecord getResourceRelationshipSearchOrderRecord(Type resourceRelationshipRecordType)
                                                                               throws OperationFailedException

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

Parameters:

resourceRelationshipRecordType - a resource relationship record type

Returns:

the resource relationship search order record

Throws:

NullArgumentException - resourceRelationshipRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ResourceRelationshipRecordType) is false

Compliance:

mandatory - This method must be implemented.