org.osid.subscription.rules

Interface SubscriptionRulesProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable, SubscriptionRulesProfile

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.subscription.rules.SubscriptionRulesProfile

getSubscriptionEnablerRecordTypes, getSubscriptionEnablerSearchRecordTypes, supportsSubscriptionEnablerAdmin, supportsSubscriptionEnablerLookup, supportsSubscriptionEnablerNotification, supportsSubscriptionEnablerPublisher, supportsSubscriptionEnablerPublisherAssignment, supportsSubscriptionEnablerQuery, supportsSubscriptionEnablerRecordType, supportsSubscriptionEnablerRuleApplication, supportsSubscriptionEnablerRuleLookup, supportsSubscriptionEnablerSearch, supportsSubscriptionEnablerSearchRecordType, supportsSubscriptionEnablerSmartSubscription, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getSubscriptionEnablerLookupSession

SubscriptionEnablerLookupSession getSubscriptionEnablerLookupSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the subscription enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a SubscriptionEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerLookup() is true.

getSubscriptionEnablerLookupSessionForPublisher

SubscriptionEnablerLookupSession getSubscriptionEnablerLookupSessionForPublisher(Id publisherId,
                                                                               Proxy proxy)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession associated with the subscription enabler lookup service for the given publisher.

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionEnablerLookupSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerLookup() and supportsVisibleFederation() are true.

getSubscriptionEnablerQuerySession

SubscriptionEnablerQuerySession getSubscriptionEnablerQuerySession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the subscription enabler query service.

Parameters:

proxy - a proxy

Returns:

a SubscriptionEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerQuery() is true.

getSubscriptionEnablerQuerySessionForPublisher

SubscriptionEnablerQuerySession getSubscriptionEnablerQuerySessionForPublisher(Id publisherId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession associated with the subscription enabler query service for the given publisher.

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionEnablerQuerySession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerQuery() and supportsVisibleFederation() are true.

getSubscriptionEnablerSearchSession

SubscriptionEnablerSearchSession getSubscriptionEnablerSearchSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the subscription enabler search service.

Parameters:

proxy - a proxy

Returns:

a SubscriptionEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerSearch() is true.

getSubscriptionEnablerSearchSessionForPublisher

SubscriptionEnablerSearchSession getSubscriptionEnablerSearchSessionForPublisher(Id publisherId,
                                                                               Proxy proxy)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession associated with the subscription enablers earch service for the given publisher.

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionEnablerSearchSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerSearch() and supportsVisibleFederation() are true.

getSubscriptionEnablerAdminSession

SubscriptionEnablerAdminSession getSubscriptionEnablerAdminSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the subscription enabler administration service.

Parameters:

proxy - a proxy

Returns:

a SubscriptionEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerAdmin() is true.

getSubscriptionEnablerAdminSessionForPublisher

SubscriptionEnablerAdminSession getSubscriptionEnablerAdminSessionForPublisher(Id publisherId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession associated with the subscription enabler administration service for the given publisher.

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionEnablerAdminSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerAdmin() and supportsVisibleFederation() are true.

getSubscriptionEnablerNotificationSession

SubscriptionEnablerNotificationSession getSubscriptionEnablerNotificationSession(SubscriptionEnablerReceiver subscriptionEnablerReceiver,
                                                                               Proxy proxy)
                                                                                 throws OperationFailedException

Gets the OsidSession associated with the subscription enabler notification service.

Parameters:

subscriptionEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a SubscriptionEnablerNotificationSession

Throws:

NullArgumentException - subscriptionEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerNotification() is true.

getSubscriptionEnablerNotificationSessionForPublisher

SubscriptionEnablerNotificationSession getSubscriptionEnablerNotificationSessionForPublisher(SubscriptionEnablerReceiver subscriptionEnablerReceiver,
                                                                                           Id publisherId,
                                                                                           Proxy proxy)
                                                                                             throws NotFoundException,
                                                                                                    OperationFailedException

Gets the OsidSession associated with the subscription enabler notification service for the given publisher.

Parameters:

subscriptionEnablerReceiver - the notification callback

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionEnablerNotificationSession

Throws:

NotFoundException - no publisher found by the given Id

NullArgumentException - subscriptionEnablerReceiver, publisherId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerNotification() and supportsVisibleFederation() are true.

getSubscriptionEnablerPublisherSession

SubscriptionEnablerPublisherSession getSubscriptionEnablerPublisherSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the OsidSession to lookup subscription enabler/publisher mappings for subscription enablers.

Parameters:

proxy - a proxy

Returns:

a SubscriptionEnablerSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerPublisher() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerPublisher() is true.

getSubscriptionEnablerPublisherAssignmentSession

SubscriptionEnablerPublisherAssignmentSession getSubscriptionEnablerPublisherAssignmentSession(Proxy proxy)
                                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning subscription enablers to publishers

Parameters:

proxy - a proxy

Returns:

a SubscriptionEnablerPublisherAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerPublisherAssignment() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerPublisherAssignment() is true.

getSubscriptionEnablerSmartPublisherSession

SubscriptionEnablerSmartPublisherSession getSubscriptionEnablerSmartPublisherSession(Id publisherId,
                                                                                   Proxy proxy)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

Gets the OsidSession to manage subscription enabler smart publishers.

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionEnablerSmartPublisherSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerSmartPublisher() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerSmarPublisher() is true.

getSubscriptionEnablerRuleLookupSession

SubscriptionEnablerRuleLookupSession getSubscriptionEnablerRuleLookupSession(Proxy proxy)
                                                                             throws OperationFailedException

Gets the OsidSession associated with the subscription enabler mapping lookup service for looking up the rules applied to the subscription.

Parameters:

proxy - a proxy

Returns:

a SubscriptionEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerRuleLookup() is true.

getSubscriptionEnablerRuleLookupSessionForPublisher

SubscriptionEnablerRuleLookupSession getSubscriptionEnablerRuleLookupSessionForPublisher(Id publisherId,
                                                                                       Proxy proxy)
                                                                                         throws NotFoundException,
                                                                                                OperationFailedException

Gets the OsidSession associated with the subscription enabler mapping lookup service for the given subscription for looking up rules applied to a subscription.

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionEnablerRuleLookupSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerRuleLookup() and supportsVisibleFederation() are true.

getSubscriptionEnablerRuleApplicationSession

SubscriptionEnablerRuleApplicationSession getSubscriptionEnablerRuleApplicationSession(Proxy proxy)
                                                                                       throws OperationFailedException

Gets the OsidSession associated with the subscription enabler assignment service to apply enablers to subscriptions.

Parameters:

proxy - a proxy

Returns:

a SubscriptionEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerRuleApplication() is true.

getSubscriptionEnablerRuleApplicationSessionForPublisher

SubscriptionEnablerRuleApplicationSession getSubscriptionEnablerRuleApplicationSessionForPublisher(Id publisherId,
                                                                                                 Proxy proxy)
                                                                                                   throws NotFoundException,
                                                                                                          OperationFailedException

Gets the OsidSession associated with the subscription enabler assignment service for the given subscription to apply enablers to subscriptions.

Parameters:

publisherId - the Id of the Publisher

proxy - a proxy

Returns:

a SubscriptionEnablerRuleApplicationSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionEnablerRuleApplication() and supportsVisibleFederation() are true.