org.osid.authorization.rules

Interface AuthorizationEnablerQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

AuthorizationEnablerSearchSession

public interface AuthorizationEnablerQuerySession
extends OsidSession

This session provides methods for searching among AuthorizationEnabler objects. The search query is constructed using the AuthorizationEnablerQuery.

This session defines views that offer differing behaviors for searching.

• federated vault view: searches include authorization enablers in vaults of which this vault is an ancestor in the vault hierarchy
• isolated vault view: searches are restricted to authorization enablers in this vault

Authorization enablers may have a query record indicated by their respective record types. The query record is accessed via the AuthorizationEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchAuthorizationEnablers() Tests if this user can perform AuthorizationEnabler lookups.
AuthorizationEnablerQuery	getAuthorizationEnablerQuery() Gets an authorization enabler query.
AuthorizationEnablerList	getAuthorizationEnablersByQuery(AuthorizationEnablerQuery authorizationEnablerQuery) Gets a list of AuthorizationEnablers matching the given search.
Vault	getVault() Gets the Vault associated with this session.
Id	getVaultId() Gets the Vault Id associated with this session.
void	useFederatedVaultView() Federates the view for methods in this session.
void	useIsolatedVaultView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getVaultId

Id getVaultId()

Gets the Vault Id associated with this session.

Returns:

the Vault Id associated with this session

Compliance:

mandatory - This method must be implemented.

getVault

Vault getVault()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Vault associated with this session.

Returns:

the vault

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchAuthorizationEnablers

boolean canSearchAuthorizationEnablers()

Tests if this user can perform AuthorizationEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedVaultView

void useFederatedVaultView()

Federates the view for methods in this session. A federated view will include authorization enablers in vaults which are children of this broker in the vault hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedVaultView

void useIsolatedVaultView()

Isolates the view for methods in this session. An isolated view restricts lookups to this vault only.

Compliance:

mandatory - This method is must be implemented.

getAuthorizationEnablerQuery

AuthorizationEnablerQuery getAuthorizationEnablerQuery()

Gets an authorization enabler query.

Returns:

the authorization enabler query

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablersByQuery

AuthorizationEnablerList getAuthorizationEnablersByQuery(AuthorizationEnablerQuery authorizationEnablerQuery)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Gets a list of AuthorizationEnablers matching the given search.

Parameters:

authorizationEnablerQuery - the search query

Returns:

the returned AuthorizationEnablerList

Throws:

NullArgumentException - authorizationEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - authorizationEnablerQuery is not of this service

Compliance:

mandatory - This method must be implemented.