org.osid.authorization

Interface VaultSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface VaultSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
VaultSearchOrderRecord	getVaultSearchOrderRecord(Type vaultRecordType) Gets the vault search order record corresponding to the given vault 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.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getVaultSearchOrderRecord

VaultSearchOrderRecord getVaultSearchOrderRecord(Type vaultRecordType)
                                                 throws OperationFailedException

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

Parameters:

vaultRecordType - a vault record type

Returns:

the vault search order record

Throws:

NullArgumentException - vaultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(vaultRecordType) is false

Compliance:

mandatory - This method must be implemented.