Interface AuditProcessorEnablerRuleLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface AuditProcessorEnablerRuleLookupSession extends OsidSession

This session provides methods to retrieve AuditProcessorEnabler to AuditProcessor mappings .

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 to audit processor enablers defined explicitly in the current inquest
  • federated inquest view: All methods in this session operate, retrieve and pertain to all audit processor enablers defined in this inquest and any other audit processor 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.

    • canLookupAuditProcessorEnablerRules

      boolean canLookupAuditProcessorEnablerRules()
      Tests if this user can perform lookups of audit processor enabler/audit processor 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.

    • useComparativeAuditProcessorEnablerRuleView

      void useComparativeAuditProcessorEnablerRuleView()
      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.

    • usePlenaryAuditProcessorEnablerRuleView

      void usePlenaryAuditProcessorEnablerRuleView()
      A complete view of the AuditProcessorEnabler and AuditProcessor 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 processor 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.

    • getAuditProcessorEnablerIdsForAudit

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

    • getAuditProcessorEnablersForAuditProcessor

      AuditProcessorEnablerList getAuditProcessorEnablersForAuditProcessor(Id auditProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuditProcessorEnablers associated with an AuditProcessor .
      Parameters:
      auditProcessorId - Id of the AuditProcessor
      Returns:
      the audit processor enablers
      Throws:
      NotFoundException - auditProcessorId is not found
      NullArgumentException - auditProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorIdsForAuditProcessorEnabler

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

    • getAuditProcessorsForAuditProcessorEnabler

      AuditProcessorList getAuditProcessorsForAuditProcessorEnabler(Id auditProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuditProcessors mapped to an AuditProcessorEnabler .
      Parameters:
      auditProcessorEnablerId - Id of an AuditprocessorEnabler
      Returns:
      list of audit processors
      Throws:
      NotFoundException - auditProcessorEnablerId is not found
      NullArgumentException - auditProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.