org.osid.profile

Interface ProfileSearchOrder

All Superinterfaces:

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

public interface ProfileSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ProfileSearchOrderRecord	getProfileSearchOrderRecord(Type profileRecordType) Gets the profile search order record corresponding to the given profile 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

getProfileSearchOrderRecord

ProfileSearchOrderRecord getProfileSearchOrderRecord(Type profileRecordType)
                                                     throws OperationFailedException

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

Parameters:

profileRecordType - a profile record type

Returns:

the profile search order record

Throws:

NullArgumentException - profileRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileRecordType) is false

Compliance:

mandatory - This method must be implemented.