public interface AuditEnablerQuerySession extends OsidSession
This session provides methods for searching among AuditEnabler
objects. The search query is constructed using the
AuditEnablerQuery.
This session defines views that offer differing behaviors for searching.
Inquiry constrainer enablers may have a query record indicated by
their respective record types. The query record is accessed via the
AuditEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAuditEnablers()
Tests if this user can perform
AuditEnabler lookups. |
AuditEnablerQuery |
getAuditEnablerQuery()
Gets an audit enabler query.
|
AuditEnablerList |
getAuditEnablersByQuery(AuditEnablerQuery auditEnablerQuery)
Gets a list of
AuditEnablers matching the given search. |
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 canSearchAuditEnablers()
AuditEnabler
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. AuditEnablerQuery getAuditEnablerQuery()
mandatory
- This method must be implemented. AuditEnablerList getAuditEnablersByQuery(AuditEnablerQuery auditEnablerQuery) throws OperationFailedException, PermissionDeniedException
AuditEnablers
matching the given search.auditEnablerQuery
- the inquiry constraienr enabler query AuditEnablerList
NullArgumentException
- auditEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auditEnablerQuery
is not of this servicemandatory
- This method must be implemented.