Interface QueueResourcingSession

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

This session defines methods for resourcing queues. A more detailed assignment service can be managed through the Resourcing OSID.

Like all OsidSessions, QueueResourcingSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getFrontOfficeId

      Id getFrontOfficeId()
      Gets the FrontOffice Id associated with this session.
      Returns:
      the FrontOffice Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getFrontOffice

      FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
      Gets the FrontOffice associated with this session.
      Returns:
      the front office
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canResourceQueues

      boolean canResourceQueues()
      Tests if this user can assign Resources to queues. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer assignment operations to unauthorized users.
      Returns:
      false if resource assignment methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canResourceQueue

      boolean canResourceQueue(Id queueId)
      Tests if this user can assign Resources to a queue. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer assignment operations to unauthorized users.
      Parameters:
      queueId - the Id of a Queue
      Returns:
      false if resource assignment methods are not authorized, true otherwise
      Throws:
      NullArgumentException - queueId is null
      Compliance:
      mandatory - This method must be implemented.

    • getResources

      ResourceList getResources(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a list of resource assigned in a queue.
      Parameters:
      queueId - the Id of a Queue
      Returns:
      a list of resources
      Throws:
      NotFoundException - queueId is not found
      NullArgumentException - queueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • assignResource

      void assignResource(Id queueId, Id resourceId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Assigns a Resource to a queue.
      Parameters:
      queueId - the Id of a Queue
      resourceId - the Id of the Resource
      Throws:
      AlreadyExistsException - resourceId already assigned to this queue
      NotFoundException - queueId or resourceId not found
      NullArgumentException - queueId or resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignResource

      void unassignResource(Id queueId, Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Unassigns a Resource from this queue.
      Parameters:
      queueId - the Id of a Queue
      resourceId - the Id of the Resource
      Throws:
      NotFoundException - queueId not found or resourceId not assigned to this queue
      NullArgumentException - queueId or resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.