Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

wt.notify
Interface NotificationManager

All Known Implementing Classes:
StandardNotificationManager
public interface NotificationManager

NotificationManager provides client invokable methods to notification services. These methods are executed on the server side. The methods support manipulation and execution of the notification rules and lists.

Supported API: true

Extendable: false

Method Summary
 wt.notify.NotificationRule addNotificationRule(wt.admin.Selector selector, NotificationSet set)
          Deprecated.  
 void createNotificationRule(AdminDomainRef domain_ref, String type_id, String event_key, Vector principal_refs)
          Creates a notification rule defining which users and groups should be notified when a specified event occurs for an object of a specified type, within a domain.
 wt.notify.CompositeNotificationSubscription createObjectSubscription(wt.notify.NotificationSubscription subscriptionAttributes, wt.notify.NotifySubscriptionRecipient subscriber, Notifiable targetObject, HashMap<String,wt.fc.WTStringMap> eventKeysAndAttributeValueMaps, boolean subscribeAllVersions)
          Creates a new object instance subscription.
 wt.notify.CompositeNotificationSubscription createObjectSubscriptions(wt.notify.NotificationSubscription subscriptionAttributes, WTCollection subscribers, WTCollection targetObjects, HashMap<String,wt.fc.WTStringMap> eventKeysAndAttributeValueMaps, boolean subscribeAllVersions)
          Creates a new object instance subscription.
 wt.notify.CompositeNotificationSubscription createTypeBasedContainerSubscriptions(wt.notify.NotificationSubscription subscriptionAttributes, WTCollection subscribers, WTCollection targetContainers, ArrayList<String> targetTypes, HashMap<String,wt.fc.WTStringMap> eventKeysAndAttributeValueMaps)
          Creates type-based Container subscriptions.
 wt.notify.CompositeNotificationSubscription createTypeBasedFolderSubscriptions(wt.notify.NotificationSubscription subscriptionAttributes, WTCollection subscribers, WTCollection targetFolders, ArrayList<String> targetTypes, HashMap<String,wt.fc.WTStringMap> eventKeysAndAttributeValueMaps, boolean includeSubfolders)
          Creates type-based Folder subscriptions.
 void deleteNotificationRule(AdminDomainRef domain_ref, String type_id, String event_key)
          Deletes a notification rule defining which users and groups should be notified when a specified event occurs for an object of a specified type, within a domain.
 void deleteSubscription(wt.notify.NotificationSubscription subscription)
          Deletes a subscription represented by the input NotificationSubscription object and also deletes all of its associated subscription recipients and subscription targets (the NotifySubscriptionRecipient and NotifySubscritpionTarget objects).
 void deleteSubscription(ObjectReference subscriptionRef)
          Deletes a subscription represented by the input NotificationSubscription object and also deletes all of its associated subscription recipients and subscription targets (the NotifySubscriptionRecipient and NotifySubscritpionTarget objects).
 void deleteSubscriptions(WTSet subscriptions)
          Deletes the subscriptions represented by the list of input NotificationSubscription objects and also deletes each subscription's associated subscription recipients and subscription targets (the NotifySubscriptionRecipient and NotifySubscritpionTarget objects).
 wt.notify.CompositeNotificationSubscription getNotificationSubscription(ObjectIdentifier subscriptionOID, wt.notify.NotificationSubscription.CheckAccess checkAccess)
          Returns the CompositeNotificationSubscription that matched the input NotificationSubscription OID.
 Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(Notifiable target, Persistable subscriber, String eventKey, String subscriptionKey)
          Returns a collection containing the CompositeNotificationSubscriptions that matched the input search criteria.
 Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(Notifiable target, String eventKey, Persistable subscriber, wt.notify.NotificationSubscription.SubscriberRole subscriberRole, wt.notify.NotificationSubscription.IncludeOwnerRefSubscriber includeOwnerRefSubscriber, wt.notify.NotificationSubscription.IncludeSubscribersParentGroups includeSubscribersParentGroups, wt.notify.NotificationSubscription.SubscriberType returnSubscriberType, wt.notify.NotificationSubscription.DeliveryMethod deliveryMethod, String subscriptionKey, wt.notify.NotificationSubscription.AddTargetMetaData addTargetMetaData, wt.notify.NotificationSubscription.CheckAccess checkAccess)
          Returns a collection containing the CompositeNotificationSubscriptions that matched the input search criteria.
 Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(ObjectReference targetRef, ObjectReference subscriberRef, String eventKey, String subscriptionKey)
          Returns a collection containing the CompositeNotificationSubscriptions that matched the input search criteria.
 Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(ObjectReference targetRef, String eventKey, ObjectReference subscriberRef, wt.notify.NotificationSubscription.SubscriberRole subscriberRole, wt.notify.NotificationSubscription.IncludeOwnerRefSubscriber includeOwnerRefSubscriber, wt.notify.NotificationSubscription.IncludeSubscribersParentGroups includeSubscribersParentGroups, wt.notify.NotificationSubscription.SubscriberType returnSubscriberType, wt.notify.NotificationSubscription.DeliveryMethod deliveryMethod, String subscriptionKey, wt.notify.NotificationSubscription.AddTargetMetaData addTargetMetaData, wt.notify.NotificationSubscription.CheckAccess checkAccess)
          Returns a collection containing the CompositeNotificationSubscriptions that matched the input search criteria.
 Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(String subscriptionName, wt.notify.NotificationSubscription.CheckAccess checkAccess)
          Returns a collection containing the CompositeNotificationSubscriptions that matched the input subscription name.
 Collection<wt.notify.CompositeNotificationSubscription> getSubscriptionsForTarget(Notifiable target, boolean includeAllTargets)
          Returns the collection of subscriptions for the input target object reference.
 Collection<wt.notify.CompositeNotificationSubscription> getSubscriptionsForTarget(ObjectReference targetRef, boolean includeAllTargets)
          Returns the collection of subscriptions for the input target object reference.
 void unsubscribe(wt.notify.NotificationSubscription subscription, Persistable subscriber, boolean deleteSubscription)
          Unsubscribes the subscriber specified by the subscriber paramater from the subscription specified by the subscription parameter.
 void unsubscribe(ObjectReference subscriptionRef, WTReference subscriberRef, boolean deleteSubscription)
          Unsubscribes the subscriber object specified by the subscriberRef paramater from the subscription specified by the subscriptionRef parameter.
 void updateNotificationLists(wt.admin.Selector selector)
          Deprecated.  
 void updateNotificationRule(AdminDomainRef domain_ref, String type_id, String event_key, Vector principal_refs)
          Updates a notification rule defining which users and groups should be notified when a specified event occurs for an object of a specified type, within a domain.
 

