OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.DispatchPublisherSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Dispatch to Publisher mappings. A Dispatch may appear in multiple Publishers. 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
MethodcanLookupDispatchPublisherMappings
Description

Tests if this user can perform lookups of dispatch/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. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativePublisherView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryPublisherView
Description

A complete view of the Dispatch 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.

CompliancemandatoryThis method is must be implemented.
MethodgetDispatchIdsByPublisher
Description

Gets the list of Dispatch Ids associated with a Publisher.

Parametersosid.id.IdpublisherId Id of a Publisher
Returnosid.id.IdListlist of related dispatch Ids
ErrorsNOT_FOUND publisherId is not found
NULL_ARGUMENT publisherId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDispatchesByPublisher
Description

Gets the list of Dispatches associated with a Publisher.

Parametersosid.id.IdpublisherId Id of a Publisher
Returnosid.subscription.DispatchListlist of related dispatches
ErrorsNOT_FOUND publisherId is not found
NULL_ARGUMENT publisherId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDispatchIdsByPublishers
Description

Gets the list of Dispatch Ids corresponding to a list of Publisher objects.

Parametersosid.id.IdListpublisherIdslist of publisher Ids
Returnosid.id.IdListlist of dispatch Ids
ErrorsNULL_ARGUMENT publisherIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDispatchesByPublishers
Description

Gets the list of Dispatches corresponding to a list of Publishers.

Parametersosid.id.IdListpublisherIdslist of publisher Ids
Returnosid.subscription.DispatchListlist of dispatches
ErrorsNULL_ARGUMENT publisherIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPublisherIdsByDispatch
Description

Gets the list of Publisher Ids mapped to a Dispatch.

Parametersosid.id.IddispatchId Id of a Dispatch
Returnosid.id.IdListlist of publisher Ids
ErrorsNOT_FOUND dispatchId is not found
NULL_ARGUMENT dispatchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPublishersByDispatch
Description

Gets the list of Publisher objects mapped to a Dispatch.

Parametersosid.id.IddispatchId Id of a Dispatch
Returnosid.subscription.PublisherListlist of publishers
ErrorsNOT_FOUND dispatchId is not found
NULL_ARGUMENT dispatchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.