com.webmethods.portal.bizPolicy.biz.meta.subscription

Interface ISubscriptionPolicy

All Superinterfaces:

IBizPolicy, IComponent, IInitializable, ISystemHandler, IViewablePolicy

public interface ISubscriptionPolicy
extends IViewablePolicy

Exposes a variety of policies on basic metadata things.

Method Summary

Modifier and Type	Method and Description
IThingID	createAppCriteriaFolder(IContext context, String folderName, String layout, String description) Create a folder for a specified type of application criteria
IThingID	createAppCriterion(IContext context, IThingID appCriteriaFolderID, String criterionName, String criterionInfo, String operationName, int operationCode, String property) create a criterion within the specified criteria folder
IThingID	createPortletSubscription(IContext context, IThingID subscriberPortlet, IThingID source, ICriterion crit) Create a subscription for the portlet specified to receive notifications
IThingIDList	getAppCriteria(IContext context, String criteriaFolderName) Get a list of criteria with specified criteria folder name.
IThingID	getUserSubscription(IContext context, IThingID userID, IThingID sourceID) Returns subscription thingID for the user on the given source object.
IThingID	SetGroupSubscription(IContext context, IThingID thingID, IThingID ownerID, IThingID groupID, int deliveryMethods, IThingIDList criteriaIDs) Set a group subscription on the specified resource
IThingID	SetGroupSubscription(IContext context, IThingID thingID, IThingID ownerID, IThingID groupID, int deliveryMethods, IThingIDList criteriaIDs, boolean isRecursive) Set a group subscription on the specified resource
IThingID	SetSubscription(IContext context, IThingID resourceID, int deliveryMethods, IThingIDList criteriaIDs) Set a subscription on the specified resource for the current user.
IThingID	SetSubscription(IContext context, IThingID resourceID, int deliveryMethods, IThingIDList criteriaIDs, boolean recursive) Set a subscription on the specified resource for the current user.
IThingID	SetSubscription(IContext context, IThingID resourceID, IThingID userID, int deliveryMethods, IThingIDList criteriaIDs) Set a subscription on the specified resource for the specfied user.
IThingID	SetSubscription(IContext context, IThingID resourceID, IThingID userID, int deliveryMethods, IThingIDList criteriaIDs, boolean recursive) Set a subscription on the specified resource for the specfied user.
void	unsubscribe(IContext context, IThingID subscriptionID) Delete a subscription

Methods inherited from interface com.webmethods.portal.bizPolicy.biz.view.IViewablePolicy

getIcon, getPagingCookie, getPagingCookie, pageBackward, pageForeward, setPagingCookie, view

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Detail

SetSubscription

IThingID SetSubscription(IContext context,
                         IThingID resourceID,
                         int deliveryMethods,
                         IThingIDList criteriaIDs)
                  throws BizException

Set a subscription on the specified resource for the current user.

Parameters:

context - The user's portal context IContext

resourceID - The thingID of the resource to be subscribed to

deliveryMethods - ISubscription

criteriaIDs - A thing ID list of the application criteria

Returns:

thingID of the created subscription

Throws:

BizException

SetSubscription

IThingID SetSubscription(IContext context,
                         IThingID resourceID,
                         IThingID userID,
                         int deliveryMethods,
                         IThingIDList criteriaIDs)
                  throws BizException

Set a subscription on the specified resource for the specfied user.

Parameters:

context - The user's portal context IContext

resourceID - The thingID of the resource to be subscribed to

userID - User for whom to set the subscription.

deliveryMethods - ISubscription

criteriaIDs - A thing ID list of the application criteria

Returns:

thingID of the created subscription

Throws:

BizException

SetSubscription

IThingID SetSubscription(IContext context,
                         IThingID resourceID,
                         int deliveryMethods,
                         IThingIDList criteriaIDs,
                         boolean recursive)
                  throws BizException

Set a subscription on the specified resource for the current user.

Parameters:

context - The user's portal context IContext

resourceID - The thingID of the resource to be subscribed to

deliveryMethods - ISubscription

criteriaIDs - A thing ID list of the application criteria

recursive - If this is a recursive subscription

Returns:

thingID of the created subscription

Throws:

BizException

SetSubscription

IThingID SetSubscription(IContext context,
                         IThingID resourceID,
                         IThingID userID,
                         int deliveryMethods,
                         IThingIDList criteriaIDs,
                         boolean recursive)
                  throws BizException