Method Detail

createNotificationRule

void createNotificationRule(AdminDomainRef domain_ref,
                            String type_id,
                            String event_key,
                            Vector principal_refs)
                            throws WTException
Creates a notification rule defining which users and groups should be notified when a specified event occurs for an object of a specified type, within a domain.

Supported API: true

Parameters:
domain_ref - reference to the domain the rule is for
type_id - logical or persisted type identifier
event_key - event key (defined in the wt.admin.adminEventResource resource bundle)
principal_refs - principal references for notification recipients (Vector of WTPrincipalReference)
Throws:
WTException

deleteNotificationRule

void deleteNotificationRule(AdminDomainRef domain_ref,
                            String type_id,
                            String event_key)
                            throws WTException
Deletes a notification rule defining which users and groups should be notified when a specified event occurs for an object of a specified type, within a domain.

Supported API: true

Parameters:
domain_ref - reference to the domain the rule is for
type_id - logical or persisted type identifier
event_key - event key (defined in the wt.admin.adminEventResource resource bundle)
Throws:
WTException

updateNotificationRule

void updateNotificationRule(AdminDomainRef domain_ref,
                            String type_id,
                            String event_key,
                            Vector principal_refs)
                            throws WTException
Updates a notification rule defining which users and groups should be notified when a specified event occurs for an object of a specified type, within a domain.

Supported API: true

Parameters:
domain_ref - reference to the domain the rule is for
type_id - logical or persisted type identifier
event_key - event key (defined in the wt.admin.adminEventResource resource bundle)
principal_refs - principal references for notification recipients (Vector of WTPrincipalReference)
Throws:
WTException

updateNotificationLists

void updateNotificationLists(wt.admin.Selector selector)
                             throws WTException
Deprecated. 

Update the list of the selector and all lists associated with selectors that are more specific than the given one.

This method is no longer needed. The createNotificationRule, deleteNotificationRule, and updateNotificationRule methods update the lists.

Supported API: true

