Interface DispatchProcessorEnablerPublisherSession

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

This session provides methods to retrieve DispatchprocessorEnabler to Publisher mappings. A DispatchProcessorEnabler 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

    • canLookupDispatchProcessorEnablerPublisherMappings

      boolean canLookupDispatchProcessorEnablerPublisherMappings()
      Tests if this user can perform lookups of dispatch processor enabler/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.

    • useComparativeDispatchProcessorEnablerPublisherView

      void useComparativeDispatchProcessorEnablerPublisherView()
      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.

    • usePlenaryDispatchProcessorEnablerPublisherView

      void usePlenaryDispatchProcessorEnablerPublisherView()
      A complete view of the DispatchProcessorEnabler 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.

    • getDispatchProcessorEnablerIdsByPublisher

      IdList getDispatchProcessorEnablerIdsByPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of DispatchProcessorEnablerIds associated with a Publisher .
      Parameters:
      publisherId - Id of the Publisher
      Returns:
      list of related dispatch processor enabler 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.

    • getDispatchProcessorEnablersByPublisher

      DispatchProcessorEnablerList getDispatchProcessorEnablersByPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of DispatchProcessorEnablers associated with a Publisher .
      Parameters:
      publisherId - Id of the Publisher
      Returns:
      list of related dispatch processor enablers
      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.

    • getDispatchProcessorEnablerIdsByPublishers

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

    • getDispatchProcessorEnablersByPublishers

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

    • getPublisherIdsByDispatchProcessorEnabler

      IdList getPublisherIdsByDispatchProcessorEnabler(Id dispatchProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Publisher Ids mapped to a DispatchProcessorEnabler .
      Parameters:
      dispatchProcessorEnablerId - Id of a DispatchProcessorEnabler
      Returns:
      list of publisher Ids
      Throws:
      NotFoundException - dispatchProcessorEnablerId is not found
      NullArgumentException - dispatchProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPublishersByDispatchProcessorEnabler

      PublisherList getPublishersByDispatchProcessorEnabler(Id dispatchProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Publishers mapped to a DispatchProcessorEnabler .
      Parameters:
      dispatchProcessorEnablerId - Id of a DispatchProcessorEnabler
      Returns:
      list of publishers
      Throws:
      NotFoundException - dispatchProcessorEnablerId is not found
      NullArgumentException - dispatchProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.