org.osid.authorization

Interface AuthorizationSmartVaultSession

All Superinterfaces:

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

public interface AuthorizationSmartVaultSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A AuthorizationQuery can be retrieved from this session and mapped to this Vault to create a virtual collection of Authorizations. The authorizations may be sequenced using the AuthorizationSearchOrder from this session.

This Vault has a default query that matches any authorization and a default search order that specifies no sequencing. The queries may be examined using a AuthorizationQueryInspector. The query may be modified by converting the inspector back to a AuthorizationQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAuthorizationQuery(AuthorizationQuery authorizationQuery) Applies a authorization query to this vault.
void	applyAuthorizationSequencing(AuthorizationSearchOrder authorizationSearchOrder) Applies a authorization search order to this vault.
boolean	canManageSmartVault() Tests if this user can manage smart vault.
AuthorizationQuery	getAuthorizationQuery() Gets a authorization query.
AuthorizationQuery	getAuthorizationQueryFromInspector(AuthorizationQueryInspector authorizationQueryInspector) Gets a authorization query from an inspector.
AuthorizationSearchOrder	getAuthorizationSearchOrder() Gets a authorization search order.
Vault	getVault() Gets the Vault associated with this session.
Id	getVaultId() Gets the Vault Id associated with this session.
AuthorizationQueryInspector	inspectAuthorizationQuery() Gets a authorization query inspector for this vault.

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 associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartVault

boolean canManageSmartVault()

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

Returns:

false if smart vault management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAuthorizationQuery

AuthorizationQuery getAuthorizationQuery()

Gets a authorization query.

Returns:

the authorization query

Compliance:

mandatory - This method must be implemented.

getAuthorizationSearchOrder

AuthorizationSearchOrder getAuthorizationSearchOrder()

Gets a authorization search order.

Returns:

the authorization search order.

Compliance:

mandatory - This method must be implemented.

applyAuthorizationQuery

void applyAuthorizationQuery(AuthorizationQuery authorizationQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a authorization query to this vault.

Parameters:

authorizationQuery - the authorization query

Throws:

NullArgumentException - authorizationQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - authorizationQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectAuthorizationQuery

AuthorizationQueryInspector inspectAuthorizationQuery()
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a authorization query inspector for this vault.

Returns:

the authorization query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyAuthorizationSequencing

void applyAuthorizationSequencing(AuthorizationSearchOrder authorizationSearchOrder)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Applies a authorization search order to this vault.

Parameters:

authorizationSearchOrder - the authorization search order

Throws:

NullArgumentException - authorizationSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - authorizationSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getAuthorizationQueryFromInspector

AuthorizationQuery getAuthorizationQueryFromInspector(AuthorizationQueryInspector authorizationQueryInspector)

Gets a authorization query from an inspector.

Parameters:

authorizationQueryInspector - a resorce relationship query inspector

Returns:

the authorization query

Throws:

NullArgumentException - authorizationQueryInspector is null

UnsupportedException - authorizationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.