|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.telelogic.cs.api.TriggerEvent
public abstract class TriggerEvent
The superclass for all "event" objects that are made available to in-process triggers. Used to lookup information about the particular trigger that occurred. All event types are registered under the name "event".
Constructor Summary | |
---|---|
TriggerEvent()
|
Method Summary | |
---|---|
void |
fail(java.lang.String errorMessage)
Indicates that the current trigger has failed. |
abstract User |
getAdminUser()
Gets information about the admin user for the database the trigger fired in. |
java.lang.String |
getFailure()
Gets the failure message is fail was called. |
abstract java.lang.String |
getTriggerType()
Gets the type of this trigger, that is the type of action the spawned this trigger. |
abstract User |
getTriggerUser()
Gets information about this user that performed the action that fired this trigger. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TriggerEvent()
Method Detail |
---|
public abstract java.lang.String getTriggerType()
public abstract User getTriggerUser()
public abstract User getAdminUser()
public void fail(java.lang.String errorMessage)
Calling this method indicates the something bad has happened and can be used
in any trigger. If you are writing a pre-transition trigger and simply want to
gracefully indicate that the transition should not proceed, instead call
stopTransition
.
errorMessage
- an error message for an end user indicating why this trigger failed.
May be shown in the interface or be sent to the log file.public java.lang.String getFailure()
fail
was called.
null
if fail
was never called.public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |