com.unica.publicapi.plan.plugin.procedure
Interface ITriggerProcedure

All Superinterfaces:
IPlugin, IProcedure, java.io.Serializable

public interface ITriggerProcedure
extends IProcedure

ITriggerProcedure mostly adds standard parameters that will be passed to a procedure invoked by a trigger.

Author:
Jim Flowers (jflowers@unica.com)

Field Summary
static java.lang.String PLANEVENT_COMMENT_PARAMNAME
          A string defining an optional clear-text comment associated with the triggered event, usually as typed by the user whose action generated the event (256 chars max).
static java.lang.String PLANEVENT_OBJECTHANDLE_PARAMNAME
          The string form of the handle of the source object that generated the triggered event, e.g., ProjectHandle.
static java.lang.String PLANEVENT_PREFIX
           
static java.lang.String PLANEVENT_TIMESTAMP_PARAMNAME
          A Calendar object that gives the system date and time when the triggered event occurred.
static java.lang.String PLANEVENT_TYPEENUM_PARAMNAME
          The string form of a EventTypeEnum enumerated type that defines the type of event that caused the trigger to fire.
static java.lang.String PLANEVENT_USERLOGIN_PARAMNAME
          A string giving the login name of the Plan user whose action generated the triggered event (generally not the same as the user identity used to run the procedure).
 
Fields inherited from interface com.unica.publicapi.plan.plugin.procedure.IProcedure
PLAN_INTEGRATIONWS_URL_PARAMNAME, PLAN_PROCEDUREKEY_PARAMNAME
 
Method Summary
 
Methods inherited from interface com.unica.publicapi.plan.plugin.procedure.IProcedure
execute
 
Methods inherited from interface com.unica.publicapi.plan.plugin.IPlugin
destroy, getDescription, getDisplayName, getName, getVersion, initialize
 

Field Detail

PLANEVENT_PREFIX

static final java.lang.String PLANEVENT_PREFIX
See Also:
Constant Field Values

PLANEVENT_TYPEENUM_PARAMNAME

static final java.lang.String PLANEVENT_TYPEENUM_PARAMNAME
The string form of a EventTypeEnum enumerated type that defines the type of event that caused the trigger to fire.

See Also:
com.unica.uap.common.event.EventTypeEnum, Constant Field Values

PLANEVENT_TIMESTAMP_PARAMNAME

static final java.lang.String PLANEVENT_TIMESTAMP_PARAMNAME
A Calendar object that gives the system date and time when the triggered event occurred.

See Also:
Calendar, Constant Field Values

PLANEVENT_OBJECTHANDLE_PARAMNAME

static final java.lang.String PLANEVENT_OBJECTHANDLE_PARAMNAME
The string form of the handle of the source object that generated the triggered event, e.g., ProjectHandle.

See Also:
Handle, Constant Field Values

PLANEVENT_USERLOGIN_PARAMNAME

static final java.lang.String PLANEVENT_USERLOGIN_PARAMNAME
A string giving the login name of the Plan user whose action generated the triggered event (generally not the same as the user identity used to run the procedure).

See Also:
Constant Field Values

PLANEVENT_COMMENT_PARAMNAME

static final java.lang.String PLANEVENT_COMMENT_PARAMNAME
A string defining an optional clear-text comment associated with the triggered event, usually as typed by the user whose action generated the event (256 chars max). If null, then no message is defined.

See Also:
Constant Field Values