OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.ResourceSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByGroup
Description

Groups the search results by resources that are groups.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByDemographic
Description

Groups the search results by resources that are demographics.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByAvatar
Description

Orders the result set by avatar.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsAvatarSearchOrder
Description

Tests if an AssetSearchOrder is available.

Returnboolean true if an asset search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAvatarSearchOrder
Description

Gets the search order for an asset.

Returnosid.repository.AssetSearchOrderthe asset search order
ErrorsUNIMPLEMENTED supportsAvatarSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAvatarSearchOrder() is true.
MethodgetResourceSearchOrderRecord
Description

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

Parametersosid.type.TyperesourceRecordTypea resource record type
Returnosid.resource.records.ResourceSearchOrderRecordthe resource search order record
ErrorsNULL_ARGUMENT resourceRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(resourceRecordType) is false
CompliancemandatoryThis method must be implemented.