org.osid.authorization

Interface AuthorizationSearchOrder

All Superinterfaces:

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

public interface AuthorizationSearchOrder
extends OsidRelationshipSearchOrder

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.
AuthorizationSearchOrderRecord	getAuthorizationSearchOrderRecord(Type authorizationRecordType) Gets the authorization search order record corresponding to the given function record Type.
FunctionSearchOrder	getFunctionSearchOrder() Gets the function search order.
QualifierSearchOrder	getQualifierSearchOrder() Gets the qualifier search order.
ResourceSearchOrder	getResourceSearchOrder() Gets the resource search order.
void	orderByAgent(SearchOrderStyle style) Specifies a preference for ordering the result set by the agent.
void	orderByFunction(SearchOrderStyle style) Specifies a preference for ordering the result set by the active status.
void	orderByQualifier(SearchOrderStyle style) Specifies a preference for ordering the result set by the qualifier,
void	orderByResource(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
void	orderByTrust(SearchOrderStyle style) Specifies a preference for ordering the result set by the trust.
boolean	supportsAgentSearchOrder() Tests if an Agent is available.
boolean	supportsFunctionSearchOrder() Tests if a Function is available.
boolean	supportsQualifierSearchOrder() Tests if a Qualifier is available.
boolean	supportsResourceSearchOrder() Tests if a Resource is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByResource

void orderByResource(SearchOrderStyle style)

Specifies a preference for ordering the result set by the resource.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a Resource 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 order

Throws:

UnimplementedException - supportsResourceSearchOrder() is false

Compliance:

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

orderByTrust

void orderByTrust(SearchOrderStyle style)

Specifies a preference for ordering the result set by the trust.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByAgent

void orderByAgent(SearchOrderStyle style)

Specifies a preference for ordering the result set by the agent.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAgentSearchOrder

boolean supportsAgentSearchOrder()

Tests if an Agent 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 if supportsAgentSearchOrder() is true.

orderByFunction

void orderByFunction(SearchOrderStyle style)

Specifies a preference for ordering the result set by the active status.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsFunctionSearchOrder

boolean supportsFunctionSearchOrder()

Tests if a Function is available.

Returns:

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

Compliance:

mandatory - This method must be implemented.

getFunctionSearchOrder

FunctionSearchOrder getFunctionSearchOrder()

Gets the function search order.

Returns:

the function search order

Throws:

UnimplementedException - supportsFunctionSearchOrder() is false

Compliance:

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

orderByQualifier

void orderByQualifier(SearchOrderStyle style)

Specifies a preference for ordering the result set by the qualifier,

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsQualifierSearchOrder

boolean supportsQualifierSearchOrder()

Tests if a Qualifier is available.

Returns:

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

Compliance:

mandatory - This method must be implemented.

getQualifierSearchOrder

QualifierSearchOrder getQualifierSearchOrder()

Gets the qualifier search order.

Returns:

the qualifier search order

Throws:

UnimplementedException - supportsQualifierSearchOrder() is false

Compliance:

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

getAuthorizationSearchOrderRecord

AuthorizationSearchOrderRecord getAuthorizationSearchOrderRecord(Type authorizationRecordType)
                                                                 throws OperationFailedException

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

Parameters:

authorizationRecordType - an authorization record type

Returns:

the authorization search order record

Throws:

NullArgumentException - authorizationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(authorizationRecordType) is false

Compliance:

mandatory - This method must be implemented.