Interface AuditConstrainerInquestAssignmentSession

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

This session provides methods to re-assign AuditConstrainer to Inquest mappings. An AuditConstrainer may appear in multiple Inquest catalogs and removing the last reference to an AuditConstrainer is the equivalent of deleting it. Each Inquest may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an AuditConstrainer to another Inquest is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignAuditConstrainers

      boolean canAssignAuditConstrainers()
      Tests if this user can alter audit constrainer/inquest mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignAuditConstrainerToInquest

      boolean canAssignAuditConstrainerToInquest(Id inquestId)
      Tests if this user can alter audit constrainer/inquest mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.
      Parameters:
      inquestId - the Id of the Inquest
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - inquestId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableInquestIds

      IdList getAssignableInquestIds(Id inquestId) throws OperationFailedException
      Gets a list of inquests including and under the given inquest node in which any audit constrainer can be assigned.
      Parameters:
      inquestId - the Id of the Inquest
      Returns:
      list of assignable inquest Ids
      Throws:
      NullArgumentException - inquestId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableInquestIdsForAuditConstrainer

      IdList getAssignableInquestIdsForAuditConstrainer(Id inquestId, Id auditConstrainerId) throws OperationFailedException
      Gets a list of inquests including and under the given inquest node in which a specific audit constrainer can be assigned.
      Parameters:
      inquestId - the Id of the Inquest
      auditConstrainerId - the Id of the AuditConstrainer
      Returns:
      list of assignable inquest Ids
      Throws:
      NullArgumentException - inquestId or auditConstrainerId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignAuditConstrainerToInquest

      void assignAuditConstrainerToInquest(Id auditConstrainerId, Id inquestId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing AuditConstrainer to an Inquest .
      Parameters:
      auditConstrainerId - the Id of the AuditConstrainer
      inquestId - the Id of the Inquest
      Throws:
      AlreadyExistsException - auditConstrainerId is already assigned to inquestId
      NotFoundException - auditConstrainerId or inquestId not found
      NullArgumentException - auditConstrainerId or inquestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignAuditConstrainerFromInquest

      void unassignAuditConstrainerFromInquest(Id auditConstrainerId, Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes an AuditConstrainer from an Inquest .
      Parameters:
      auditConstrainerId - the Id of the AuditConstraienr
      inquestId - the Id of the Inquest
      Throws:
      NotFoundException - auditConstrainerId or inquestId not found or auditConstrainerId not assigned to inquestId
      NullArgumentException - auditConstrainerId or inquestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignAuditConstrainerToInquest

      void reassignAuditConstrainerToInquest(Id auditConstrainerId, Id fromInquestId, Id toInquestId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves an AuditConstrainer from one Inquest to another. Mappings to other Inquests are unaffected.
      Parameters:
      auditConstrainerId - the Id of the AuditConstrainer
      fromInquestId - the Id of the current Inquest
      toInquestId - the Id of the destination Inquest
      Throws:
      AlreadyExistsException - auditConstrainerId already assigned to toInquestId
      NotFoundException - auditConstrainerId, fromInquestId , or toInquestId not found or auditConstrainerId not mapped to fromInquestId
      NullArgumentException - auditConstrainerId, fromInquestId , or toInquestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.