OSID Logo
OSID Specifications
repository package
Version 3.1.0
Interfaceosid.repository.AssetContentSearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.repository.AssetContentSearchSession
osid.repository.AssetContentSmartRepositorySession
Description

An interface for specifying the ordering of search results.

MethodorderByAsset
Description

Specifies a preference for ordering the result set by asset.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsAssetSearchOrder
Description

Tests if an asset order interface is available.

Returnboolean true if an asset search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetAssetSearchOrder
Description

Gets the asset order.

Returnosid.repository.AssetSearchOrder the asset search order for the source
ErrorsUNIMPLEMENTED supportsAssetSearchOrder() is false
Complianceoptional This method must be implemented if supportsAssetSearchOrder() is true.
MethodorderByDataLength
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByURL
Description

Specifies a preference for ordering the result set by url.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodgetAssetContentSearchOrderRecord
Description

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

Parametersosid.type.TypeassetContentRecordType an asset content record type
Returnosid.repository.records.AssetContentSearchOrderRecord the asset content search order record
ErrorsNULL_ARGUMENT assetContentRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(assetContentRecordType) is false
Compliancemandatory This method must be implemented.