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

This session provides methods to retrieve SubscriptionEnabler to Subscription mappings. A SubscriptionEnabler may appear in multiple Subscription objects. Each subscription 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
MethodcanLookupSubscriptionEnablerPublishertMappings
Description

Tests if this user can perform lookups of subscription 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. This is intended as 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.
MethoduseComparativeSubscriptionEnablerPublisherView
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.
MethodusePlenarySubscriptionEnablerPublisherView
Description

A complete view of the SubscriptionEnabler 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.
MethodgetSubscriptionEnablerIdsByPublisher
Description

Gets the list of SubscriptionEnablerIds associated with a Publisher.

Parametersosid.id.IdpublisherId Id of the Publisher
Returnosid.id.IdListlist of related subscription enabler 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.
MethodgetSubscriptionEnablersByPublisher
Description

Gets the list of subscription enablers associated with a Publisher.

Parametersosid.id.IdpublisherId Id of the Publisher
Returnosid.subscription.rules.SubscriptionEnablerListlist of related subscription enablers
ErrorsNOT_FOUND publisherId is not found
NULL_ARGUMENT publisherId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablerIdsByPublishers
Description

Gets the list of SubscriptionEnabler Ids corresponding to a list of Publishers.

Parametersosid.id.IdListpublisherIdslist of publisher Ids
Returnosid.id.IdListlist of subscription enabler Ids
ErrorsNULL_ARGUMENT familtIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablersByPublishers
Description

Gets the list of subscription enablers corresponding to a list of Publishers.

Parametersosid.id.IdListpublisherIdslist of publisher Ids
Returnosid.subscription.rules.SubscriptionEnablerListlist of subscription enablers
ErrorsNULL_ARGUMENT publisherIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPublisherIdsBySubscriptionEnabler
Description

Gets the Publisher Ids mapped to a SubscriptionEnabler.

Parametersosid.id.IdsubscriptionEnablerId Id of a SubscriptionEnabler
Returnosid.id.IdListlist of publisher Ids
ErrorsNOT_FOUND subscriptionEnablerId is not found
NULL_ARGUMENT subscriptionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionsBySubscriptionEnabler
Description

Gets the publishers mapped to a SubscriptionEnabler.

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