Parameters:
selector -
Throws:
WTException
See Also:
createNotificationRule(AdminDomainRef domain_ref, String type_id, String event_key, Vector principal_refs), deleteNotificationRule(AdminDomainRef domain_ref, String type_id, String event_key), updateNotificationRule(AdminDomainRef domain_ref, String type_id, String event_key, Vector principal_refs)

addNotificationRule

wt.notify.NotificationRule addNotificationRule(wt.admin.Selector selector,
                                               NotificationSet set)
                                               throws WTException
Deprecated. 

Adds a notification rule given the selector and notification set. If there is a rule for the same selector the rule is replaced. Returns the persisted rule.

Supported API: true

Parameters:
selector -
set -
Returns:
NotificationRule
Throws:
WTException
See Also:
createNotificationRule(AdminDomainRef domain_ref, String type_id, String event_key, Vector principal_refs)

createObjectSubscription

wt.notify.CompositeNotificationSubscription createObjectSubscription(wt.notify.NotificationSubscription subscriptionAttributes,
                                                                     wt.notify.NotifySubscriptionRecipient subscriber,
                                                                     Notifiable targetObject,
                                                                     HashMap<String,wt.fc.WTStringMap> eventKeysAndAttributeValueMaps,
                                                                     boolean subscribeAllVersions)
                                                                     throws WTException
Creates a new object instance subscription.

Supported API: true

Parameters:
subscriptionAttributes - Required. The NotificationSubscription object for this subscription.
subscriber - Required. The subscription recipient. Recipients must by users, groups, or ObjectSubscriptionListeners.
targetObject - Required, Reference to the target object for this subscription.
eventKeysAndAttributeValueMaps -
subscribeAllVersions - Boolean to indicate if the subscription applies to all versions, present and future, of the specified object or just the current version of the specified object. Specify true to indicate the subscription applies to all versions of an object.
Returns:
CompositeNotificationSubscription
Throws:
WTException

createObjectSubscriptions

wt.notify.CompositeNotificationSubscription createObjectSubscriptions(wt.notify.NotificationSubscription subscriptionAttributes,
                                                                      WTCollection subscribers,
                                                                      WTCollection targetObjects,
                                                                      HashMap<String,wt.fc.WTStringMap> eventKeysAndAttributeValueMaps,
                                                                      boolean subscribeAllVersions)
                                                                      throws WTException
Creates a new object instance subscription.

Supported API: true

Parameters:
subscriptionAttributes - Required. The NotificationSubscription object for this subscription.
subscribers - Required. The recipients for this subscription. The ArrayList must contain NotifySubscriptionRecipient objects. Recipients can be a mix of users, groups, and ObjectSubscriptionListeners.
targetObjects - Required, Collection containing the objects to be subscribed to.
eventKeysAndAttributeValueMaps -
subscribeAllVersions - Boolean to indicate if the subscription applies to all versions, present and future, of each specified object or just the current version of each specified object. Specify true to indicate the subscription applies to all versions of an object.
Returns:
CompositeNotificationSubscription
Throws:
WTException

createTypeBasedContainerSubscriptions

wt.notify.CompositeNotificationSubscription createTypeBasedContainerSubscriptions(wt.notify.NotificationSubscription subscriptionAttributes,
                                                                                  WTCollection subscribers,
                                                                                  WTCollection targetContainers,
                                                                                  ArrayList<String> targetTypes,
                                                                                  HashMap<String,wt.fc.WTStringMap> eventKeysAndAttributeValueMaps)
                                                                                  throws WTException
Creates type-based Container subscriptions.

Supported API: true

Parameters:
subscriptionAttributes - The NotificationSubscription object for this subscription.
subscribers -
targetContainers - Collection containing the Containers being subscribed to.
targetTypes - List of type names being subscribed to in each container.
eventKeysAndAttributeValueMaps -
Returns:
CompositeNotificationSubscription
Throws:
WTException

createTypeBasedFolderSubscriptions

wt.notify.CompositeNotificationSubscription createTypeBasedFolderSubscriptions(wt.notify.NotificationSubscription subscriptionAttributes,
                                                                               WTCollection subscribers,
                                                                               WTCollection targetFolders,
                                                                               ArrayList<String> targetTypes,
                                                                               HashMap<String,wt.fc.WTStringMap> eventKeysAndAttributeValueMaps,
                                                                               boolean includeSubfolders)
                                                                               throws WTException
Creates type-based Folder subscriptions.

