Interface DispatchProcessorEnablerPublisherAssignmentSession

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

This session provides methods to re-assign DispatchProcessorEnabler to Publisher mappings. A DispatchProcessorEnabler may appear in multiple Publisher catalogs and removing the last reference to a DispatchProcessorEnabler is the equivalent of deleting it. Each Publisher may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a DispatchProcessorEnabler to another Publisher is n ot a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignDispatchProcessorEnablers

      boolean canAssignDispatchProcessorEnablers()
      Tests if this user can alter dispatch processor enabler/publisher mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignDispatchProcessorEnablerToPublisher

      boolean canAssignDispatchProcessorEnablerToPublisher(Id publisherId)
      Tests if this user can alter dispatch processor enabler/publisher mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - publisherId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignablePublisherIds

      IdList getAssignablePublisherIds(Id publisherId) throws OperationFailedException
      Gets a list of publishers including and under the given publisher node in which any dispatch processor enabler can be assigned.
      Parameters:
      publisherId - the Id of the Publisher
      Returns:
      list of assignable publisher Ids
      Throws:
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignablePublisherIdsForDispatchProcessorEnabler

      IdList getAssignablePublisherIdsForDispatchProcessorEnabler(Id publisherId, Id dispatchProcessorEnablerId) throws OperationFailedException
      Gets a list of publishers including and under the given publisher node in which a specific dispatch processor enabler can be assigned.
      Parameters:
      publisherId - the Id of the Publisher
      dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler
      Returns:
      list of assignable publisher Ids
      Throws:
      NullArgumentException - publisherId or dispatchProcessorEnablerId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignDispatchProcessorEnablerToPublisher

      void assignDispatchProcessorEnablerToPublisher(Id dispatchProcessorEnablerId, Id publisherId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing DispatchProcessorEnabler to a Publisher .
      Parameters:
      dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler
      publisherId - the Id of the Publisher
      Throws:
      AlreadyExistsException - dispatchProcessorEnablerId is already assigned to publisherId
      NotFoundException - dispatchProcessorEnablerId or publisherId not found
      NullArgumentException - dispatchProcessorEnablerId or publisherId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignDispatchProcessorEnablerFromPublisher

      void unassignDispatchProcessorEnablerFromPublisher(Id dispatchProcessorEnablerId, Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a DispatchProcessorEnabler from a Publisher .
      Parameters:
      dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler
      publisherId - the Id of the Publisher
      Throws:
      NotFoundException - dispatchProcessorEnablerId or publisherId not found or dispatchProcessorEnablerId not assigned to publisherId
      NullArgumentException - dispatchProcessorEnablerId or publisherId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignDispatchProcessorEnablerToPublisher

      void reassignDispatchProcessorEnablerToPublisher(Id dispatchProcessorEnablerId, Id fromPublisherId, Id toPublisherId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a DispatchProcessorEnabler from one Publisher to another. Mappings to other Publishers are unaffected.
      Parameters:
      dispatchProcessorEnablerId - the Id of the DispatchProcessorEnabler
      fromPublisherId - the Id of the current Publisher
      toPublisherId - the Id of the destination Publisher
      Throws:
      AlreadyExistsException - dispatchProcessorEnablerId already assigned to toPublisherId
      NotFoundException - dispatchProcessorEnablerId, fromPublisherId , or toPublisherId not found or dispatchProcessorEnablerId not mapped to fromPublisherId
      NullArgumentException - dispatchProcessorEnablerId, fromPublisherId , or toPublisherId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.