Interface QueueEnablerFrontOfficeAssignmentSession

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

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

  • Method Details

    • canAssignQueueEnablers

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

    • canAssignQueueEnablerToFrontOffice

      boolean canAssignQueueEnablerToFrontOffice(Id frontOfficeId)
      Tests if this user can alter queue enabler/front 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. T his is intended as a hint to an application that may opt not to offer assignment 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 offices including and under the given front office node in which any queue enabler 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.

    • getAssignableFrontOfficeIdsForQueueEnabler

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

    • assignQueueEnablerToFrontOffice

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

    • unassignQueueEnablerFromFrontOffice

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

    • reassignQueueEnablerToFrontOffice

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