Interface QueueConstrainerAdminSession

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

This session creates, updates, and deletes QueueConstrainers . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a QueueConstrainer , a QueueConstrainerForm is requested using getQueueConstrainerFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned QueueConstrainerForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the QueueConstrainerForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each QueueConstrainerForm corresponds to an attempted transaction.

For updates, QueueConstrainerForms are requested to the QueueConstrainer Id that is to be updated using getQueueConstrainerFormForUpdate() . Similarly, the QueueConstrainerForm has metadata about the data that can be updated and it can perform validation before submitting the update. The QueueConstrainerForm can only be used once for a successful update and cannot be reused.

The delete operations delete QueueConstrainers . To unmap a QueueConstrainer from the current Distributor , the QueueConstrainerDistributorAssignmentSession should be used. These delete operations attempt to remove the QueueConstrainer itself thus removing it from all known Distributor catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id .

  • Method Details

    • getDistributorId

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

    • getDistributor

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

    • canCreateQueueConstrainers

      boolean canCreateQueueConstrainers()
      Tests if this user can create QueueConstrainers . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a QueueConstrainer will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
      Returns:
      false if QueueConstrainer creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateQueueConstrainerWithRecordTypes

      boolean canCreateQueueConstrainerWithRecordTypes(Type[] queueConstrainerRecordTypes)
      Tests if this user can create a single QueueConstrainer using the desired record types. While ProvisioningRulesManager.getQueueConstrainerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific QueueConstrainer . Providing an empty array tests if a QueueConstrainer can be cr eated with no records.
      Parameters:
      queueConstrainerRecordTypes - array of queue constrainer record types
      Returns:
      true if QueueConstrainer creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - queueConstrainerRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerFormForCreate

      QueueConstrainerForm getQueueConstrainerFormForCreate(Type[] queueConstrainerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the queue constrainer form for creating new queue constrainers. A new form should be requested for each create transaction.
      Parameters:
      queueConstrainerRecordTypes - array of queue constrainer record types
      Returns:
      the queue constrainer form
      Throws:
      NullArgumentException - queueConstrainerRecordTypes is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - unable to get form for requested record types
      Compliance:
      mandatory - This method must be implemented.

    • createQueueConstrainer

      QueueConstrainer createQueueConstrainer(QueueConstrainerForm queueConstrainerForm) throws OperationFailedException, PermissionDeniedException
      Creates a new QueueConstrainer .
      Parameters:
      queueConstrainerForm - the form for this QueueConstrainer
      Returns:
      the new QueueConstrainer
      Throws:
      IllegalStateException - queueConstrainerForm already used in a create transaction
      InvalidArgumentException - one or more of the form elements is invalid
      NullArgumentException - queueConstrainerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueConstrainerForm did not originate from getQueueConstrainerFormForCreate()
      Compliance:
      mandatory - This method must be implemented.

    • canUpdateQueueConstrainers

      boolean canUpdateQueueConstrainers()
      Tests if this user can update QueueConstrainers . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a QueueConstrainer will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
      Returns:
      false if QueueConstrainer modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerFormForUpdate

      QueueConstrainerForm getQueueConstrainerFormForUpdate(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the queue constrainer form for updating an existing queue constrainer. A new queue constrainer form should be requested for each update transaction.
      Parameters:
      queueConstrainerId - the Id of the QueueConstrainer
      Returns:
      the queue form
      Throws:
      NotFoundException - queueConstrainerId is not found
      NullArgumentException - queueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateQueueConstrainer

      void updateQueueConstrainer(QueueConstrainerForm queueConstrainerForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing queue constrainer.
      Parameters:
      queueConstrainerForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - queueConstrainerForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - queueConstrainerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueConstrainerForm did not originate from getQueueConstrainerFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteQueueConstrainers

      boolean canDeleteQueueConstrainers()
      Tests if this user can delete QueueConstrainers . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a QueueConstrainer will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
      Returns:
      false if QueueConstrainer deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteQueueConstrainer

      void deleteQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes a QueueConstrainer .
      Parameters:
      queueConstrainerId - the Id of the QueueConstrainer to remove
      Throws:
      NotFoundException - queueConstrainerId not found
      NullArgumentException - queueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageQueueConstrainerAliases

      boolean canManageQueueConstrainerAliases()
      Tests if this user can manage Id aliases for QueueConstrainers A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
      Returns:
      false if QueueConstrainer aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasQueueConstrainer

      void aliasQueueConstrainer(Id queueConstrainerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to a QueueConstrainer for the purpose of creating compatibility. The primary Id of the QueueConstrainer is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another queue constrainer, it is reassigned to the given queue constrainer Id .
      Parameters:
      queueConstrainerId - the Id of a QueueConstrainer
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - queueConstrainerId not found
      NullArgumentException - queueConstrainerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.