Interface AuditProcessorRuleLookupSession

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

This session provides methods to retrieve AuditProcessor to Audit mappings.

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

    • canLookupAuditProcessorRules

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

    • useComparativeAuditProcessorRuleView

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

    • usePlenaryAuditProcessorRuleView

      void usePlenaryAuditProcessorRuleView()
      A complete view of the AuditProcessor 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 processors 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.

    • getAuditProcessorIdsForAudit

      IdList getAuditProcessorIdsForAudit(Id auditId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuditProcessor Ids associated with an Audit .
      Parameters:
      auditId - Id of the Audit
      Returns:
      the audit processor 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.

    • getAuditProcessorsForAudit

      AuditProcessorList getAuditProcessorsForAudit(Id auditId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuditProcessors associated with an Audit .
      Parameters:
      auditId - Id of the Audit
      Returns:
      the audit processors
      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.

    • getAuditIdsForAuditProcessor

      IdList getAuditIdsForAuditProcessor(Id auditProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Audit Ids mapped to an AuditProcessor .
      Parameters:
      auditProcessorId - Id of an AuditProcessor
      Returns:
      list of audit 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.

    • getAuditsForAuditProcessor

      AuditList getAuditsForAuditProcessor(Id auditProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Audits mapped to an AuditProcessor .
      Parameters:
      auditProcessorId - Id of an AuditProcessor
      Returns:
      list of audits
      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.