Interface QueueEnablerAdminSession

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

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

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

The delete operations delete QueueEnablers . To unmap a QueueEnabler from the current FrontOffice , the QueueEnablerFrontOfficeAssignmentSession should be used. These delete operations attempt to remove the QueueEnabler itself thus removing it from all known FrontOffice catalogs.

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

  • 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.

    • canCreateQueueEnablers

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

    • canCreateQueueEnablerWithRecordTypes

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

    • getQueueEnablerFormForCreate

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

    • createQueueEnabler

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

    • canUpdateQueueEnablers

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

    • getQueueEnablerFormForUpdate

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

    • updateQueueEnabler

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

    • canDeleteQueueEnablers

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

    • deleteQueueEnabler

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

    • canManageQueueEnablerAliases

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

    • aliasQueueEnabler

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