public interface SubscriptionEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve SubscriptionEnabler
to Subscription
mappings. A Subscription
with multiple SubscriptionEnablers
means any
positive rule evaluation across the enablers result in an enabled
Subscription.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSubscriptionEnablerRules()
Tests if this user can perform lookups of subscription
enabler/subscription mappings.
|
Publisher |
getPublisher()
Gets the
Publisher associated with this session. |
Id |
getPublisherId()
Gets the
Publisher Id associated with
this session. |
IdList |
getSubscriptionEnablerIdsForSubscription(Id subscriptionId)
Gets the
SubscriptionEnabler Id associated with a
Subscription. |
SubscriptionEnablerList |
getSubscriptionEnablersForSubscription(Id subscriptionId)
Gets the
SubscriptionEnabler associated with a
Subscription. |
IdList |
getSubscriptionIdsBySubscriptionEnabler(Id subscriptionEnablerId)
Gets the
Subscription Ids mapped to a
SubscriptionEnabler. |
SubscriptionList |
getSubscriptionsBySubscriptionEnabler(Id subscriptionEnablerId)
Gets the
Subscriptions mapped to a
SubscriptionEnabler. |
void |
useComparativeSubscriptionEnablerRuleView()
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 |
useFederatedPublisherView()
Federates the view for methods in this session.
|
void |
useIsolatedPublisherView()
Isolates the view for methods in this session.
|
void |
usePlenarySubscriptionEnablerRuleView()
A complete view of the
SubscriptionEnabler and
Subscription returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPublisherId()
Publisher
Id
associated with
this session. Publisher Id
associated with this sessionmandatory
- This method must be implemented. Publisher getPublisher() throws OperationFailedException, PermissionDeniedException
Publisher
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupSubscriptionEnablerRules()
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 useComparativeSubscriptionEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenarySubscriptionEnablerRuleView()
SubscriptionEnabler
and
Subscription
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. void useFederatedPublisherView()
mandatory
- This method is must be implemented. void useIsolatedPublisherView()
mandatory
- This method is must be implemented. IdList getSubscriptionEnablerIdsForSubscription(Id subscriptionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnabler Id
associated with a
Subscription.
subscriptionId
- Id
of the Subscription
Ids
NotFoundException
- subscriptionId
is
not foundNullArgumentException
- subscriptionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionEnablerList getSubscriptionEnablersForSubscription(Id subscriptionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionEnabler
associated with a
Subscription.
subscriptionId
- Id
of the Subscription
NotFoundException
- subscriptionId
is
not foundNullArgumentException
- subscriptionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSubscriptionIdsBySubscriptionEnabler(Id subscriptionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Subscription
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. SubscriptionList getSubscriptionsBySubscriptionEnabler(Id subscriptionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Subscriptions
mapped to a
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.