Interface Trigger
-
public interface Trigger
A Trigger is an object associated with a particular RTTP subject that contains a condition (on the given subjects fields) that when met will trigger a notification message.
Note: Different instances of this class are not equal and will need to be checked for equality manually if the need arises. Use the trigger ID to identify a trigger.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getCondition()
Gets the condition that must be met for this trigger to fire a notification.java.util.Map<java.lang.String,java.lang.String>
getParameters()
Gets a map containing the trigger parameters.TriggerState
getState()
Gets the current state of the trigger.java.lang.String
getSubject()
Gets the rttp subject associated with this trigger.java.lang.String
getTriggerId()
Gets the unique id of the trigger.
-
-
-
Method Detail
-
getTriggerId
java.lang.String getTriggerId()
Gets the unique id of the trigger.
- Returns:
- the unique id of the trigger.
-
getSubject
java.lang.String getSubject()
Gets the rttp subject associated with this trigger.
- Returns:
- the rttp subject associated with this trigger.
-
getCondition
java.lang.String getCondition()
Gets the condition that must be met for this trigger to fire a notification.
The format of the condition is the same as that for record filters. For more details on the format of the condition string, please see the StreamLink Overview document.
- Returns:
- the trigger condition.
-
getState
TriggerState getState()
Gets the current state of the trigger.
- Returns:
- the triggers state.
-
getParameters
java.util.Map<java.lang.String,java.lang.String> getParameters()
Gets a map containing the trigger parameters.
- Returns:
- a map containing the trigger parameters.
-
-