public interface SubscriptionEnablerPublisherSession extends OsidSession
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSubscriptionEnablerPublishertMappings()
Tests if this user can perform lookups of subscription
enabler/publisher mappings.
|
IdList |
getPublisherIdsBySubscriptionEnabler(Id subscriptionEnablerId)
Gets the
Publisher Ids mapped to a
SubscriptionEnabler. |
IdList |
getSubscriptionEnablerIdsByPublisher(Id publisherId)
Gets the list of
SubscriptionEnablerIds associated with
a Publisher. |
IdList |
getSubscriptionEnablerIdsByPublishers(IdList publisherIds)
Gets the list of
SubscriptionEnabler Ids corresponding
to a list of Publishers. |
SubscriptionEnablerList |
getSubscriptionEnablersByPublisher(Id publisherId)
Gets the list of subscription enablers associated with a
Publisher. |
SubscriptionEnablerList |
getSubscriptionEnablersByPublishers(IdList publisherIds)
Gets the list of subscription enablers corresponding to a list of
Publishers. |
PublisherList |
getSubscriptionsBySubscriptionEnabler(Id subscriptionEnablerId)
Gets the publishers mapped to a
SubscriptionEnabler. |
void |
useComparativeSubscriptionEnablerPublisherView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenarySubscriptionEnablerPublisherView()
A complete view of the
SubscriptionEnabler and
Publisher returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSubscriptionEnablerPublishertMappings()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSubscriptionEnablerPublisherView()
mandatory
- This method is must be implemented. void usePlenarySubscriptionEnablerPublisherView()
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.mandatory
- This method is must be implemented. IdList getSubscriptionEnablerIdsByPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnablerIds
associated with
a Publisher.
publisherId
- Id
of the Publisher
Ids
NotFoundException
- publisherId
is not
foundNullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionEnablerList getSubscriptionEnablersByPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Publisher.
publisherId
- Id
of the Publisher
NotFoundException
- publisherId
is not
foundNullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSubscriptionEnablerIdsByPublishers(IdList publisherIds) throws OperationFailedException, PermissionDeniedException
SubscriptionEnabler Ids
corresponding
to a list of Publishers.
publisherIds
- list of publisher Ids
Ids
NullArgumentException
- familtIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionEnablerList getSubscriptionEnablersByPublishers(IdList publisherIds) throws OperationFailedException, PermissionDeniedException
Publishers.
publisherIds
- list of publisher Ids
NullArgumentException
- publisherIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPublisherIdsBySubscriptionEnabler(Id subscriptionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Publisher
Ids
mapped to a
SubscriptionEnabler.
subscriptionEnablerId
- Id
of a
SubscriptionEnabler
Ids
NotFoundException
- subscriptionEnablerId
is not foundNullArgumentException
- subscriptionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PublisherList getSubscriptionsBySubscriptionEnabler(Id subscriptionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnabler.
subscriptionEnablerId
- Id
of a
SubscriptionEnabler
NotFoundException
- subscriptionEnablerId
is not foundNullArgumentException
- subscriptionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.