|
|||||||||
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.SubscriptionEvent
public class SubscriptionEvent
Sent when a CR is modified 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 subscriptionTrigger.pl, not an in-process trigger.
Constructor Summary | |
---|---|
SubscriptionEvent(User triggerUser,
User adminUser,
java.lang.String objectId,
java.lang.String objectType,
java.util.List<java.lang.String> subscriberList,
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 |
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[] |
getSubscriberList()
Gets an array of all the subscriber email addresses. |
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. |
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 SubscriptionEvent(User triggerUser, User adminUser, java.lang.String objectId, java.lang.String objectType, java.util.List<java.lang.String> subscriberList, Attribute[] attributes, Attribute[] requestedAttributes)
Method Detail |
---|
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 java.lang.String[] getSubscriberList()
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |