|
|||||||||
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.RelationEvent
public class RelationEvent
Sent when a relation is created or deleted.
A relation trigger is defined within the Change lifecycle on individual CCM_RELATION attributes. Relation triggers can be fired when a relationship is created or removed.
Constructor Summary | |
---|---|
RelationEvent(User triggerUser,
User adminUser,
java.lang.String name,
java.lang.String type,
java.lang.String fromObject,
java.lang.String toObject,
boolean isCreate,
boolean isPreTrigger)
|
Method Summary | |
---|---|
User |
getAdminUser()
Gets the User object for the admin user. |
java.lang.String |
getFromObjectId()
Gets the id (CR - problem_number / Task - task_number / Object - cvid) of the object the relation is coming from. |
java.lang.String |
getName()
Gets the name of the relation which caused this trigger to fire (i.e: duplicate). |
java.lang.String |
getReleationCreationStoppedMessage()
Get the relation creation stop message |
java.lang.String |
getReleationDeletionStoppedMessage()
Get the relation deletion stop message |
java.lang.String |
getToObjectId()
Gets the id (CR - problem_number / Task - task_number / Object - cvid) of the object the relation is going to. |
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. |
java.lang.String |
getType()
Gets the type of relation the trigger is firing on. |
boolean |
isCreate()
Is this relation trigger firing on behalf of a create operation or not. |
boolean |
isPostTrigger()
Gets if this trigger is a post-trigger or not, true if a post-trigger false otherwise. |
boolean |
isPreTrigger()
Gets if this trigger is a pre-trigger or not, true if a pre-trigger false otherwise. |
boolean |
isReleationCreationStopped()
Checks if relation creation stopped. |
boolean |
isReleationDeletionStopped()
Checks if relation creation stopped. |
void |
stopReletionCreation(java.lang.String message)
Invoked by triggers to stop the relation creation. |
void |
stopReletionDeletion(java.lang.String message)
Invoked by triggers to stop the relation deletion. |
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 RelationEvent(User triggerUser, User adminUser, java.lang.String name, java.lang.String type, java.lang.String fromObject, java.lang.String toObject, boolean isCreate, boolean isPreTrigger)
Method Detail |
---|
public java.lang.String getFromObjectId()
public java.lang.String getName()
public java.lang.String getToObjectId()
public java.lang.String getType()
Relation types: CCM_PROBLEM_PROBLEM: A problem --> problem relationship. CCM_PROBLEM_TASK: A problem --> task relationship. CCM_PROBLEM_OBJECT: A problem --> object relationship. CCM_TASK_PROBLEM: A task --> problem relationship. CCM_TASK_TASK: A task --> task relationship. CCM_TASK_OBJECT: A task --> object relationship. CCM_OBJECT_PROBLEM: A object --> problem relationship. CCM_OBJECT_TASK: A object --> task relationship. CCM_OBJECT_OBJECT: A object --> object relationship.
public boolean isCreate()
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 java.lang.String getTriggerType()
TriggerEvent
getTriggerType
in class TriggerEvent
public void stopReletionCreation(java.lang.String message)
message
- public void stopReletionDeletion(java.lang.String message)
message
- public boolean isReleationCreationStopped()
public boolean isReleationDeletionStopped()
public java.lang.String getReleationCreationStoppedMessage()
public java.lang.String getReleationDeletionStoppedMessage()
public boolean isPreTrigger()
TriggerEvent
isPreTrigger
in class TriggerEvent
public boolean isPostTrigger()
TriggerEvent
isPostTrigger
in class TriggerEvent
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |