public interface SubscriptionRulesManager extends OsidManager, SubscriptionRulesProfile
The subscription rules manager provides access to subscription rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
SubscriptionEnablerLookupSession:
a session to
retrieve subscription enablers SubscriptionEnablerQuerySession:
a session to
query for subscription enablers SubscriptionEnablerSearchSession:
a session to
search for subscription enablers SubscriptionEnablerAdminSession:
a session to
create and delete subscription enablers SubscriptionEnablerNotificationSession:
a session
to receive notifications pertaining to subscription enabler changes
SubscriptionEnablerPublisherSession:
a session to
look up subscription enabler publisher mappings SubscriptionEnablerPublisherAssignmentSession:
a
session to manage subscription enabler to publisher mappings SubscriptionEnablerSmartPublisherSession:
a
session to manage dynamic publishers of subscription enablers SubscriptionEnablerRuleLookupSession:
a session to
look up subscription enabler to subscription mappings SubscriptionEnablerRuleApplicationSession:
a
session to apply subscription enablers to subscriptions Modifier and Type | Method and Description |
---|---|
SubscriptionEnablerAdminSession |
getSubscriptionEnablerAdminSession()
Gets the
OsidSession associated with the subscription
enabler administration service. |
SubscriptionEnablerAdminSession |
getSubscriptionEnablerAdminSessionForPublisher(Id publisherId)
Gets the
OsidSession associated with the subscription
enabler administration service for the given publisher. |
SubscriptionEnablerLookupSession |
getSubscriptionEnablerLookupSession()
Gets the
OsidSession associated with the subscription
enabler lookup service. |
SubscriptionEnablerLookupSession |
getSubscriptionEnablerLookupSessionForPublisher(Id publisherId)
Gets the
OsidSession associated with the subscription
enabler lookup service for the given publisher. |
SubscriptionEnablerNotificationSession |
getSubscriptionEnablerNotificationSession(SubscriptionEnablerReceiver subscriptionEnablerReceiver)
Gets the
OsidSession associated with the subscription
enabler notification service. |
SubscriptionEnablerNotificationSession |
getSubscriptionEnablerNotificationSessionForPublisher(SubscriptionEnablerReceiver subscriptionEnablerReceiver,
Id publisherId)
Gets the
OsidSession associated with the subscription
enabler notification service for the given publisher. |
SubscriptionEnablerPublisherAssignmentSession |
getSubscriptionEnablerPublisherAssignmentSession()
Gets the
OsidSession associated with assigning
subscription enablers to publishers. |
SubscriptionEnablerPublisherSession |
getSubscriptionEnablerPublisherSession()
Gets the
OsidSession to lookup subscription
enablerpublisher mappings. |
SubscriptionEnablerQuerySession |
getSubscriptionEnablerQuerySession()
Gets the
OsidSession associated with the subscription
enabler query service. |
SubscriptionEnablerQuerySession |
getSubscriptionEnablerQuerySessionForPublisher(Id publisherId)
Gets the
OsidSession associated with the subscription
enabler query service for the given publisher. |
SubscriptionEnablerRuleApplicationSession |
getSubscriptionEnablerRuleApplicationSession()
Gets the
OsidSession associated with the subscription
enabler assignment service to apply enablers to subscriptions. |
SubscriptionEnablerRuleApplicationSession |
getSubscriptionEnablerRuleApplicationSessionForPublisher(Id publisherId)
Gets the
OsidSession associated with the subscription
enabler assignment service for the given subscription to apply
enablers to subscriptions. |
SubscriptionEnablerRuleLookupSession |
getSubscriptionEnablerRuleLookupSession()
Gets the
OsidSession associated with the subscription
enabler mapping lookup service for looking up the rules applied to the
subscription. |
SubscriptionEnablerRuleLookupSession |
getSubscriptionEnablerRuleLookupSessionForPublisher(Id publisherId)
Gets the
OsidSession associated with the subscription
enabler mapping lookup service for the given subscription for looking
up rules applied to a subscription. |
SubscriptionEnablerSearchSession |
getSubscriptionEnablerSearchSession()
Gets the
OsidSession associated with the subscription
enabler search service. |
SubscriptionEnablerSearchSession |
getSubscriptionEnablerSearchSessionForPublisher(Id publisherId)
Gets the
OsidSession associated with the subscription
enablers earch service for the given publisher. |
SubscriptionEnablerSmartPublisherSession |
getSubscriptionEnablerSmartPublisherSession(Id publisherId)
Gets the
OsidSession to manage subscription enabler
smart publishers. |
changeBranch, initialize, rollbackService
close
getSubscriptionEnablerRecordTypes, getSubscriptionEnablerSearchRecordTypes, supportsSubscriptionEnablerAdmin, supportsSubscriptionEnablerLookup, supportsSubscriptionEnablerNotification, supportsSubscriptionEnablerPublisher, supportsSubscriptionEnablerPublisherAssignment, supportsSubscriptionEnablerQuery, supportsSubscriptionEnablerRecordType, supportsSubscriptionEnablerRuleApplication, supportsSubscriptionEnablerRuleLookup, supportsSubscriptionEnablerSearch, supportsSubscriptionEnablerSearchRecordType, supportsSubscriptionEnablerSmartSubscription, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
SubscriptionEnablerLookupSession getSubscriptionEnablerLookupSession() throws OperationFailedException
OsidSession
associated with the subscription
enabler lookup service. SubscriptionEnablerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerLookup()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerLookup()
is
true.
SubscriptionEnablerLookupSession getSubscriptionEnablerLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler lookup service for the given publisher.publisherId
- the Id
of the Publisher
SubscriptionEnablerLookupSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerLookup()
and
supportsVisibleFederation()
are true.
SubscriptionEnablerQuerySession getSubscriptionEnablerQuerySession() throws OperationFailedException
OsidSession
associated with the subscription
enabler query service. SubscriptionEnablerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerQuery()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerQuery()
is true.
SubscriptionEnablerQuerySession getSubscriptionEnablerQuerySessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler query service for the given publisher.publisherId
- the Id
of the Publisher
SubscriptionEnablerQuerySession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerQuery()
and
supportsVisibleFederation()
are true.
SubscriptionEnablerSearchSession getSubscriptionEnablerSearchSession() throws OperationFailedException
OsidSession
associated with the subscription
enabler search service. SubscriptionEnablerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerSearch()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerSearch()
is
true.
SubscriptionEnablerSearchSession getSubscriptionEnablerSearchSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enablers earch service for the given publisher.publisherId
- the Id
of the Publisher
SubscriptionEnablerSearchSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerSearch()
and
supportsVisibleFederation()
are true.
SubscriptionEnablerAdminSession getSubscriptionEnablerAdminSession() throws OperationFailedException
OsidSession
associated with the subscription
enabler administration service. SubscriptionEnablerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerAdmin()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerAdmin()
is true.
SubscriptionEnablerAdminSession getSubscriptionEnablerAdminSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler administration service for the given publisher.publisherId
- the Id
of the Publisher
SubscriptionEnablerAdminSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerAdmin()
and
supportsVisibleFederation()
are true.
SubscriptionEnablerNotificationSession getSubscriptionEnablerNotificationSession(SubscriptionEnablerReceiver subscriptionEnablerReceiver) throws OperationFailedException
OsidSession
associated with the subscription
enabler notification service.subscriptionEnablerReceiver
- the notification callback SubscriptionEnablerNotificationSession
NullArgumentException
-
subscriptionEnablerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerNotification()
is
false
optional
- This method must be implemented if
supportsSubscriptionEnablerNotification()
is
true.
SubscriptionEnablerNotificationSession getSubscriptionEnablerNotificationSessionForPublisher(SubscriptionEnablerReceiver subscriptionEnablerReceiver, Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler notification service for the given publisher.subscriptionEnablerReceiver
- the notification callbackpublisherId
- the Id
of the Publisher
SubscriptionEnablerNotificationSession
NotFoundException
- no publisher found by the given
Id
NullArgumentException
-
subscriptionEnablerReceiver
or publisherId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerNotification()
and
supportsVisibleFederation()
are
true.
SubscriptionEnablerPublisherSession getSubscriptionEnablerPublisherSession() throws OperationFailedException
OsidSession
to lookup subscription
enablerpublisher mappings. SubscriptionEnablerPublisherSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerPublisher()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerPublisher()
is
true.
SubscriptionEnablerPublisherAssignmentSession getSubscriptionEnablerPublisherAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
subscription enablers to publishers. SubscriptionEnablerPublisherAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerPublisherAssignment()
is
false
optional
- This method must be implemented if
supportsSubscriptionEnablerPublisherAssignment()
is true.
SubscriptionEnablerSmartPublisherSession getSubscriptionEnablerSmartPublisherSession(Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
to manage subscription enabler
smart publishers.publisherId
- the Id of the Publisher
SubscriptionEnablerSmartPublisherSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerSmartPublisher()
is
false
optional
- This method must be implemented if
supportsSubscriptionEnablerSmartPublisher()
is
true.
SubscriptionEnablerRuleLookupSession getSubscriptionEnablerRuleLookupSession() throws OperationFailedException
OsidSession
associated with the subscription
enabler mapping lookup service for looking up the rules applied to the
subscription. SubscriptionEnablerRuleSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerRuleLookup()
is
false
optional
- This method must be implemented if
supportsSubscriptionEnablerRuleLookup()
is
true.
SubscriptionEnablerRuleLookupSession getSubscriptionEnablerRuleLookupSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler mapping lookup service for the given subscription for looking
up rules applied to a subscription.publisherId
- the Id
of the Publisher
SubscriptionEnablerRuleLookupSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerRuleLookup()
and
supportsVisibleFederation()
are true.
SubscriptionEnablerRuleApplicationSession getSubscriptionEnablerRuleApplicationSession() throws OperationFailedException
OsidSession
associated with the subscription
enabler assignment service to apply enablers to subscriptions. SubscriptionEnablerRuleApplicationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsSubscriptionEnablerRuleApplication()
is
true.
SubscriptionEnablerRuleApplicationSession getSubscriptionEnablerRuleApplicationSessionForPublisher(Id publisherId) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler assignment service for the given subscription to apply
enablers to subscriptions.publisherId
- the Id
of the Publisher
SubscriptionEnablerRuleApplicationSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerRuleApplication()
and
supportsVisibleFederation()
are
true.