com.crystaldecisions.sdk.plugin.desktop.event
Interface IUserEventBase

All Known Subinterfaces:

IUserEvent

public interface IUserEventBase

This interface allows you to manually trigger an event. For example, you can define a custom event that is triggered when a user clicks a button.

Since:

4.0

Field Summary

static java.lang.String	ROOTFOLDER_CUID The CUID for this object type's root folder.
static java.lang.String	SPECIFIC_KIND The Kind used to identify this object type.
static java.lang.String	SPECIFIC_PROGID The ProgID used to identify this object type.

Method Summary

void	addTriggerAlertMessage(java.lang.String message) Adds an alert message to be sent to principals (users and groups) that are subscribed to a triggered event.
java.util.List	getDefaultAlertMessages() Returns the default alert messages.
void	trigger() Triggers the user event.

Field Detail

SPECIFIC_KIND

static final java.lang.String SPECIFIC_KIND

The Kind used to identify this object type.

See Also:

Constant Field Values

SPECIFIC_PROGID

static final java.lang.String SPECIFIC_PROGID

The ProgID used to identify this object type.

See Also:

Constant Field Values

ROOTFOLDER_CUID

static final java.lang.String ROOTFOLDER_CUID

The CUID for this object type's root folder. All objects of this type must be stored under this folder.

See Also:

Constant Field Values

Method Detail

trigger

void trigger()

Triggers the user event.

addTriggerAlertMessage

void addTriggerAlertMessage(java.lang.String message)

Adds an alert message to be sent to principals (users and groups) that are subscribed to a triggered event. Use this method to add messages at the time the event is triggered. If you use this method to add messages before the event is triggered, they may be ignored. To set an alert message before an event is triggered, use the method getDefaultAlertMessages. Alert messages do not have to be unique.

Parameters:

message - A String object that contains the alert message.

Since:

4.0

See Also:

getDefaultAlertMessages

getDefaultAlertMessages

java.util.List getDefaultAlertMessages()

Returns the default alert messages. These messages can be set before the event is triggered. These messages are overriden by messages that are set at the time the event is triggered by using the addTriggerAlertMessage method. Alert messages do not have to be unique.

Returns:

A List object that contains the default alert messages stored as String objects.

Since:

4.0

See Also:

addTriggerAlertMessage

InfoObject properties to query for:

SI_DEFAULT_ALERT_MESSAGES