public interface AuditEnablerSmartInquestSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
inquests. An AuditEnablerQuery
can be retrieved from this
session and mapped to this Inquest
to create a virtual
collection of audit enablers. The audit enablers may be sequenced using
the AuditEnablerSearchOrder
from this session.
This Inquest
has a default query that matches any audit
enabler and a default search order that specifies no sequencing. The
queries may be examined using an AuditEnablerQueryInspector.
The query may be modified by converting the inspector back to an
AuditEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAuditEnablerQuery(AuditEnablerQuery auditEnablerQuery)
Applies an audit enabler query to this inquest.
|
void |
applyAuditEnablerSequencing(AuditEnablerSearchOrder auditEnablerSearchOrder)
Applies an audit enabler search order to this inquest.
|
boolean |
canManageSmartInquests()
Tests if this user can manage smart inquests.
|
AuditEnablerQuery |
getAuditEnablerQuery()
Gets an audit enabler query.
|
AuditEnablerQuery |
getAuditEnablerQueryFromInspector(AuditEnablerQueryInspector auditEnablerQueryInspector)
Gets an audit enabler query from an inspector.
|
AuditEnablerSearchOrder |
getAuditEnablerSearchOrder()
Gets an audit enabler search order.
|
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
AuditEnablerQueryInspector |
inspectAuditEnablerQuery()
Gets an audit enabler query inspector for this inquest.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getInquestId()
Inquest
Id
associated with this
session. Inquest Id
associated with this sessionmandatory
- This method must be implemented. Inquest getInquest() throws OperationFailedException, PermissionDeniedException
Inquest
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartInquests()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart inquest management is not
authorized, true
otherwisemandatory
- This method must be implemented. AuditEnablerQuery getAuditEnablerQuery()
mandatory
- This method must be implemented. AuditEnablerSearchOrder getAuditEnablerSearchOrder()
mandatory
- This method must be implemented. void applyAuditEnablerQuery(AuditEnablerQuery auditEnablerQuery) throws OperationFailedException, PermissionDeniedException
auditEnablerQuery
- the audit enabler queryNullArgumentException
- auditEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- auditEnablerQuery
not of this servicemandatory
- This method must be implemented. AuditEnablerQueryInspector inspectAuditEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAuditEnablerSequencing(AuditEnablerSearchOrder auditEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
auditEnablerSearchOrder
- the audit enabler search orderNullArgumentException
- auditEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- auditEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. AuditEnablerQuery getAuditEnablerQueryFromInspector(AuditEnablerQueryInspector auditEnablerQueryInspector)
auditEnablerQueryInspector
- an audit enabler query inspectorNullArgumentException
-
auditEnablerQueryInspector
is null
UnsupportedException
-
auditEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.