Interface AssetContentSearchOrder

All Superinterfaces:

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

public interface AssetContentSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
AssetContentSearchOrderRecord	getAssetContentSearchOrderRecord(Type assetContentRecordType)	Gets the asset content search order record corresponding to the given asset content record Type .
AssetSearchOrder	getAssetSearchOrder()	Gets the asset order.
void	orderByAsset(SearchOrderStyle style)	Specifies a preference for ordering the result set by asset.
void	orderByDataLength(SearchOrderStyle style)	Specifies a preference for ordering the result set by data length.
void	orderByURL(SearchOrderStyle style)	Specifies a preference for ordering the result set by url.
boolean	supportsAssetSearchOrder()	Tests if an asset order interface 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

orderByAsset

void orderByAsset(SearchOrderStyle style)

Specifies a preference for ordering the result set by asset.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAssetSearchOrder

boolean supportsAssetSearchOrder()

Tests if an asset order interface is available.

Returns:

true if an asset search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssetSearchOrder

AssetSearchOrder getAssetSearchOrder()

Gets the asset order.

Returns:

the asset search order for the source

Throws:

UnimplementedException - supportsAssetSearchOrder() is false

Compliance:

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

orderByDataLength

void orderByDataLength(SearchOrderStyle style)

Specifies a preference for ordering the result set by data length.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByURL

void orderByURL(SearchOrderStyle style)

Specifies a preference for ordering the result set by url.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getAssetContentSearchOrderRecord

AssetContentSearchOrderRecord getAssetContentSearchOrderRecord(Type assetContentRecordType)
                                                        throws OperationFailedException

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

Parameters:

assetContentRecordType - an asset content record type

Returns:

the asset content search order record

Throws:

NullArgumentException - assetContentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assetContentRecordType) is false

Compliance:

mandatory - This method must be implemented.