org.osid.hold

Interface BlockSearchOrder

All Superinterfaces:

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

public interface BlockSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BlockSearchOrderRecord	getBlockSearchOrderRecord(Type blockRecordType) Gets the block search order record corresponding to the given block 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

Method Detail

getBlockSearchOrderRecord

BlockSearchOrderRecord getBlockSearchOrderRecord(Type blockRecordType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

blockRecordType - a block record type

Returns:

the block search order record

Throws:

NullArgumentException - blockRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(blockRecordType) is false

Compliance:

mandatory - This method must be implemented.