Interface QueueConstrainerEnablerDistributorAssignmentSession

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

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

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

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

  • Method Details

    • canAssignQueueConstrainerEnablers

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

    • canAssignQueueConstrainerEnablerToDistributor

      boolean canAssignQueueConstrainerEnablerToDistributor(Id distributorId)
      Tests if this user can alter queue constrainer enabler/distributor 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:
      distributorId - the Id of the Distributor
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - distributorId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableDistributorIds

      IdList getAssignableDistributorIds(Id distributorId) throws OperationFailedException
      Gets a list of distributors including and under the given distributor node in which any queue constrainer enabler can be assigned.
      Parameters:
      distributorId - the Id of the Distributor
      Returns:
      list of assignable distributor Ids
      Throws:
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableDistributorIdsForQueueConstrainerEnabler

      IdList getAssignableDistributorIdsForQueueConstrainerEnabler(Id distributorId, Id queueConstrainerEnablerId) throws OperationFailedException
      Gets a list of distributors including and under the given distributor node in which a specific queue constrainer enabler can be assigned.
      Parameters:
      distributorId - the Id of the Distributor
      queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler
      Returns:
      list of assignable distributor Ids
      Throws:
      NullArgumentException - distributorId or queueConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignQueueConstrainerEnablerToDistributor

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

    • unassignQueueConstrainerEnablerFromDistributor

      void unassignQueueConstrainerEnablerFromDistributor(Id queueConstrainerEnablerId, Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a QueueConstrainerEnabler from a Distributor.
      Parameters:
      queueConstrainerEnablerId - the Id of the QueueConstraienrEnabler
      distributorId - the Id of the Distributor
      Throws:
      NotFoundException - queueConstrainerEnablerId or distributorId not found or queueConstrainerEnablerId not assigned to distributorId
      NullArgumentException - queueConstrainerEnablerId or distributorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignQueueConstrainerEnablerToDistributor

      void reassignQueueConstrainerEnablerToDistributor(Id queueConstrainerEnablerId, Id fromDistributorId, Id toDistributorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a QueueConstrainerEnabler from one Distributor to another. Mappings to other Distributors are unaffected.
      Parameters:
      queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler
      fromDistributorId - the Id of the current Distributor
      toDistributorId - the Id of the destination Distributor
      Throws:
      AlreadyExistsException - queueConstrainerEnablerId already assigned to toDistributorId
      NotFoundException - queueConstrainerEnablerId, fromDistributorId, or toDistributorId not found or queueConstrainerEnablerId not mapped to fromDistributorId
      NullArgumentException - queueConstrainerEnablerId, fromDistributorId, or toDistributorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.