Interface DispatchProcessorPublisherAssignmentSession

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

This session provides methods to re-assign DispatchProcessor to Publisher mappings. A DispatchProcessor may appear in multiple Publisher catalogs and removing the last reference to a DispatchProcessor 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 DispatchProcessor to another Publisher is n ot a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignDispatchProcessors

      boolean canAssignDispatchProcessors()
      Tests if this user can alter dispatch processor/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.

    • canAssignDispatchProcessorToPublisher

      boolean canAssignDispatchProcessorToPublisher(Id publisherId)
      Tests if this user can alter dispatch processor/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 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.

    • getAssignablePublisherIdsForDispatchProcessor

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

    • assignDispatchProcessorToPublisher

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

    • unassignDispatchProcessorFromPublisher

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

    • reassignDispatchProcessorToPublisher

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