Interface DispatchConstrainerEnablerPublisherSession

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

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

    • canLookupDispatchConstrainerEnablerPublisherMappings

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

    • useComparativeDispatchConstrainerEnablerPublisherView

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

    • usePlenaryDispatchConstrainerEnablerPublisherView

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

    • getDispatchConstrainerEnablerIdsByPublisher

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

    • getDispatchConstrainerEnablersByPublisher

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

    • getDispatchConstrainerEnablerIdsByPublishers

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

    • getDispatchConstrainerEnablersByPublishers

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

    • getPublisherIdsByDispatchConstrainerEnabler

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

    • getPublishersByDispatchConstrainerEnabler

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