org.osid.subscription.rules

Interface SubscriptionRulesManager

All Superinterfaces:

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

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                                                     throws OperationFailedException

Gets the OsidSession associated with the subscription enabler lookup service.

Returns:

a SubscriptionEnablerLookupSession

Throws:

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)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

Returns:

a SubscriptionEnablerLookupSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId 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()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the subscription enabler query service.

Returns:

a SubscriptionEnablerQuerySession

Throws:

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)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

Returns:

a SubscriptionEnablerQuerySession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId 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()
                                                                     throws OperationFailedException

Gets the OsidSession associated with the subscription enabler search service.

Returns:

a SubscriptionEnablerSearchSession

Throws:

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)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

Returns:

a SubscriptionEnablerSearchSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId 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()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the subscription enabler administration service.

Returns:

a SubscriptionEnablerAdminSession

Throws:

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)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

publisherId - the Id of the Publisher

Returns:

a SubscriptionEnablerAdminSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId 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)
                                                                                 throws OperationFailedException

Gets the OsidSession associated with the subscription enabler notification service.

Parameters:

subscriptionEnablerReceiver - the notification callback

Returns:

a SubscriptionEnablerNotificationSession

Throws:

NullArgumentException - subscriptionEnablerReceiver 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)
                                                                                             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

Returns:

a SubscriptionEnablerNotificationSession

Throws:

NotFoundException - no publisher found by the given Id

NullArgumentException - subscriptionEnablerReceiver or publisherId 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()
                                                                           throws OperationFailedException

Gets the OsidSession to lookup subscription enablerpublisher mappings.

Returns:

a SubscriptionEnablerPublisherSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerPublisher() is false

Compliance:

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

getSubscriptionEnablerPublisherAssignmentSession

SubscriptionEnablerPublisherAssignmentSession getSubscriptionEnablerPublisherAssignmentSession()
                                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning subscription enablers to publishers.

Returns:

a SubscriptionEnablerPublisherAssignmentSession

Throws:

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)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

Gets the OsidSession to manage subscription enabler smart publishers.

Parameters:

publisherId - the Id of the Publisher

Returns:

a SubscriptionEnablerSmartPublisherSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubscriptionEnablerSmartPublisher() is false

Compliance:

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

getSubscriptionEnablerRuleLookupSession

SubscriptionEnablerRuleLookupSession getSubscriptionEnablerRuleLookupSession()
                                                                             throws OperationFailedException

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

Returns:

a SubscriptionEnablerRuleSession

Throws:

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)
                                                                                         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

Returns:

a SubscriptionEnablerRuleLookupSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId 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()
                                                                                       throws OperationFailedException

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

Returns:

a SubscriptionEnablerRuleApplicationSession

Throws:

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)
                                                                                                   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

Returns:

a SubscriptionEnablerRuleApplicationSession

Throws:

NotFoundException - no Publisher found by the given Id

NullArgumentException - publisherId 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.