|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.telelogic.cs.api.TriggerEvent
com.telelogic.cs.api.TransitionEvent
public class TransitionEvent
Sent when a change request is submitted or transitioned.
A transition trigger is defined within the Change lifecycle for individual transitions. Transition triggers can be fired when an a Change Request is submitted or transitioned. Submissions are considered to be a type of transition.
Constructor Summary | |
---|---|
TransitionEvent(User triggerUser,
User adminUser,
java.lang.String objectId,
java.lang.String objectType,
java.lang.String fromState,
java.lang.String toState,
Attribute[] attributes,
Attribute[] requestedAttributes)
|
Method Summary | |
---|---|
User |
getAdminUser()
Gets the User object for the admin user. |
Attribute[] |
getAttributes()
Gets an array of ( Attribute s that were modified during the submission, transition or attribute
modification. |
java.lang.String |
getFromState()
Gets the state that the object is coming from (i.e, START_HERE, entered, assigned, etc) |
java.lang.String |
getObjectId()
Gets the object id (problem_number) of the object which caused the trigger to fire. |
java.lang.String |
getObjectType()
Gets the type of object that this trigger is firing for. |
Attribute[] |
getRequestedAttributes()
Gets an array of Attribute s for all the attributes requested to be sent to the trigger. |
java.lang.String |
getStoppedTransitionMessage()
Gets the message passed to stopTransition . |
java.lang.String |
getToState()
Gets the state that the object is going to (i.e, entered, assigned, etc) |
java.lang.String |
getTriggerType()
Gets the type of this trigger, that is the type of action the spawned this trigger. |
User |
getTriggerUser()
Gets the User object of the user which caused the trigger to fire. |
boolean |
isTransitionStopped()
Checks if the transition has been stopped by a trigger. |
void |
stopTransition(java.lang.String withMessage)
Pre-transition triggers can call this to prevent a transition from occurring. |
Methods inherited from class com.telelogic.cs.api.TriggerEvent |
---|
fail, getFailure, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TransitionEvent(User triggerUser, User adminUser, java.lang.String objectId, java.lang.String objectType, java.lang.String fromState, java.lang.String toState, Attribute[] attributes, Attribute[] requestedAttributes)
Method Detail |
---|
public java.lang.String getFromState()
public java.lang.String getToState()
public Attribute[] getAttributes()
Attribute
s that were modified during the submission, transition or attribute
modification.
getAttributes
in interface CollectibleEvent
public java.lang.String getObjectId()
getObjectId
in interface CollectibleEvent
public java.lang.String getObjectType()
public Attribute[] getRequestedAttributes()
Attribute
s for all the attributes requested to be sent to the trigger.
These are attributes that were specifically marked to be sent to all triggers in the lifecycle.
getRequestedAttributes
in interface CollectibleEvent
public User getAdminUser()
User
object for the admin user. This is the admin user object from the
same database as the user object.
getAdminUser
in class TriggerEvent
public User getTriggerUser()
User
object of the user which caused the trigger to fire.
getTriggerUser
in class TriggerEvent
public void stopTransition(java.lang.String withMessage)
This method only affects pre-transition, non-async triggers. Other triggers aren't guaranteed to finish before the transition is done, and thus can't stop the transition in time.
withMessage
- a message about why the transition was stopped. This message will be
shown to the user when the transition fails.public boolean isTransitionStopped()
true
if stopTransition
was called,
otherwise false
.public java.lang.String getStoppedTransitionMessage()
stopTransition
.
public java.lang.String getTriggerType()
TriggerEvent
getTriggerType
in class TriggerEvent
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |