Interface AuditConstrainerEnablerInquestSession

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

This session provides methods to retrieve AuditConstrainerEnabler to Inquest mappings. An AuditConstrainerEnabler 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

    • canLookupAuditConstrainerEnablerInquestMappings

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

    • useComparativeAuditConstrainerEnablerInquestView

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

    • usePlenaryAuditConstrainerEnablerInquestView

      void usePlenaryAuditConstrainerEnablerInquestView()
      A complete view of the AuditConstrainerEnabler 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.

    • getAuditConstrainerEnablerIdsByInquest

      IdList getAuditConstrainerEnablerIdsByInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of AuditConstrainerEnablerIds associated with an Inquest .
      Parameters:
      inquestId - Id of the Inquest
      Returns:
      list of related audit constrainer 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.

    • getAuditConstrainerEnablersByInquest

      AuditConstrainerEnablerList getAuditConstrainerEnablersByInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of AuditConstrainerEnablers associated with an Inquest .
      Parameters:
      inquestId - Id of the Inquest
      Returns:
      list of related audit constrainer 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.

    • getAuditConstrainerEnablerIdsByInquests

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

    • getAuditConstrainerEnablersByInquests

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

    • getInquestIdsByAuditConstrainerEnabler

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

    • getInquestsByAuditConstrainerEnabler

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