Supported API: true

Parameters:
subscriptionAttributes - The NotificationSubscription object for this subscription.
subscribers - The recipients for this subscription. The ArrayList must contain NotifySubscriptionRecipient objects. Recipients can be a mix of users, groups, and ObjectSubscriptionListeners.
targetFolders - Collection containing the Folders being subscribed to.
targetTypes - List of type names being subscribed to in each folder.
eventKeysAndAttributeValueMaps -
includeSubfolders - Boolean to indicate whether this subscription includes subfolders. Specify true to include subfolders.
Returns:
CompositeNotificationSubscription
Throws:
WTException

deleteSubscription

void deleteSubscription(wt.notify.NotificationSubscription subscription)
                        throws WTException
Deletes a subscription represented by the input NotificationSubscription object and also deletes all of its associated subscription recipients and subscription targets (the NotifySubscriptionRecipient and NotifySubscritpionTarget objects).

Supported API: true

Parameters:
subscription - Required. The NotificationSubscription object representing the subscription to be deleted.
Throws:
WTException

deleteSubscription

void deleteSubscription(ObjectReference subscriptionRef)
                        throws WTException
Deletes a subscription represented by the input NotificationSubscription object and also deletes all of its associated subscription recipients and subscription targets (the NotifySubscriptionRecipient and NotifySubscritpionTarget objects).

Supported API: true

Parameters:
subscriptionRef - Required. Reference to the subscription's NotificationSubscription object.
Throws:
WTException

deleteSubscriptions

void deleteSubscriptions(WTSet subscriptions)
                         throws WTException
Deletes the subscriptions represented by the list of input NotificationSubscription objects and also deletes each subscription's associated subscription recipients and subscription targets (the NotifySubscriptionRecipient and NotifySubscritpionTarget objects).

Supported API: true

Parameters:
subscriptions - Required. The WTSet must contain references to the NotificationSubscription objects for the subscriptions to be deleted.
Throws:
WTException

unsubscribe

void unsubscribe(wt.notify.NotificationSubscription subscription,
                 Persistable subscriber,
                 boolean deleteSubscription)
                 throws WTException
Unsubscribes the subscriber specified by the subscriber paramater from the subscription specified by the subscription parameter.

Supported API: true

Parameters:
subscription - Required. The subscription's NotificationSubscription object.
subscriber - Required. The subscriber object being unsubscribed from the subscription specified by the subscription parameter. Subscribers are either WTPrincipal or ObjectListenerSubscriber objects.
deleteSubscription - If true, the subscription is deleted in there are no subscribers after unsubscribing the input subscriber.
Throws:
WTException

unsubscribe

void unsubscribe(ObjectReference subscriptionRef,
                 WTReference subscriberRef,
                 boolean deleteSubscription)
                 throws WTException
Unsubscribes the subscriber object specified by the subscriberRef paramater from the subscription specified by the subscriptionRef parameter.

Supported API: true

Parameters:
subscriptionRef - Required. Reference to the subscription's NotificationSubscription object.
subscriberRef - Required. Reference to the subscriber being unsubscribed from the subscription specified by the subscriberRef parameter. Subscribers are either WTPrincipal or ObjectListenerSubscriber objects.
deleteSubscription - If true, the subscription is deleted in there are no subscribers after unsubscribing the input subscriber.
Throws:
WTException

getNotificationSubscription

wt.notify.CompositeNotificationSubscription getNotificationSubscription(ObjectIdentifier subscriptionOID,
                                                                        wt.notify.NotificationSubscription.CheckAccess checkAccess)
                                                                        throws WTException
Returns the CompositeNotificationSubscription that matched the input NotificationSubscription OID. A CompositeNotificationSubscription contains all the parts that make up a Notification Service subscription (the NotificationSubscription is one of those parts).

The subscription returned is subject to access control. The subscription is returned only if the Session User 1) has Read access for the NotificationSubscription object, 2) is one of the subscription recipients or a member of a subscribed Group, or 3) if a subscription recipient is WTPrincipalReference.OWNER, is the owner of the subscription target object.

If no matching subscriptions are found either an empty collection or null is returned.

Supported API: true

