|
|||||||||
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.SubscriptionRelationEvent
public class SubscriptionRelationEvent
Sent when a relation to a CR is created and users are subscribed to that CR. The normal action in this situation is to send email to the subscribed users. By default, this operation is handled by a traditional trigger called subscriptionRelationTrigger.pl, not an in-process trigger.
Constructor Summary | |
---|---|
SubscriptionRelationEvent(User triggerUser,
User adminUser,
java.lang.String name,
java.lang.String type,
java.lang.String fromObject,
java.lang.String toObject,
boolean isCreate,
java.util.List<java.lang.String> subscriberList)
|
Method Summary | |
---|---|
User |
getAdminUser()
Gets information about the admin user for the database the trigger fired in. |
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[] |
getSubscriberList()
Gets an array of all the subscriber email addresses. |
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 information about this user that performed the action that fired this trigger. |
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. |
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 SubscriptionRelationEvent(User triggerUser, User adminUser, java.lang.String name, java.lang.String type, java.lang.String fromObject, java.lang.String toObject, boolean isCreate, java.util.List<java.lang.String> subscriberList)
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 java.lang.String[] getSubscriberList()
public User getAdminUser()
TriggerEvent
getAdminUser
in class TriggerEvent
public User getTriggerUser()
TriggerEvent
getTriggerUser
in class TriggerEvent
public java.lang.String getTriggerType()
TriggerEvent
getTriggerType
in class TriggerEvent
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 |