Interface AuditConstrainerEnablerInquestAssignmentSession

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

This session provides methods to re-assign AuditConstrainerEnabler to Inquest mappings. An AuditConstrainerEnabler may appear in multiple Inquest catalogs and removing the last reference to an AuditConstrainerEnabler 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 AuditConstrainerEnabler to another Inquest is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignAuditConstrainerEnablers

      boolean canAssignAuditConstrainerEnablers()
      Tests if this user can alter audit constrainer enabler/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.

    • canAssignAuditConstrainerEnablerToInquest

      boolean canAssignAuditConstrainerEnablerToInquest(Id inquestId)
      Tests if this user can alter audit constrainer enabler/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 enabler 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.

    • getAssignableInquestIdsForAuditConstrainerEnabler

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

    • assignAuditConstrainerEnablerToInquest

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

    • unassignAuditConstrainerEnablerFromInquest

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

    • reassignAuditConstrainerEnablerToInquest

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