Interface AuditProcessorInquestAssignmentSession

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

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

  • Method Details

    • canAssignAuditProcessors

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

    • canAssignAuditProcessorToInquest

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

    • getAssignableInquestIdsForAuditProcessor

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

    • assignAuditProcessorToInquest

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

    • unassignAuditProcessorFromInquest

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

    • reassignAuditProcessorToInquest

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