Interface AuditConstrainerEnablerRuleLookupSession

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

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

    • canLookupAuditConstrainerEnablerRules

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

    • useComparativeAuditConstrainerEnablerRuleView

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

    • usePlenaryAuditConstrainerEnablerRuleView

      void usePlenaryAuditConstrainerEnablerRuleView()
      A complete view of the AuditConstrainerEnabler and AuditConstrainer 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 constrainer 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.

    • getAuditConstrainerEnablerIdsForAudit

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

    • getAuditConstrainerEnablersForAuditConstrainer

      AuditConstrainerEnablerList getAuditConstrainerEnablersForAuditConstrainer(Id auditConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuditConstrainerEnablers associated with an AuditConstrainer .
      Parameters:
      auditConstrainerId - Id of the AuditConstrainer
      Returns:
      the audit constrainer enablers
      Throws:
      NotFoundException - auditConstrainerId is not found
      NullArgumentException - auditConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuditConstrainerIdsForAuditConstrainerEnabler

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

    • getAuditConstrainersForAuditConstrainerEnabler

      AuditConstrainerList getAuditConstrainersForAuditConstrainerEnabler(Id auditConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuditConstrainers mapped to an AuditConstrainerEnabler .
      Parameters:
      auditConstrainerEnablerId - Id of an AuditConstrainerEnabler
      Returns:
      list of audit constrainers
      Throws:
      NotFoundException - auditConstrainerEnablerId is not found
      NullArgumentException - auditConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.