Interface QueueConstrainerEnablerAdminSession

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

This session creates, updates, and deletes QueueConstrainerEnablers . 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 QueueConstrainerEnabler , a QueueConstrainerEnablerForm is requested using getQueueConstrainerEnablerFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned QueueConstrainerEnablerForm 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 QueueConstrainerEnablerForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each QueueConstrainerEnablerForm corresponds to an attempted transaction.

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

The delete operations delete QueueConstrainerEnablers . To unmap a QueueConstrainerEnabler from the current Distributor , the QueueConstrainerEnablerDistributorAssignmentSession should be used. These delete operations attempt to remove the QueueConstrainerEnabler 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.

    • canCreateQueueConstrainerEnablers

      boolean canCreateQueueConstrainerEnablers()
      Tests if this user can create QueueConstrainerEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a QueueConstrainerEnabler 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 QueueConstrainerEnabler creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateQueueConstrainerEnablerWithRecordTypes

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

    • getQueueConstrainerEnablerFormForCreate

      QueueConstrainerEnablerForm getQueueConstrainerEnablerFormForCreate(Type[] queueConstrainerEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the queue constrainer enabler form for creating new queue constrainer enablers. A new form should be requested for each create transaction.
      Parameters:
      queueConstrainerEnablerRecordTypes - array of queue constrainer enabler record types
      Returns:
      the queue constrainer enabler form
      Throws:
      NullArgumentException - queueConstrainerEnablerRecordTypes 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.

    • createQueueConstrainerEnabler

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

    • canUpdateQueueConstrainerEnablers

      boolean canUpdateQueueConstrainerEnablers()
      Tests if this user can update QueueConstrainerEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a QueueConstrainerEnabler 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 QueueConstrainerEnabler modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerEnablerFormForUpdate

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

    • updateQueueConstrainerEnabler

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

    • canDeleteQueueConstrainerEnablers

      boolean canDeleteQueueConstrainerEnablers()
      Tests if this user can delete QueueConstrainerEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a QueueConstrainerEnabler 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 QueueConstrainerEnabler deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteQueueConstrainerEnabler

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

    • canManageQueueConstrainerEnablerAliases

      boolean canManageQueueConstrainerEnablerAliases()
      Tests if this user can manage Id aliases for QueueConstrainerEnablers 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 QueueConstrainerEnabler aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasQueueConstrainerEnabler

      void aliasQueueConstrainerEnabler(Id queueConstrainerEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to a QueueConstrainerEnabler for the purpose of creating compatibility. The primary Id of the QueueConstrainerEnabler 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 enabler, it is reassigned to the given queue constrainer enabler Id.
      Parameters:
      queueConstrainerEnablerId - the Id of a QueueConstrainerEnabler
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - queueConstrainerEnablerId not found
      NullArgumentException - queueConstrainerEnablerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.