Set a subscription on the specified resource for the specfied user.

Parameters:

context - The user's portal context IContext

resourceID - The thingID of the resource to be subscribed to

userID - User for whom to set the subscription.

deliveryMethods - ISubscription

criteriaIDs - A thing ID list of the application criteria

recursive - If this is a recursive subscription@@

Returns:

thingID of the created subscription

Throws:

BizException

SetGroupSubscription

IThingID SetGroupSubscription(IContext context,
                              IThingID thingID,
                              IThingID ownerID,
                              IThingID groupID,
                              int deliveryMethods,
                              IThingIDList criteriaIDs)
                       throws BizException

Set a group subscription on the specified resource

Parameters:

context - The user's portal context IContext

thingID - The thingID of the resource to be subscribed to

ownerID - The owner's thingID of the subscription

groupID - The group's thingID of this subscription that will receive the notifications

deliveryMethods - ISubscription

criteriaIDs - A thing ID list of the application criteria

Returns:

thingID of the created subscription

Throws:

BizException

SetGroupSubscription

IThingID SetGroupSubscription(IContext context,
                              IThingID thingID,
                              IThingID ownerID,
                              IThingID groupID,
                              int deliveryMethods,
                              IThingIDList criteriaIDs,
                              boolean isRecursive)
                       throws BizException

Set a group subscription on the specified resource

Parameters:

context - The user's portal context IContext

thingID - The thingID of the resource to be subscribed to

ownerID - The owner's thingID of the subscription

groupID - The group's thingID of this subscription that will receive the notifications

deliveryMethods - ISubscription

criteriaIDs - A thing ID list of the application criteria

Returns:

thingID of the created subscription

Throws:

BizException

createPortletSubscription

IThingID createPortletSubscription(IContext context,
                                   IThingID subscriberPortlet,
                                   IThingID source,
                                   ICriterion crit)
                            throws BizException

Create a subscription for the portlet specified to receive notifications

Parameters:

context - The user's portal context IContext

subscriberPortlet - The portlet to receive 'thing' notifcations

source - The resource

crit - The criterion e.g ICriterion crit = new Criterion(IPortalEvent.OPERATION_NO_OP, IPortalEvent.STATUS_SUCCESS);

Returns:

IThingID

Throws:

BizException

unsubscribe

void unsubscribe(IContext context,
                 IThingID subscriptionID)
          throws BizException

Delete a subscription

Parameters:

context - The user's portal contextIContext

subscriptionID - The thingID of the subscription to be unsubscribed

Throws:

BizException

getUserSubscription

IThingID getUserSubscription(IContext context,
                             IThingID userID,
                             IThingID sourceID)
                      throws BizException

Returns subscription thingID for the user on the given source object.

Parameters:

context -

userID -

sourceID -

Returns:

Null if user is not subscribed for the given source object

Throws:

BizException

createAppCriteriaFolder

IThingID createAppCriteriaFolder(IContext context,
                                 String folderName,
                                 String layout,
                                 String description)
                          throws BizException

Create a folder for a specified type of application criteria

Parameters:

context - The user's portal context IContext

folderName - The name of the folder that will contain all the related criteria

layout - The rendering layout for notification template

description - The description of the folder

Returns:

The folder thingID created by this API

Throws:

BizException

createAppCriterion

IThingID createAppCriterion(IContext context,
                            IThingID appCriteriaFolderID,
                            String criterionName,
                            String criterionInfo,
                            String operationName,
                            int operationCode,
                            String property)
                     throws BizException

create a criterion within the specified criteria folder

Parameters:

context - The user's portal context IContext

appCriteriaFolderID - The thingID of the application criteria folder

criterionName - The name of the criterion to be created

criterionInfo - The information of the criterion to be created

operationName - The operation name of the criterion

operationCode - The operation code of the criterion

property - The property name of the criterion

Returns:

The thingID of the criterion created

Throws:

BizException

getAppCriteria

IThingIDList getAppCriteria(IContext context,
                            String criteriaFolderName)
                     throws BizException

Get a list of criteria with specified criteria folder name.

Parameters:

context - The user's portal context IContext

criteriaFolderName - { @link ICriterionTypeName } contains a list of default criterion types

Returns:

IThingIDList contains the thingIDs of the criteria under the specified folder name

Throws:

BizException