org.osid.authorization

Interface QualifierSmartVaultSession

All Superinterfaces:

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

public interface QualifierSmartVaultSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A QualifierQuery can be retrieved from this session and mapped to this Vault to create a virtual collection of Qualifiers. The qualifiers may be sequenced using the QualifierSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyQualifierQuery(QualifierQuery qualifierQuery) Applies a qualifier query to this vault.
void	applyQualifierSequencing(QualifierSearchOrder qualifierSearchOrder) Applies a qualifier search order to this vault.
boolean	canManageSmartVaults() Tests if this user can manage smart vaults.
QualifierQuery	getQualifierQuery() Gets a qualifier query.
QualifierQuery	getQualifierQueryFromInspector(QualifierQueryInspector qualifierQueryInspector) Gets a qualifier query from an inspector.
QualifierSearchOrder	getQualifierSearchOrder() Gets a qualifier search order.
Vault	getVault() Gets the Vault associated with this session.
Id	getVaultId() Gets the Vault Id associated with this session.
QualifierQueryInspector	inspectQualifierQuery() Gets a qualifier 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.

canManageSmartVaults

boolean canManageSmartVaults()

Tests if this user can manage smart vaults. 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.

getQualifierQuery

QualifierQuery getQualifierQuery()

Gets a qualifier query.

Returns:

the qualifier query

Compliance:

mandatory - This method must be implemented.

getQualifierSearchOrder

QualifierSearchOrder getQualifierSearchOrder()

Gets a qualifier search order.

Returns:

the qualifier search order

Compliance:

mandatory - This method must be implemented.

applyQualifierQuery

void applyQualifierQuery(QualifierQuery qualifierQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a qualifier query to this vault.

Parameters:

qualifierQuery - the qualifier query

Throws:

NullArgumentException - qualifierQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - qualifierQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectQualifierQuery

QualifierQueryInspector inspectQualifierQuery()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a qualifier query inspector for this vault.

Returns:

the qualifier query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyQualifierSequencing

void applyQualifierSequencing(QualifierSearchOrder qualifierSearchOrder)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a qualifier search order to this vault.

Parameters:

qualifierSearchOrder - the qualifier search order

Throws:

NullArgumentException - qualifierSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - qualifierSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getQualifierQueryFromInspector

QualifierQuery getQualifierQueryFromInspector(QualifierQueryInspector qualifierQueryInspector)

Gets a qualifier query from an inspector.

Parameters:

qualifierQueryInspector - a query inspector

Returns:

the qualifier query

Throws:

NullArgumentException - qualifierQueryInspector is null

UnsupportedException - qualifierQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.