public interface AuditQuerySession extends OsidSession
This session provides methods for searching among Audit
objects. The search query is constructed using the AuditQuery.
This session defines views that offer differing behaviors for searching.
Audits may have a query record indicated by their respective record
types. The query record is accessed via the AuditQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAudits()
Tests if this user can perform
Audit lookups. |
AuditQuery |
getAuditQuery()
Gets an audit query.
|
AuditList |
getAuditsByQuery(AuditQuery auditQuery)
Gets a list of
Audits matching the given audit query. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
useFederatedInquestView()
Federates the view for methods in this session.
|
void |
useIsolatedInquestView()
Isolates the view for methods in this session.
|
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 canSearchAudits()
Audit
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedInquestView()
mandatory
- This method is must be implemented. void useIsolatedInquestView()
mandatory
- This method is must be implemented. AuditQuery getAuditQuery()
mandatory
- This method must be implemented. AuditList getAuditsByQuery(AuditQuery auditQuery) throws OperationFailedException, PermissionDeniedException
Audits
matching the given audit query.auditQuery
- the audit query AuditList
NullArgumentException
- auditQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auditQuery
is not
of this servicemandatory
- This method must be implemented.