Interface AuditProcessorEnablerInquestAssignmentSession

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

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

  • Method Details

    • canAssignAuditProcessorEnablers

      boolean canAssignAuditProcessorEnablers()
      Tests if this user can alter audit processor 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.

    • canAssignAuditProcessorEnablerToInquest

      boolean canAssignAuditProcessorEnablerToInquest(Id inquestId)
      Tests if this user can alter audit processor 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 processor 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.

    • getAssignableInquestIdsForAuditProcessorEnabler

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

    • assignAuditProcessorEnablerToInquest

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

    • unassignAuditProcessorEnablerFromInquest

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

    • reassignAuditProcessorEnablerToInquest

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