org.osid.profile

Interface ProfileItemSearchOrder

All Superinterfaces:

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

public interface ProfileItemSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ProfileItemSearchOrderRecord	getProfileItemSearchOrderRecord(Type profileItemRecordType) Gets the profile item search order record corresponding to the given profile item 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

getProfileItemSearchOrderRecord

ProfileItemSearchOrderRecord getProfileItemSearchOrderRecord(Type profileItemRecordType)
                                                             throws OperationFailedException

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

Parameters:

profileItemRecordType - a profile item record type

Returns:

the profile item search order record

Throws:

NullArgumentException - profileItemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileItemRecordType) is false

Compliance:

mandatory - This method must be implemented.