org.osid.authentication

Interface AgentSearchOrder

All Superinterfaces:

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

public interface AgentSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgentSearchOrderRecord	getAgentSearchOrderRecord(Type agentRecordType) Gets the agent search order record corresponding to the given agent record Type.
ResourceSearchOrder	getResourceSearchOrder() Gets the resource search order.
void	orderByResource(SearchOrderStyle style) Orders the results by resource.
boolean	supportsResourceSearchOrder() Tests if a ResourceSearchOrder 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

orderByResource

void orderByResource(SearchOrderStyle style)

Orders the results by resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a ResourceSearchOrder is available.

Returns:

true if a resource search order interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the resource search order.

Returns:

the resource search odrer

Throws:

UnimplementedException - supportsResourceSearchOrder() is false

Compliance:

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

getAgentSearchOrderRecord

AgentSearchOrderRecord getAgentSearchOrderRecord(Type agentRecordType)
                                                 throws OperationFailedException

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

Parameters:

agentRecordType - an agent record type

Returns:

the agent search order record

Throws:

NullArgumentException - agentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agentRecordType) is false

Compliance:

mandatory - This method must be implemented.