public interface AuditSmartInquestSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An AuditQuery
can be retrieved from this session
and mapped to this Inquest
to create a virtual collection
of audits. The audits may be sequenced using the AuditSearchOrder
from this session.
This Inquest
has a default query that matches any audit
and a default search order that specifies no sequencing. The queries may
be examined using an AuditQueryInspector.
The query may be
modified by converting the inspector back to an AuditQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAuditQuery(AuditQuery auditQuery)
Applies an audit query to this inquest.
|
void |
applyAuditSequencing(AuditSearchOrder auditSearchOrder)
Applies an audit search order to this inquest.
|
boolean |
canManageSmartInquests()
Tests if this user can manage smart inquests.
|
AuditQuery |
getAuditQuery()
Gets an audit query.
|
AuditQuery |
getAuditQueryFromInspector(AuditQueryInspector auditQueryInspector)
Gets an audit query from an inspector.
|
AuditSearchOrder |
getAuditSearchOrder()
Gets an audit search order.
|
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
AuditQueryInspector |
inspecAuditQuery()
Gets an audit 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. AuditQuery getAuditQuery()
mandatory
- This method must be implemented. AuditSearchOrder getAuditSearchOrder()
mandatory
- This method must be implemented. void applyAuditQuery(AuditQuery auditQuery) throws OperationFailedException, PermissionDeniedException
auditQuery
- the audit queryNullArgumentException
- auditQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- auditQuery
not of
this servicemandatory
- This method must be implemented. AuditQueryInspector inspecAuditQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAuditSequencing(AuditSearchOrder auditSearchOrder) throws OperationFailedException, PermissionDeniedException
auditSearchOrder
- the audit search orderNullArgumentException
- auditSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- auditSearchOrder
not of this servicemandatory
- This method must be implemented. AuditQuery getAuditQueryFromInspector(AuditQueryInspector auditQueryInspector)
auditQueryInspector
- an audit query inspectorNullArgumentException
- auditQueryInspector
is null
UnsupportedException
- auditQueryInspector
is not of this servicemandatory
- This method must be implemented.