Interface QueueProcessorFrontOfficeAssignmentSession

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

This session provides methods to re-assign QueueProcessor to FrontOffice mappings. a QueueProcessor may appear in multiple FrontOffice objects and removing the last reference to a QueueProcessor is the equivalent of deleting it. Each FrontOffice may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a QueueProcessor to another FrontOffice is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignQueueProcessors

      boolean canAssignQueueProcessors()
      Tests if this user can alter queue processor/office 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 . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignQueueProcessorsToFrontOffice

      boolean canAssignQueueProcessorsToFrontOffice(Id frontOfficeId)
      Tests if this user can alter queue processor/office 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 . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - frontOfficeId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableFrontOfficeIds

      IdList getAssignableFrontOfficeIds(Id frontOfficeId) throws OperationFailedException
      Gets a list of front office including and under the given front office node in which any queue processor can be assigned.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      list of assignable front office Ids
      Throws:
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableFrontOfficeIdsForQueueProcessor

      IdList getAssignableFrontOfficeIdsForQueueProcessor(Id frontOfficeId, Id queueProcessorId) throws OperationFailedException
      Gets a list of front office including and under the given front office node in which a specific queue processor can be assigned.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      queueProcessorId - the Id of the QueueProcessor
      Returns:
      list of assignable front office Ids
      Throws:
      NullArgumentException - frontOfficeId or queueProcessorId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignQueueProcessorToFrontOffice

      void assignQueueProcessorToFrontOffice(Id queueProcessorId, Id frontOfficeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing QueueProcessor to a FrontFront Office .
      Parameters:
      queueProcessorId - the Id of the QueueProcessor
      frontOfficeId - the Id of the FrontOffice
      Throws:
      AlreadyExistsException - queueProcessorId is already assigned to frontOfficeId
      NotFoundException - queueProcessorId or frontOfficeId not found
      NullArgumentException - queueProcessorId or frontOfficeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignQueueProcessorFromFrontOffice

      void unassignQueueProcessorFromFrontOffice(Id queueProcessorId, Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a QueueProcessor from a FrontFront Office .
      Parameters:
      queueProcessorId - the Id of the QueueProcessor
      frontOfficeId - the Id of the FrontOffice
      Throws:
      NotFoundException - queueProcessorId or frontOfficeId not found or queueProcessorId not assigned to frontOfficeId
      NullArgumentException - queueProcessorId or frontOfficeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignQueueProcessorToFrontOffice

      void reassignQueueProcessorToFrontOffice(Id queueProcessorId, Id fromFrontOfficeId, Id toFrontOfficeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a QueueProcessor from one FrontOffice to another. Mappings to other FrontOffices are unaffected.
      Parameters:
      queueProcessorId - the Id of the QueueProcessor
      fromFrontOfficeId - the Id of the current FrontOffice
      toFrontOfficeId - the Id of the destination FrontOffice
      Throws:
      AlreadyExistsException - queueProcessorId already assigned to toFrontOfficeId
      NotFoundException - queueProcessorId, fromFrontOfficeId , or toFrontOfficeId not found or queueProcessorId not mapped to fromFrontOfficeId
      NullArgumentException - queueProcessorId, fromFrontOfficeId , or toFrontOfficeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.