Interface DispatchEnablerPublisherSession

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

This session provides methods to retrieve DispatchEnabler to Publisher mappings. A DispatchEnabler may appear in multiple Publisher objects . Each publisher 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

    • canLookupDispatchEnablerPublisherMappings

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

    • useComparativeDispatchEnablerPublisherView

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

    • usePlenaryDispatchEnablerPublisherView

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

    • getDispatchEnablerIdsByPublisher

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

    • getDispatchEnablersByPublisher

      DispatchEnablerList getDispatchEnablersByPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of DispatchEnablers associated with a Publisher .
      Parameters:
      publisherId - Id of the Publisher
      Returns:
      list of related dispatch 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.

    • getDispatchEnablerIdsByPublishers

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

    • getDispatchEnablersByPublishers

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

    • getPublisherIdsByDispatchEnabler

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

    • getPublishersByDispatchEnabler

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