Interface AuditEnablerRuleLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
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:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated inquest view: All methods in this session operate, retrieve and pertain audit enablers defined explicitly in the current inquest
  • federated inquest view: All methods in this session operate, retrieve and pertain to all audit enablers defined in this inquest and any other audit enablers implicitly available in this inquest through inquest inheritence.

  • Method Details

    • getInquestId

      Id getInquestId()
      Gets the Inquest Id associated with this session.
      Returns:
      the Inquest Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getInquest

      Inquest getInquest() throws OperationFailedException, PermissionDeniedException
      Gets the Inquest associated with this session.
      Returns:
      the inquest
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupAuditEnablerRules

      boolean canLookupAuditEnablerRules()
      Tests if this user can perform lookups of audit enabler/audit mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeAuditEnablerRuleView

      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. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryAuditEnablerRuleView

      void usePlenaryAuditEnablerRuleView()
      A complete view of the 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.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedInquestView

      void useFederatedInquestView()
      Federates the view for methods in this session. A federated view will include audit enablers in inquests which are children of this inquest in the inquest hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedInquestView

      void useIsolatedInquestView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAuditEnablerIdsForAudit

      IdList getAuditEnablerIdsForAudit(Id auditId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuditEnabler Id associated with an Audit .
      Parameters:
      auditId - Id of the Audit
      Returns:
      the audit enabler Ids
      Throws:
      NotFoundException - auditId is not found
      NullArgumentException - auditId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuditEnablersForAudit

      AuditEnablerList getAuditEnablersForAudit(Id auditId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuditEnablers associated with an Audit .
      Parameters:
      auditId - Id of the Audit
      Returns:
      the audit enablers
      Throws:
      NotFoundException - auditId is not found
      NullArgumentException - auditId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuditIdsForAuditEnabler

      IdList getAuditIdsForAuditEnabler(Id auditEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Audit Ids mapped to an AuditEnabler .
      Parameters:
      auditEnablerId - Id of an AuditEnabler
      Returns:
      list of audit Ids
      Throws:
      NotFoundException - auditEnablerId is not found
      NullArgumentException - auditEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuditsForAuditEnabler

      AuditList getAuditsForAuditEnabler(Id auditEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Audits mapped to an AuditEnabler .
      Parameters:
      auditEnablerId - Id of an AuditEnabler
      Returns:
      list of audits
      Throws:
      NotFoundException - auditEnablerId is not found
      NullArgumentException - auditEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.