org.osid.authentication.keys

Interface KeySearchOrder

All Superinterfaces:

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

public interface KeySearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgentSearchOrder	getAgentSearchOrder() Gets the agent search order.
KeySearchOrderRecord	getKeySearchOrderRecord(Type keyRecordType) Gets the key search order record corresponding to the given key record Type.
boolean	supportsAgentSearchOrder() Tests if an AgentSearchOrder is available.

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

supportsAgentSearchOrder

boolean supportsAgentSearchOrder()

Tests if an AgentSearchOrder is available.

Returns:

true if an agent search order interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentSearchOrder

AgentSearchOrder getAgentSearchOrder()

Gets the agent search order.

Returns:

the agent search order

Throws:

UnimplementedException - supportsAgentSearchOrder() is false

Compliance:

optional - This method must be implemented is supportsAgentSearchOrder() is true.

getKeySearchOrderRecord

KeySearchOrderRecord getKeySearchOrderRecord(Type keyRecordType)
                                             throws OperationFailedException

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

Parameters:

keyRecordType - a key record type

Returns:

the key search order record

Throws:

NullArgumentException - keyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(keyRecordType) is false

Compliance:

mandatory - This method must be implemented.