Parameters:
subscriptionOID - The OID of the NotificationSubscription object for the subscription to be returned. If the value is null or the NotificationSubscription object no longer exists, null is returned.
checkAccess - By default the subscription object is returned only if the Session User has Read access to the subscription object or is one of the subscribers. This parameter indicates wihether additional read access checks should be done for each subscription subscriber or target. Possible values are:
  • CheckAccess.SUBSCRIPTION_SUBSCRIBER_OBJECTS - Only include a subscription recipient if the Session user has Read access to the object referenced by the subscriberRef.
  • CheckAccess.SUBSCRIPTION_TARGET_OBJECTS - Only include a subscription target if the Session user has Read access to the object referenced by the targetRef.
  • CheckAccess.SUBSCRIPTION_SUBSCRIBER_AND_TARGET_OBJECTS - Do both of the above access checks.
If null is specified, no additional access checks are done.
Returns:
CompositeNotificationSubscription
Throws:
WTException

getNotificationSubscriptions

Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(String subscriptionName,
                                                                                     wt.notify.NotificationSubscription.CheckAccess checkAccess)
                                                                                     throws WTException
Returns a collection containing the CompositeNotificationSubscriptions that matched the input subscription name. A CompositeNotificationSubscription contains all the parts that make up a Notification Service subscription.

The subscriptions returned are subject to access control. A matching subscription is included in the return collection only if the Session User 1) has Read access for the NotificationSubscription object for the subscription, 2) is one of the subscription recipients or a member of a subscribed Group, or 3) if a subscription recipient is WTPrincipalReference.OWNER, is the owner of the subscription target object.

If no matching subscriptions are found either an empty collection or null is returned.

Supported API: true

Parameters:
subscriptionName - The subscription name to search for. If the value is null, an empty collection is returned. If no subscriptions are found for the name, an empty collection or null is returned.
checkAccess - By default subscription objects are included in the return collection only if the Session User has Read access to the subscription object or is one of the subscribers. This parameter indicates wihether additional read access checks should be done for each subscription subscriber or target. Possible values are:
  • CheckAccess.SUBSCRIPTION_SUBSCRIBER_OBJECTS - Only include a subscription recipient if the Session user has Read access to the object referenced by the subscriberRef.
  • CheckAccess.SUBSCRIPTION_TARGET_OBJECTS - Only include a subscription target if the Session user has Read access to the object referenced by the targetRef.
  • CheckAccess.SUBSCRIPTION_SUBSCRIBER_AND_TARGET_OBJECTS - Do both of the above access checks.
If null is specified, no additional access checks are done.
Returns:
Collection
Throws:
WTException

getNotificationSubscriptions

Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(Notifiable target,
                                                                                     Persistable subscriber,
                                                                                     String eventKey,
                                                                                     String subscriptionKey)
                                                                                     throws WTException
Returns a collection containing the CompositeNotificationSubscriptions that matched the input search criteria.

Supported API: true

Parameters:
target - The target of the subscription to search for. If null, target is not part of the search criteria and all targets for any subscriptions matching the other input parameters are returned.
subscriber - The subcriber to search for. If null, subscriber is not part of the search criteria and all subscriberss for any subscriptions matching the other input parameters are returned. Any subscriptions that have Owner Ref or a Group as one of the subscribers are not resolved to see if the input subscriber is the subscription target object owner or a member of a subscribed group.
eventKey - The target event key to search for. If null, event key is not part of the search criteria.
subscriptionKey - The subscriptionKey value to match. If null, subscriptionKey is not part of the search criteria.
Returns:
Collection
Throws:
WTException

getNotificationSubscriptions

Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(ObjectReference targetRef,
                                                                                     ObjectReference subscriberRef,
                                                                                     String eventKey,
                                                                                     String subscriptionKey)
                                                                                     throws WTException
Returns a collection containing the CompositeNotificationSubscriptions that matched the input search criteria.

Supported API: true

Parameters:
targetRef - The target of the subscription to search for. If null, targetRef is not part of the search criteria and all targets for any subscriptions matching the other input parameters are returned.
subscriberRef - The subcriber to search for. If null, subscriberRef is not part of the search criteria and all subscriberss for any subscriptions matching the other input parameters are returned. Any subscriptions that have Owner Ref or a Group as one of the subscribers are not resolved to see if the input subscriber is the subscription target object owner or a member of a subscribed group.
eventKey - The target event key to search for. If null, event key is not part of the search criteria.
subscriptionKey - The subscriptionKey value to match. If null, subscriptionKey is not part of the search criteria.
Returns:
Collection
Throws:
WTException

