Interface QueueConstrainerFrontOfficeAssignmentSession

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

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

  • Method Details

    • canAssignQueueConstrainers

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

    • canAssignQueueConstrainersToFrontOffice

      boolean canAssignQueueConstrainersToFrontOffice(Id frontOfficeId)
      Tests if this user can alter queue constrainer/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 constrainer 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.

    • getAssignableFrontOfficeIdsForQueueConstrainer

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

    • assignQueueConstrainerToFrontOffice

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

    • unassignQueueConstrainerFromFrontOffice

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

    • reassignQueueConstrainerToFrontOffice

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