Interface AuditConstrainerInquestSession

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

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

    • canLookupAuditConstrainerInquestMappings

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

    • useComparativeAuditConstrainerInquestView

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

    • usePlenaryAuditConstrainerInquestView

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

    • getAuditConstrainerIdsByInquest

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

    • getAuditConstrainersByInquest

      AuditConstrainerList getAuditConstrainersByInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of AuditConstrainers associated with an Inquest .
      Parameters:
      inquestId - Id of the Inquest
      Returns:
      list of related audit constrainers
      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.

    • getAuditConstrainerIdsByInquests

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

    • getAuditConstrainersByInquests

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

    • getInquestIdsByAuditConstrainer

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

    • getInquestsByAuditConstrainer

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