Interface QueueProcessorEnablerAdminSession

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

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

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

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

    • canCreateQueueProcessorEnablers

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

    • canCreateQueueProcessorEnablerWithRecordTypes

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

    • getQueueProcessorEnablerFormForCreate

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

    • createQueueProcessorEnabler

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

    • canUpdateQueueProcessorEnablers

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

    • getQueueProcessorEnablerFormForUpdate

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

    • updateQueueProcessorEnabler

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

    • canDeleteQueueProcessorEnablers

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

    • deleteQueueProcessorEnabler

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

    • canManageQueueProcessorEnablerAliases

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

    • aliasQueueProcessorEnabler

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