public interface AuthorizationEnablerSmartVaultSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
vaults. An AuthorizationEnablerQuery
can be retrieved from
this session and mapped to this Vault
to create a virtual
collection of authorization enablers. The authorization enablers may be
sequenced using the AuthorizationEnablerSearchOrder
from
this session.
This Vault
has a default query that matches any
authorization enabler and a default search order that specifies no
sequencing. The queries may be examined using an
AuthorizationEnablerQueryInspector.
The query may be modified by
converting the inspector back to an AuthorizationEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAuthorizationEnablerQuery(AuthorizationEnablerQuery authorizationEnablerQuery)
Applies an authorization enabler query to this vault.
|
void |
applyAuthorizationEnablerSequencing(AuthorizationEnablerSearchOrder authorizationEnablerSearchOrder)
Applies an authorization enabler search order to this vault.
|
boolean |
canManageSmartVaults()
Tests if this user can manage smart vaults.
|
AuthorizationEnablerQuery |
getAuthorizationEnablerQuery()
Gets an authorization enabler query.
|
AuthorizationEnablerQuery |
getAuthorizationEnablerQueryFromInspector(AuthorizationEnablerQueryInspector authorizationEnablerQueryInspector)
Gets an authorization enabler query from an inspector.
|
AuthorizationEnablerSearchOrder |
getAuthorizationEnablerSearchOrder()
Gets an authorization enabler search order.
|
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
AuthorizationEnablerQueryInspector |
inspectAuthorizationEnablerQuery()
Gets an authorization enabler query inspector for this vault.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultId()
Vault
Id
associated with this
session. Vault Id
associated with this sessionmandatory
- This method must be implemented. Vault getVault() throws OperationFailedException, PermissionDeniedException
Vault
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartVaults()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart vault management is not
authorized, true
otherwisemandatory
- This method must be implemented. AuthorizationEnablerQuery getAuthorizationEnablerQuery()
mandatory
- This method must be implemented. AuthorizationEnablerSearchOrder getAuthorizationEnablerSearchOrder()
mandatory
- This method must be implemented. void applyAuthorizationEnablerQuery(AuthorizationEnablerQuery authorizationEnablerQuery) throws OperationFailedException, PermissionDeniedException
authorizationEnablerQuery
- the authorization enabler queryNullArgumentException
-
authorizationEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- authorizationEnablerQuery
not of this servicemandatory
- This method must be implemented. AuthorizationEnablerQueryInspector inspectAuthorizationEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAuthorizationEnablerSequencing(AuthorizationEnablerSearchOrder authorizationEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
authorizationEnablerSearchOrder
- the authorization enabler
search orderNullArgumentException
-
authorizationEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
authorizationEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. AuthorizationEnablerQuery getAuthorizationEnablerQueryFromInspector(AuthorizationEnablerQueryInspector authorizationEnablerQueryInspector)
authorizationEnablerQueryInspector
- an authorization enabler
query inspectorNullArgumentException
-
authorizationEnablerQueryInspector
is null
UnsupportedException
-
authorizationEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.