public interface SubscriptionPublisherSession extends OsidSession
This session provides methods to retrieve Subscription
to Publisher
mappings. A Subscription
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSubscriptionPublisherMappings()
Tests if this user can perform lookups of subscription/publisher
mappings.
|
IdList |
getPublisherIdsBySubscription(Id subscriptionId)
Gets the list of
Publisher Ids mapped to
a Subscription. |
PublisherList |
getPublishersBySubscription(Id subscriptionId)
Gets the list of
Publisher objects mapped to a
Subscription. |
IdList |
getSubscriptionIdsByPublisher(Id publisherId)
Gets the list of
Subscription Ids
associated with a Publisher. |
IdList |
getSubscriptionIdsByPublishers(IdList publisherIds)
Gets the list of
Subscription Ids corresponding to a
list of Publisher objects. |
SubscriptionList |
getSubscriptionsByPublisher(Id publisherId)
Gets the list of
Subscriptions associated with a
Publisher. |
SubscriptionList |
getSubscriptionsByPublishers(IdList publisherIds)
Gets the list of
Subscriptions corresponding to a list
of Publishers. |
void |
useComparativePublisherView()
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 |
usePlenaryPublisherView()
A complete view of the
Subscription and
Publisher returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSubscriptionPublisherMappings()
PERMISSION_DENIED.
This is intendedas 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 useComparativePublisherView()
mandatory
- This method is must be implemented. void usePlenaryPublisherView()
Subscription
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 getSubscriptionIdsByPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Subscription
Ids
associated with a Publisher.
publisherId
- Id
of a Subscription
Ids
NotFoundException
- publisherId
is not
foundNullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionList getSubscriptionsByPublisher(Id publisherId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Subscriptions
associated with a
Publisher.
publisherId
- Id
of a Subscription
NotFoundException
- publisherId
is not
foundNullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSubscriptionIdsByPublishers(IdList publisherIds) throws OperationFailedException, PermissionDeniedException
Subscription Ids
corresponding to a
list of Publisher
objects.publisherIds
- list of publisher Ids
Ids
NullArgumentException
- publisherIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionList getSubscriptionsByPublishers(IdList publisherIds) throws OperationFailedException, PermissionDeniedException
Subscriptions
corresponding to a list
of Publishers.
publisherIds
- list of publisher Ids
NullArgumentException
- publisherIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPublisherIdsBySubscription(Id subscriptionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Publisher
Ids
mapped to
a Subscription.
subscriptionId
- Id
of a Subscription
Ids
NotFoundException
- subscriptionId
is
not foundNullArgumentException
- subscriptionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PublisherList getPublishersBySubscription(Id subscriptionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Publisher
objects mapped to a
Subscription.
subscriptionId
- Id
of a Subscription
NotFoundException
- subscriptionId
is
not foundNullArgumentException
- subscriptionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.