public interface AuditEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve AuditEnabler
to Audit
mappings. An Audit
with multiple
AuditEnablers
means any positive rule evaluation across the
enablers result in an effective Inquiry.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAuditEnablerRules()
Tests if this user can perform lookups of audit enabler/audit
mappings.
|
IdList |
getAuditEnablerIdsForAudit(Id auditId)
Gets the
AuditEnabler Id associated with an
Audit. |
AuditEnablerList |
getAuditEnablersForAudit(Id auditId)
Gets the
AuditEnablers associated with an Audit. |
IdList |
getAuditIdsForAuditEnabler(Id auditEnablerId)
Gets the
Audit Ids mapped to an
AuditEnabler. |
AuditList |
getAuditsForAuditEnabler(Id auditEnablerId)
Gets the
Audits mapped to an AuditEnabler. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
useComparativeAuditEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedInquestView()
Federates the view for methods in this session.
|
void |
useIsolatedInquestView()
Isolates the view for methods in this session.
|
void |
usePlenaryAuditEnablerRuleView()
A complete view of the
AuditEnabler and Audit
returns is desired. |
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 canLookupAuditEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeAuditEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryAuditEnablerRuleView()
AuditEnabler
and Audit
returns is desired. Methods will return what is requested or
result in an error. This view is used when greater precision is
desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedInquestView()
mandatory
- This method is must be implemented. void useIsolatedInquestView()
mandatory
- This method is must be implemented. IdList getAuditEnablerIdsForAudit(Id auditId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuditEnabler Id
associated with an
Audit.
auditId
- Id
of the Audit
Ids
NotFoundException
- auditId
is not foundNullArgumentException
- auditId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditEnablerList getAuditEnablersForAudit(Id auditId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuditEnablers
associated with an Audit.
auditId
- Id
of the Audit
NotFoundException
- auditId
is not foundNullArgumentException
- auditId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAuditIdsForAuditEnabler(Id auditEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Audit
Ids
mapped to an
AuditEnabler.
auditEnablerId
- Id
of an AuditEnabler
Ids
NotFoundException
- auditEnablerId
is
not foundNullArgumentException
- auditEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuditList getAuditsForAuditEnabler(Id auditEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Audits
mapped to an AuditEnabler.
auditEnablerId
- Id
of an AuditEnabler
NotFoundException
- auditEnablerId
is
not foundNullArgumentException
- auditEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.