getNotificationSubscriptions

Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(Notifiable target,
                                                                                     String eventKey,
                                                                                     Persistable subscriber,
                                                                                     wt.notify.NotificationSubscription.SubscriberRole subscriberRole,
                                                                                     wt.notify.NotificationSubscription.IncludeOwnerRefSubscriber includeOwnerRefSubscriber,
                                                                                     wt.notify.NotificationSubscription.IncludeSubscribersParentGroups includeSubscribersParentGroups,
                                                                                     wt.notify.NotificationSubscription.SubscriberType returnSubscriberType,
                                                                                     wt.notify.NotificationSubscription.DeliveryMethod deliveryMethod,
                                                                                     String subscriptionKey,
                                                                                     wt.notify.NotificationSubscription.AddTargetMetaData addTargetMetaData,
                                                                                     wt.notify.NotificationSubscription.CheckAccess checkAccess)
                                                                                     throws WTException
Returns a collection containing the CompositeNotificationSubscriptions that matched the input search criteria. A CompositeNotificationSubscription contains all the parts that make up a Notification Service subscription.

The subscriptions returned are subject to access control. A matching subscription is included in the return collection only if the Session User 1) has Read access for the NotificationSubscription object for the subscription, 2) is one of the subscription recipients or a member of a subscribed Group, or 3) if a subscription recipient is WTPrincipalReference.OWNER, is the owner of the subscription target object.

If no matching subscriptions are found either an empty collection or null is returned.

Supported API: true

Parameters:
target - The target object of the subscription to match. If null is specified, target object is not part of the search criteria and all targets for any subscriptions matching the other input parameters are returned.
eventKey - The target event key to match. If null is specified, event key is not part of the search criteria.
subscriber - The subscription subcriber (also referred to as the recipient) to search for. If null is specified, subscriber is not part of the search criteria.
subscriberRole - The role the input subscriber plays in subscriptions to search for. Possible values are:
  • SubscriberRole.OWNER - include subscriptions where the input subscriber is the subscription Owner, but may or may not be a subscriber
  • SubscriberRole.NOT_OWNER - include subscriptions where the input subscriber is NOT the subscription Owner, but may or may not be a subscriber
  • SubscriberRole.SUBSCRIBER - include subscriptions where the input subscriber is one of the subscribers, but may or may not be the Owner
  • SubscriberRole.SUBSCRIBER_AND_NOT_OWNER - include subscriptions where the input subscriber is one of the subscribers AND is NOT the Owner
  • SubscriberRole.OWNER_AND_SUBSCRIBER - include subscriptions where the input subscriber is the Owner AND one of the subscribers
  • SubscriberRole.OWNER_OR_SUBSCRIBER - include subscriptions where the input subscriber is either the Owner OR one of the subscribers.
If null is specified, this value defaults to SUBSCRIBER. This parameter is ignored if subscriber is null.
includeOwnerRefSubscriber - Subscriptions can have the subscriber WTPrincipalReference.OWNER that represents the Principal that owns the subscription target. This parameter indicates whether any WTPrincipalReference.OWNER subscribers should be resolved to the subscription target owner and compared to the subscriber parameter as part of the processing to determine whether the input subscriber is one of the subscription recipients. Possible values are:
  • IncludeOwnerRefSubscribers.YES
  • IncludeOwnerRefSubscribers.NO
If null is specified, this value defaults to YES. This parameter is ignored if the subscriber parameter isn't a WTPrincipal or is null.
includeSubscribersParentGroups - For subscriber values that are principal's this parameter indicates whether the subscriber parent groups should be included in the list of subscription subscribers when searching for subscriptions. Possible values are:
  • IncludeSubscribersParentGroups.YES
  • IncludeSubscribersParentGroups.NO
If null is specified, this value defaults to YES. This parameter is ignored if the subscriber parameter isn't a WTPrincipal or is null.
returnSubscriberType - Indicates the type of subscriber to match. Subscribers can be either Principals or Listener objects. Possible values are:
  • ReturnSubscriberType.PRINCIPAL_SUBSCRIBER
  • ReturnSubscriberType.LISTENER_SUBSCRIBER
  • ReturnSubscriberType.ANY_SUBSCRIBER
If null is specified, this value defaults to ANY_SUBSCRIBER.
deliveryMethod - Indicates the subscription delivery method value to match. Possible values are:
  • DeliveryMethod.IMMEDIATE
  • DeliveryMethod.SCHEDULED
  • DeliveryMethod.ANY
