Interface ResourceSearchOrder

All Superinterfaces:

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

public interface ResourceSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
AssetSearchOrder	getAvatarSearchOrder()	Gets the search order for an asset.
ResourceSearchOrderRecord	getResourceSearchOrderRecord(Type resourceRecordType)	Gets the resource search record corresponding to the given resource record Type .
void	orderByAvatar(SearchOrderStyle style)	Orders the result set by avatar.
void	orderByDemographic(SearchOrderStyle style)	Groups the search results by resources that are demographics.
void	orderByGroup(SearchOrderStyle style)	Groups the search results by resources that are groups.
boolean	supportsAvatarSearchOrder()	Tests if an AssetSearchOrder is available.

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 .

Method Details

orderByGroup

void orderByGroup(SearchOrderStyle style)

Groups the search results by resources that are groups.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDemographic

void orderByDemographic(SearchOrderStyle style)

Groups the search results by resources that are demographics.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByAvatar

void orderByAvatar(SearchOrderStyle style)

Orders the result set by avatar.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAvatarSearchOrder

boolean supportsAvatarSearchOrder()

Tests if an AssetSearchOrder is available.

Returns:

true if an asset search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAvatarSearchOrder

AssetSearchOrder getAvatarSearchOrder()

Gets the search order for an asset.

Returns:

the asset search order

Throws:

UnimplementedException - supportsAvatarSearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsAvatarSearchOrder()} is {@code true} .

getResourceSearchOrderRecord

ResourceSearchOrderRecord getResourceSearchOrderRecord(Type resourceRecordType)
                                                throws OperationFailedException

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

Parameters:

resourceRecordType - a resource record type

Returns:

the resource search order record

Throws:

NullArgumentException - resourceRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resourceRecordType) is false

Compliance:

mandatory - This method must be implemented.