Interface AuditProcessorEnablerInquestSession

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

This session provides methods to retrieve AuditprocessorEnabler to Inquest mappings. An AuditProcessorEnabler may appear in multiple Inquests. Each inque st may have its own authorizations governing who is allowed to look at it.

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

  • Method Details

    • canLookupAuditProcessorEnablerInquestMappings

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

    • useComparativeAuditProcessorEnablerInquestView

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

    • usePlenaryAuditProcessorEnablerInquestView

      void usePlenaryAuditProcessorEnablerInquestView()
      A complete view of the AuditProcessorEnabler and Inquest 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.

    • getAuditProcessorEnablerIdsByInquest

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

    • getAuditProcessorEnablersByInquest

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

    • getAuditProcessorEnablerIdsByInquests

      IdList getAuditProcessorEnablerIdsByInquests(IdList inquestIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of AuditProcessorEnablerIds corresponding to a list of Inquests .
      Parameters:
      inquestIds - list of inquest Ids
      Returns:
      list of audit processor enabler Ids
      Throws:
      NullArgumentException - inquestIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorEnablersByInquests

      AuditProcessorEnablerList getAuditProcessorEnablersByInquests(IdList inquestIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of AuditProcessorEnablers corresponding to a list of Inquests .
      Parameters:
      inquestIds - list of inquest Ids
      Returns:
      list of audit processor enablers
      Throws:
      NullArgumentException - inquestIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInquestIdsByAuditProcessorEnabler

      IdList getInquestIdsByAuditProcessorEnabler(Id auditProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Inquest Ids mapped to an AuditProcessorEnabler .
      Parameters:
      auditProcessorEnablerId - Id of an AuditProcessorEnabler
      Returns:
      list of inquest 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.

    • getInquestsByAuditProcessorEnabler

      InquestList getInquestsByAuditProcessorEnabler(Id auditProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Inquests mapped to an AuditProcessorEnabler .
      Parameters:
      auditProcessorEnablerId - Id of an AuditProcessorEnabler
      Returns:
      list of inquests
      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.