com.sap.netweaver.bc.uwl.connect

Interface IAlertConnector

All Superinterfaces:

IProviderConnector

public interface IAlertConnector
extends IProviderConnector

The IAlertConnector interface defines methods relevant for subscription of alert categories.

Nested Class Summary

static class

IAlertConnector.AlertCategory This class encapsulates the alert category, aggregating the same category for multiple systems

Field Summary

Fields inherited from interface com.sap.netweaver.bc.uwl.connect.IProviderConnector

ACTIONINBOX_CONNECTOR, ACTIONINBOX_SYSTEM, ADHOC_WORKFLOW_CONNECTOR_ID, ADHOC_WORKFLOW_SYSTEM, ALERT_CONNECTOR_ID, BPEM_CONNECTOR_ID, GENERIC_ABAP_CONNECTOR, SOM_CONNECTOR_ID, WEBFLOW_CONNECTOR_ID

Method Summary

List	getAlertCategoriesForSubscription(UWLContext ctx) returns a list of all alert categories available for subscription for the user.
boolean	subscribe(UWLContext ctx, List categories, boolean subscribe) Subscribe/unsubscribe selected alert categories for the user.

Methods inherited from interface com.sap.netweaver.bc.uwl.connect.IProviderConnector

getActionHandler, getAllActionsForItem, getAttachmentHeaders, getDescription, getId, getItem, getItems, getLogData, getLogData, isActionValidForItem, isItemValid, isLogRetrievalSupported, needsRemoteConnection, populateHollowItem, supportsCacheClearance, supportsItemType

Method Detail

getAlertCategoriesForSubscription

List getAlertCategoriesForSubscription(UWLContext ctx)

returns a list of all alert categories available for subscription for the user.

Parameters:

ctx - - UWLContext for making a backend connections.

Returns:

a List of AlertCategory objects.

subscribe

boolean subscribe(UWLContext ctx,
                  List categories,
                  boolean subscribe)

Subscribe/unsubscribe selected alert categories for the user.

Parameters:

ctx- - UWLContext for making a backend connections.

categories - - a List of AlertCategory objects for subscription/unsubscription.

subscribe - - a flag indicating if the categories are to be subscribed/unsubscribed.

Returns:

- true, if there is no error reported.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	default	EP-BC-UWL
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	-	EP-BC-UWL