Class TimerEventSetup

  • All Implemented Interfaces:
    java.io.Serializable

    public class TimerEventSetup
    extends EventSetup
    The class that specifies the setup information for the TimerEventSetup elements that are in a process flow.

    Note: If the TimerType is DATE, the timer value must be a Date. If the TimerType is DURATION, the timer value must be a string in ISO 8601 duration format. An example of duration is P10D, which represents 10 days.

    See Also:
    Serialized Form
    • Constructor Detail

      • TimerEventSetup

        public TimerEventSetup​(java.lang.String name,
                               java.lang.String description,
                               java.lang.String elementId,
                               Element.ElementType type,
                               java.lang.String processFlowId,
                               TimerEventSetup.TimerType timerType)
        It is not intended or recommended that the consumer of this API construct these objects. They should only deal with the setup events returned by the API.
        Parameters:
        name - The name of the event.
        description - The description of the event.
        elementId - The identifier of the event as it appears in the process flow definition.
        type - The type of the event.
        processFlowId - The identifier of the process flow that contains the event.
        timerType - The type of timer for the timer event.
    • Method Detail

      • getTimerValue

        public java.io.Serializable getTimerValue()
        Gets the value of the timer.
        Returns:
        The value.
      • setTimerValue

        public void setTimerValue​(java.io.Serializable timerValue)
        Sets the timer value. If TimerType is of type DATE, the timer value must be a Date. If TimerType is of type DURATION, the timer value must be a string in ISO 8601 duration format. An example of duration is P10D, which represents 10 days.
        Parameters:
        timerValue - The timer value.