public interface SubscriptionRulesProxyManager extends OsidProxyManager, SubscriptionRulesProfile
The subscription rules proxy manager provides access to subscription
rules sessions and provides interoperability tests for various aspects of
this service. Methods in this manager pass a Proxy
for
passing information from server environments. 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(Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler administration service. |
SubscriptionEnablerAdminSession |
getSubscriptionEnablerAdminSessionForPublisher(Id publisherId,
Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler administration service for the given publisher. |
SubscriptionEnablerLookupSession |
getSubscriptionEnablerLookupSession(Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler lookup service. |
SubscriptionEnablerLookupSession |
getSubscriptionEnablerLookupSessionForPublisher(Id publisherId,
Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler lookup service for the given publisher. |
SubscriptionEnablerNotificationSession |
getSubscriptionEnablerNotificationSession(SubscriptionEnablerReceiver subscriptionEnablerReceiver,
Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler notification service. |
SubscriptionEnablerNotificationSession |
getSubscriptionEnablerNotificationSessionForPublisher(SubscriptionEnablerReceiver subscriptionEnablerReceiver,
Id publisherId,
Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler notification service for the given publisher. |
SubscriptionEnablerPublisherAssignmentSession |
getSubscriptionEnablerPublisherAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning
subscription enablers to publishers |
SubscriptionEnablerPublisherSession |
getSubscriptionEnablerPublisherSession(Proxy proxy)
Gets the
OsidSession to lookup subscription
enabler/publisher mappings for subscription enablers. |
SubscriptionEnablerQuerySession |
getSubscriptionEnablerQuerySession(Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler query service. |
SubscriptionEnablerQuerySession |
getSubscriptionEnablerQuerySessionForPublisher(Id publisherId,
Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler query service for the given publisher. |
SubscriptionEnablerRuleApplicationSession |
getSubscriptionEnablerRuleApplicationSession(Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler assignment service to apply enablers to subscriptions. |
SubscriptionEnablerRuleApplicationSession |
getSubscriptionEnablerRuleApplicationSessionForPublisher(Id publisherId,
Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler assignment service for the given subscription to apply
enablers to subscriptions. |
SubscriptionEnablerRuleLookupSession |
getSubscriptionEnablerRuleLookupSession(Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler mapping lookup service for looking up the rules applied to the
subscription. |
SubscriptionEnablerRuleLookupSession |
getSubscriptionEnablerRuleLookupSessionForPublisher(Id publisherId,
Proxy proxy)
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(Proxy proxy)
Gets the
OsidSession associated with the subscription
enabler search service. |
SubscriptionEnablerSearchSession |
getSubscriptionEnablerSearchSessionForPublisher(Id publisherId,
Proxy proxy)
Gets the
OsidSession associated with the subscription
enablers earch service for the given publisher. |
SubscriptionEnablerSmartPublisherSession |
getSubscriptionEnablerSmartPublisherSession(Id publisherId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the subscription
enabler lookup service.proxy
- a proxy SubscriptionEnablerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerLookup()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerLookup()
is
true.
SubscriptionEnablerLookupSession getSubscriptionEnablerLookupSessionForPublisher(Id publisherId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler lookup service for the given publisher.publisherId
- the Id
of the Publisher
proxy
- a proxy SubscriptionEnablerLookupSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the subscription
enabler query service.proxy
- a proxy SubscriptionEnablerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerQuery()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerQuery()
is true.
SubscriptionEnablerQuerySession getSubscriptionEnablerQuerySessionForPublisher(Id publisherId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler query service for the given publisher.publisherId
- the Id
of the Publisher
proxy
- a proxy SubscriptionEnablerQuerySession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the subscription
enabler search service.proxy
- a proxy SubscriptionEnablerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerSearch()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerSearch()
is
true.
SubscriptionEnablerSearchSession getSubscriptionEnablerSearchSessionForPublisher(Id publisherId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enablers earch service for the given publisher.publisherId
- the Id
of the Publisher
proxy
- a proxy SubscriptionEnablerSearchSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the subscription
enabler administration service.proxy
- a proxy SubscriptionEnablerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerAdmin()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerAdmin()
is true.
SubscriptionEnablerAdminSession getSubscriptionEnablerAdminSessionForPublisher(Id publisherId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler administration service for the given publisher.publisherId
- the Id
of the Publisher
proxy
- a proxy SubscriptionEnablerAdminSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId or proxy 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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the subscription
enabler notification service.subscriptionEnablerReceiver
- the notification callbackproxy
- a proxy SubscriptionEnablerNotificationSession
NullArgumentException
-
subscriptionEnablerReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the subscription
enabler notification service for the given publisher.subscriptionEnablerReceiver
- the notification callbackpublisherId
- the Id
of the Publisher
proxy
- a proxy SubscriptionEnablerNotificationSession
NotFoundException
- no publisher found by the given
Id
NullArgumentException
-
subscriptionEnablerReceiver, publisherId,
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
to lookup subscription
enabler/publisher mappings for subscription enablers.proxy
- a proxy SubscriptionEnablerSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerPublisher()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerPublisher()
is
true.
SubscriptionEnablerPublisherAssignmentSession getSubscriptionEnablerPublisherAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning
subscription enablers to publishersproxy
- a proxy SubscriptionEnablerPublisherAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerPublisherAssignment()
is
false
optional
- This method must be implemented if
supportsSubscriptionEnablerPublisherAssignment()
is true.
SubscriptionEnablerSmartPublisherSession getSubscriptionEnablerSmartPublisherSession(Id publisherId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage subscription enabler
smart publishers.publisherId
- the Id
of the Publisher
proxy
- a proxy SubscriptionEnablerSmartPublisherSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerSmartPublisher()
is
false
optional
- This method must be implemented if
supportsSubscriptionEnablerSmarPublisher()
is
true.
SubscriptionEnablerRuleLookupSession getSubscriptionEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the subscription
enabler mapping lookup service for looking up the rules applied to the
subscription.proxy
- a proxy SubscriptionEnablerRuleLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerRuleLookup()
is
false
optional
- This method must be implemented if
supportsSubscriptionEnablerRuleLookup()
is
true.
SubscriptionEnablerRuleLookupSession getSubscriptionEnablerRuleLookupSessionForPublisher(Id publisherId, Proxy proxy) 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
proxy
- a proxy SubscriptionEnablerRuleLookupSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the subscription
enabler assignment service to apply enablers to subscriptions.proxy
- a proxy SubscriptionEnablerRuleApplicationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsSubscriptionEnablerRuleApplication()
is
true.
SubscriptionEnablerRuleApplicationSession getSubscriptionEnablerRuleApplicationSessionForPublisher(Id publisherId, Proxy proxy) 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
proxy
- a proxy SubscriptionEnablerRuleApplicationSession
NotFoundException
- no Publisher
found
by the given Id
NullArgumentException
- publisherId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubscriptionEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubscriptionEnablerRuleApplication()
and
supportsVisibleFederation()
are
true.