If null is specified, this value defaults to ANY.
subscriptionKey - The subscriptionKey value to match. If null is specified, subscriptionKey is not part of the search criteria.
addTargetMetaData - Indicates whether each CompositeNotificationSubscription object in the return collection should include meta data for each of their contained subscription targets. Currently, the meta data for each subscription target includes: target data type and the data type display string. Possible values are:
  • AddTargetMetaData.YES
  • AddTargetMetaData.NO
If null is specified, this value defaults to NO.
checkAccess - By default subscription objects are included in the return collection only if the Session User has Read access to the subscription object or is one of the subscribers. This parameter indicates wihether additional read access checks should be done for each subscription subscriber or target. Possible values are:
  • CheckAccess.SUBSCRIPTION_SUBSCRIBER_OBJECTS - Only include a subscription recipient if the Session user has Read access to the object referenced by the subscriberRef.
  • CheckAccess.SUBSCRIPTION_TARGET_OBJECTS - Only include a subscription target if the Session user has Read access to the object referenced by the targetRef.
  • CheckAccess.SUBSCRIPTION_SUBSCRIBER_AND_TARGET_OBJECTS - Do both of the above access checks.
If null is specified, no additional access checks are done.
Returns:
Collection
Throws:
WTException

getNotificationSubscriptions

Collection<wt.notify.CompositeNotificationSubscription> getNotificationSubscriptions(ObjectReference targetRef,
                                                                                     String eventKey,
                                                                                     ObjectReference subscriberRef,
                                                                                     wt.notify.NotificationSubscription.SubscriberRole subscriberRole,
                                                                                     wt.notify.NotificationSubscription.IncludeOwnerRefSubscriber includeOwnerRefSubscriber,
                                                                                     wt.notify.NotificationSubscription.IncludeSubscribersParentGroups includeSubscribersParentGroups,
                                                                                     wt.notify.NotificationSubscription.SubscriberType returnSubscriberType,
                                                                                     wt.notify.NotificationSubscription.DeliveryMethod deliveryMethod,
                                                                                     String subscriptionKey,
                                                                                     wt.notify.NotificationSubscription.AddTargetMetaData addTargetMetaData,
                                                                                     wt.notify.NotificationSubscription.CheckAccess checkAccess)
                                                                                     throws WTException
Returns a collection containing the CompositeNotificationSubscriptions that matched the input search criteria. A CompositeNotificationSubscription contains all the parts that make up a Notification Service subscription.

The subscriptions returned are subject to access control. A matching subscription is included in the return collection only if the Session User 1) has Read access for the NotificationSubscription object for the subscription, 2) is one of the subscription recipients or a member of a subscribed Group, or 3) if a subscription recipient is WTPrincipalReference.OWNER, is the owner of the subscription target object.

If no matching subscriptions are found either an empty collection or null is returned.

Supported API: true

Parameters:
targetRef - Reference to the target object of the subscription to match. If null is specified, target object is not part of the search criteria and all targets for any subscriptions matching the other input parameters are returned.
eventKey - The target event key to match. If null is specified, event key is not part of the search criteria.
subscriberRef - Reference to the subscription subcriber (also referred to as the recipient) to search for. If null is specified, subscriber is not part of the search criteria.
subscriberRole - The role the input subscriber plays in subscriptions to search for. Possible values are:
  • SubscriberRole.OWNER - include subscriptions where the input subscriber is the subscription Owner, but may or may not be a subscriber
  • SubscriberRole.NOT_OWNER - include subscriptions where the input subscriber is NOT the subscription Owner, but may or may not be a subscriber
  • SubscriberRole.SUBSCRIBER - include subscriptions where the input subscriber is one of the subscribers, but may or may not be the Owner
  • SubscriberRole.SUBSCRIBER_AND_NOT_OWNER - include subscriptions where the input subscriber is one of the subscribers AND is NOT the Owner
  • SubscriberRole.OWNER_AND_SUBSCRIBER - include subscriptions where the input subscriber is the Owner AND one of the subscribers
  • SubscriberRole.OWNER_OR_SUBSCRIBER - include subscriptions where the input subscriber is either the Owner OR one of the subscribers.
