org.osid.repository

Interface CompositionSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidContainableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface CompositionSearchOrder
extends OsidObjectSearchOrder, OsidContainableSearchOrder, OsidOperableSearchOrder, OsidSourceableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CompositionSearchOrderRecord	getCompositionSearchOrderRecord(Type compositionRecordType) Gets the composition search order record corresponding to the given repository record Type.

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.OsidContainableSearchOrder

orderBySequestered

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getCompositionSearchOrderRecord

CompositionSearchOrderRecord getCompositionSearchOrderRecord(Type compositionRecordType)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

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

Parameters:

compositionRecordType - a composition record type

Returns:

the composition search order record

Throws:

NullArgumentException - compositionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(compositionRecordType) is false

Compliance:

mandatory - This method must be implemented.