Interface DispatchConstrainerPublisherSession

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

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

    • canLookupDispatchConstrainerPublisherMappings

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

    • useComparativeDispatchConstrainerPublisherView

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

    • usePlenaryDispatchConstrainerPublisherView

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

    • getDispatchConstrainerIdsByPublisher

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

    • getDispatchConstrainersByPublisher

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

    • getDispatchConstrainerIdsByPublishers

      IdList getDispatchConstrainerIdsByPublishers(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 constrainer Ids
      Throws:
      NullArgumentException - publisherIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchConstrainersByPublishers

      DispatchConstrainerList getDispatchConstrainersByPublishers(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 constrainers
      Throws:
      NullArgumentException - publisherIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPublisherIdsByDispatchConstrainer

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

    • getPublishersByDispatchConstrainer

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