If null is specified, this value defaults to SUBSCRIBER. This parameter is ignored if subscriber is null.
includeOwnerRefSubscriber - Subscriptions can have the subscriber WTPrincipalReference.OWNER that represents the Principal that owns the subscription target. This parameter indicates whether any WTPrincipalReference.OWNER subscribers should be resolved to the subscription target owner and compared to the subscriber parameter as part of the processing to determine whether the input subscriber is one of the subscription recipients. Possible values are:
  • IncludeOwnerRefSubscribers.YES
  • IncludeOwnerRefSubscribers.NO
If null is specified, this value defaults to YES. This parameter is ignored if the subscriber parameter isn't a WTPrincipal or is null.
includeSubscribersParentGroups - For subscriber values that are principal's this parameter indicates whether the subscriber parent groups should be included in the list of subscription subscribers when searching for subscriptions. Possible values are:
  • IncludeSubscribersParentGroups.YES
  • IncludeSubscribersParentGroups.NO
If null is specified, this value defaults to YES. This parameter is ignored if the subscriber parameter isn't a WTPrincipal or is null.
returnSubscriberType - Indicates the type of subscriber to match. Subscribers can be either Principals or Listener objects. Possible values are:
  • ReturnSubscriberType.PRINCIPAL_SUBSCRIBER
  • ReturnSubscriberType.LISTENER_SUBSCRIBER
  • ReturnSubscriberType.ANY_SUBSCRIBER
If null is specified, this value defaults to ANY_SUBSCRIBER.
deliveryMethod - Indicates the subscription delivery method value to match. Possible values are:
  • DeliveryMethod.IMMEDIATE
  • DeliveryMethod.SCHEDULED
  • DeliveryMethod.ANY
If null is specified, this value defaults to ANY.
subscriptionKey - The subscriptionKey value to match. If null is specified, subscriptionKey is not part of the search criteria.
addTargetMetaData - Indicates whether each CompositeNotificationSubscription object in the return collection should include meta data for each of their contained subscription targets. Currently, the meta data for each subscription target includes: target data type and the data type display string. Possible values are:
  • AddTargetMetaData.YES
  • AddTargetMetaData.NO
If null is specified, this value defaults to NO.
checkAccess - By default subscription objects are included in the return collection only if the Session User has Read access to the subscription object or is one of the subscribers. This parameter indicates wihether additional read access checks should be done for each subscription subscriber or target. Possible values are:
  • CheckAccess.SUBSCRIPTION_SUBSCRIBER_OBJECTS - Only include a subscription recipient if the Session user has Read access to the object referenced by the subscriberRef.
  • CheckAccess.SUBSCRIPTION_TARGET_OBJECTS - Only include a subscription target if the Session user has Read access to the object referenced by the targetRef.
  • CheckAccess.SUBSCRIPTION_SUBSCRIBER_AND_TARGET_OBJECTS - Do both of the above access checks.
If null is specified, no additional access checks are done.
Returns:
Collection
Throws:
WTException

getSubscriptionsForTarget

Collection<wt.notify.CompositeNotificationSubscription> getSubscriptionsForTarget(Notifiable target,
                                                                                  boolean includeAllTargets)
                                                                                  throws WTException
Returns the collection of subscriptions for the input target object reference. Any subscription that contains the input target object as one of the subscription targets is included in the returned collection of subscriptions. The returned Collection contains CompositeNotificationSubscription objects.

Supported API: true

Parameters:
target -
includeAllTargets - Boolean to indicate if the returned CompositeNotificationSubscriptions should contain all of the subscription targets or only the targets that matched the input target reference. If true, all subscription targets are included with each CompositeNotificationSubscription.
Returns:
Collection
Throws:
WTException

getSubscriptionsForTarget

Collection<wt.notify.CompositeNotificationSubscription> getSubscriptionsForTarget(ObjectReference targetRef,
                                                                                  boolean includeAllTargets)
                                                                                  throws WTException
Returns the collection of subscriptions for the input target object reference. Any subscription that contains the input target object as one of the subscription targets is included in the returned collection of subscriptions. The returned Collection contains CompositeNotificationSubscription objects.

Supported API: true

Parameters:
targetRef - The target object reference. Any subscription that includes this target object is returned.
includeAllTargets - Boolean to indicate if the returned CompositeNotificationSubscriptions should contain all of the subscription targets or only the targets that matched the input target reference. If true, all subscription targets are included with each CompositeNotificationSubscription.
Returns:
Collection
Throws:
WTException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD