Interface DispatchProcessorAdminSession

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

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

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

The delete operations delete DispatchProcessors . To unmap a DispatchProcessor from the current Publisher , the DispatchProcessorPublisherAssignmentSession should be used. These delete operations attempt to remove the DispatchProcessor itself thus removing it from all known Publisher catalogs.

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

  • Method Details

    • getPublisherId

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

    • getPublisher

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

    • canCreateDispatchProcessors

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

    • canCreateDispatchProcessorWithRecordTypes

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

    • getDispatchProcessorFormForCreate

      DispatchProcessorForm getDispatchProcessorFormForCreate(Type[] dispatchProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the dispatch processor form for creating new dispatch processors. A new form should be requested for each create transaction.
      Parameters:
      dispatchProcessorRecordTypes - array of dispatch processor record types
      Returns:
      the dispatch processor form
      Throws:
      NullArgumentException - dispatchProcessorRecordTypes 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.

    • createDispatchProcessor

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

    • canUpdateDispatchProcessors

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

    • getDispatchProcessorFormForUpdate

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

    • updateDispatchProcessor

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

    • canDeleteDispatchProcessors

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

    • deleteDispatchProcessor

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

    • canManageDispatchProcessorAliases

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

    • aliasDispatchProcessor

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