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.
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.
|
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. Vault
associated with this sessionOperationFailedException
- 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. QualifierQuery getQualifierQuery()
mandatory
- This method must be implemented. QualifierSearchOrder getQualifierSearchOrder()
mandatory
- This method must be implemented. void applyQualifierQuery(QualifierQuery qualifierQuery) throws OperationFailedException, PermissionDeniedException
qualifierQuery
- the qualifier queryNullArgumentException
- qualifierQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- qualifierQuery
not of this servicemandatory
- This method must be implemented. QualifierQueryInspector inspectQualifierQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyQualifierSequencing(QualifierSearchOrder qualifierSearchOrder) throws OperationFailedException, PermissionDeniedException
qualifierSearchOrder
- the qualifier search orderNullArgumentException
- qualifierSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- qualifierSearchOrder
not of this servicemandatory
- This method must be implemented. QualifierQuery getQualifierQueryFromInspector(QualifierQueryInspector qualifierQueryInspector)
qualifierQueryInspector
- a query inspectorNullArgumentException
- qualifierQueryInspector
is null
UnsupportedException
- qualifierQueryInspector
is not of this servicemandatory
- This method must be implemented.