Interface DispatchProcessorPublisherSession

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

This session provides methods to retrieve DispatchProcessor to Publisher mappings. A DispatchProcessor may appear in multiple Publishers. Each pub lisher may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupDispatchProcessorPublisherMappings

      boolean canLookupDispatchProcessorPublisherMappings()
      Tests if this user can perform lookups of dispatch processor/publisher mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeDispatchProcessorPublisherView

      void useComparativeDispatchProcessorPublisherView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryDispatchProcessorPublisherView

      void usePlenaryDispatchProcessorPublisherView()
      A complete view of the DispatchProcessor and Publisher returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getDispatchProcessorIdsByPublisher

      IdList getDispatchProcessorIdsByPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of DispatchProcessorIds associated with a Publisher .
      Parameters:
      publisherId - Id of the Publisher
      Returns:
      list of related dispatch processor Ids
      Throws:
      NotFoundException - publisherId is not found
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorsByPublisher

      DispatchProcessorList getDispatchProcessorsByPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of DispatchProcessors associated with a Publisher .
      Parameters:
      publisherId - Id of the Publisher
      Returns:
      list of related dispatch processors
      Throws:
      NotFoundException - publisherId is not found
      NullArgumentException - publisherId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorIdsByPublishers

      IdList getDispatchProcessorIdsByPublishers(IdList publisherIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of DispatchConstrainerIds corresponding to a list of Publishers .
      Parameters:
      publisherIds - list of publisher Ids
      Returns:
      list of dispatch processor Ids
      Throws:
      NullArgumentException - publisherIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorsByPublishers

      DispatchProcessorList getDispatchProcessorsByPublishers(IdList publisherIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of DispatchConstrainers corresponding to a list of Publishers .
      Parameters:
      publisherIds - list of publisher Ids
      Returns:
      list of dispatch processors
      Throws:
      NullArgumentException - publisherIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPublisherIdsByDispatchProcessor

      IdList getPublisherIdsByDispatchProcessor(Id dispatchProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Publisher Ids mapped to a DispatchProcessor .
      Parameters:
      dispatchProcessorId - Id of a DispatchProcessor
      Returns:
      list of publisher Ids
      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.

    • getPublishersByDispatchProcessor

      PublisherList getPublishersByDispatchProcessor(Id dispatchProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Publishers mapped to a DispatchConstrainer .
      Parameters:
      dispatchProcessorId - Id of a DispatchProcessor
      Returns:
      list of publishers
      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.