Class TriggerModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class TriggerModel
    extends ItemModel
    Generated model class for type Trigger first defined at extension processing.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _CRONJOBTRIGGERRELATION
      Generated relation code constant for relation CronJobTriggerRelation defining source attribute cronJob in extension processing.
      static java.lang.String _JOBTRIGGERRELATION
      Generated relation code constant for relation JobTriggerRelation defining source attribute job in extension processing.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String ACTIVATIONTIME
      Generated constant - Attribute key of Trigger.activationTime attribute defined at extension processing.
      static java.lang.String ACTIVE
      Generated constant - Attribute key of Trigger.active attribute defined at extension processing.
      static java.lang.String CRONEXPRESSION
      Generated constant - Attribute key of Trigger.cronExpression attribute defined at extension processing.
      static java.lang.String CRONJOB
      Generated constant - Attribute key of Trigger.cronJob attribute defined at extension processing.
      static java.lang.String DATERANGE
      Generated constant - Attribute key of Trigger.dateRange attribute defined at extension processing.
      static java.lang.String DAY
      Generated constant - Attribute key of Trigger.day attribute defined at extension processing.
      static java.lang.String DAYSOFWEEK
      Generated constant - Attribute key of Trigger.daysOfWeek attribute defined at extension processing.
      static java.lang.String HOUR
      Generated constant - Attribute key of Trigger.hour attribute defined at extension processing.
      static java.lang.String JOB
      Generated constant - Attribute key of Trigger.job attribute defined at extension processing.
      static java.lang.String MAXACCEPTABLEDELAY
      Generated constant - Attribute key of Trigger.maxAcceptableDelay attribute defined at extension processing.
      static java.lang.String MINUTE
      Generated constant - Attribute key of Trigger.minute attribute defined at extension processing.
      static java.lang.String MONTH
      Generated constant - Attribute key of Trigger.month attribute defined at extension processing.
      static java.lang.String RELATIVE
      Generated constant - Attribute key of Trigger.relative attribute defined at extension processing.
      static java.lang.String SECOND
      Generated constant - Attribute key of Trigger.second attribute defined at extension processing.
      static java.lang.String TIMETABLE
      Generated constant - Attribute key of Trigger.timeTable attribute defined at extension processing.
      static java.lang.String WEEKINTERVAL
      Generated constant - Attribute key of Trigger.weekInterval attribute defined at extension processing.
      static java.lang.String YEAR
      Generated constant - Attribute key of Trigger.year attribute defined at extension processing.
    • Constructor Summary

      Constructors 
      Constructor Description
      TriggerModel()
      Generated constructor - Default constructor for generic creation.
      TriggerModel​(CronJobModel _cronJob, JobModel _job, ItemModel _owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      TriggerModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Date getActivationTime()
      Generated method - Getter of the Trigger.activationTime attribute defined at extension processing.
      java.lang.Boolean getActive()
      Generated method - Getter of the Trigger.active attribute defined at extension processing.
      java.lang.String getCronExpression()
      Generated method - Getter of the Trigger.cronExpression attribute defined at extension processing.
      CronJobModel getCronJob()
      Generated method - Getter of the Trigger.cronJob attribute defined at extension processing.
      StandardDateRange getDateRange()
      Generated method - Getter of the Trigger.dateRange attribute defined at extension processing.
      java.lang.Integer getDay()
      Generated method - Getter of the Trigger.day attribute defined at extension processing.
      java.util.List<DayOfWeek> getDaysOfWeek()
      Generated method - Getter of the Trigger.daysOfWeek attribute defined at extension processing.
      java.lang.Integer getHour()
      Generated method - Getter of the Trigger.hour attribute defined at extension processing.
      JobModel getJob()
      Generated method - Getter of the Trigger.job attribute defined at extension processing.
      java.lang.Integer getMaxAcceptableDelay()
      Generated method - Getter of the Trigger.maxAcceptableDelay attribute defined at extension processing.
      java.lang.Integer getMinute()
      Generated method - Getter of the Trigger.minute attribute defined at extension processing.
      java.lang.Integer getMonth()
      Generated method - Getter of the Trigger.month attribute defined at extension processing.
      java.lang.Boolean getRelative()
      Generated method - Getter of the Trigger.relative attribute defined at extension processing.
      java.lang.Integer getSecond()
      Generated method - Getter of the Trigger.second attribute defined at extension processing.
      java.lang.String getTimeTable()
      Generated method - Getter of the Trigger.timeTable dynamic attribute defined at extension processing.
      java.lang.Integer getWeekInterval()
      Generated method - Getter of the Trigger.weekInterval attribute defined at extension processing.
      java.lang.Integer getYear()
      Generated method - Getter of the Trigger.year attribute defined at extension processing.
      void setActivationTime​(java.util.Date value)
      Generated method - Setter of Trigger.activationTime attribute defined at extension processing.
      void setActive​(java.lang.Boolean value)
      Generated method - Setter of Trigger.active attribute defined at extension processing.
      void setCronExpression​(java.lang.String value)
      Generated method - Setter of Trigger.cronExpression attribute defined at extension processing.
      void setCronJob​(CronJobModel value)
      Generated method - Initial setter of Trigger.cronJob attribute defined at extension processing.
      void setDateRange​(StandardDateRange value)
      Generated method - Setter of Trigger.dateRange attribute defined at extension processing.
      void setDay​(java.lang.Integer value)
      Generated method - Setter of Trigger.day attribute defined at extension processing.
      void setDaysOfWeek​(java.util.List<DayOfWeek> value)
      Generated method - Setter of Trigger.daysOfWeek attribute defined at extension processing.
      void setHour​(java.lang.Integer value)
      Generated method - Setter of Trigger.hour attribute defined at extension processing.
      void setJob​(JobModel value)
      Generated method - Initial setter of Trigger.job attribute defined at extension processing.
      void setMaxAcceptableDelay​(java.lang.Integer value)
      Generated method - Setter of Trigger.maxAcceptableDelay attribute defined at extension processing.
      void setMinute​(java.lang.Integer value)
      Generated method - Setter of Trigger.minute attribute defined at extension processing.
      void setMonth​(java.lang.Integer value)
      Generated method - Setter of Trigger.month attribute defined at extension processing.
      void setRelative​(java.lang.Boolean value)
      Generated method - Setter of Trigger.relative attribute defined at extension processing.
      void setSecond​(java.lang.Integer value)
      Generated method - Setter of Trigger.second attribute defined at extension processing.
      void setWeekInterval​(java.lang.Integer value)
      Generated method - Setter of Trigger.weekInterval attribute defined at extension processing.
      void setYear​(java.lang.Integer value)
      Generated method - Setter of Trigger.year attribute defined at extension processing.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • _JOBTRIGGERRELATION

        public static final java.lang.String _JOBTRIGGERRELATION
        Generated relation code constant for relation JobTriggerRelation defining source attribute job in extension processing.
        See Also:
        Constant Field Values
      • _CRONJOBTRIGGERRELATION

        public static final java.lang.String _CRONJOBTRIGGERRELATION
        Generated relation code constant for relation CronJobTriggerRelation defining source attribute cronJob in extension processing.
        See Also:
        Constant Field Values
      • ACTIVE

        public static final java.lang.String ACTIVE
        Generated constant - Attribute key of Trigger.active attribute defined at extension processing.
        See Also:
        Constant Field Values
      • SECOND

        public static final java.lang.String SECOND
        Generated constant - Attribute key of Trigger.second attribute defined at extension processing.
        See Also:
        Constant Field Values
      • MINUTE

        public static final java.lang.String MINUTE
        Generated constant - Attribute key of Trigger.minute attribute defined at extension processing.
        See Also:
        Constant Field Values
      • HOUR

        public static final java.lang.String HOUR
        Generated constant - Attribute key of Trigger.hour attribute defined at extension processing.
        See Also:
        Constant Field Values
      • DAY

        public static final java.lang.String DAY
        Generated constant - Attribute key of Trigger.day attribute defined at extension processing.
        See Also:
        Constant Field Values
      • MONTH

        public static final java.lang.String MONTH
        Generated constant - Attribute key of Trigger.month attribute defined at extension processing.
        See Also:
        Constant Field Values
      • YEAR

        public static final java.lang.String YEAR
        Generated constant - Attribute key of Trigger.year attribute defined at extension processing.
        See Also:
        Constant Field Values
      • RELATIVE

        public static final java.lang.String RELATIVE
        Generated constant - Attribute key of Trigger.relative attribute defined at extension processing.
        See Also:
        Constant Field Values
      • DAYSOFWEEK

        public static final java.lang.String DAYSOFWEEK
        Generated constant - Attribute key of Trigger.daysOfWeek attribute defined at extension processing.
        See Also:
        Constant Field Values
      • WEEKINTERVAL

        public static final java.lang.String WEEKINTERVAL
        Generated constant - Attribute key of Trigger.weekInterval attribute defined at extension processing.
        See Also:
        Constant Field Values
      • DATERANGE

        public static final java.lang.String DATERANGE
        Generated constant - Attribute key of Trigger.dateRange attribute defined at extension processing.
        See Also:
        Constant Field Values
      • ACTIVATIONTIME

        public static final java.lang.String ACTIVATIONTIME
        Generated constant - Attribute key of Trigger.activationTime attribute defined at extension processing.
        See Also:
        Constant Field Values
      • TIMETABLE

        public static final java.lang.String TIMETABLE
        Generated constant - Attribute key of Trigger.timeTable attribute defined at extension processing.
        See Also:
        Constant Field Values
      • CRONEXPRESSION

        public static final java.lang.String CRONEXPRESSION
        Generated constant - Attribute key of Trigger.cronExpression attribute defined at extension processing.
        See Also:
        Constant Field Values
      • MAXACCEPTABLEDELAY

        public static final java.lang.String MAXACCEPTABLEDELAY
        Generated constant - Attribute key of Trigger.maxAcceptableDelay attribute defined at extension processing.
        See Also:
        Constant Field Values
      • JOB

        public static final java.lang.String JOB
        Generated constant - Attribute key of Trigger.job attribute defined at extension processing.
        See Also:
        Constant Field Values
      • CRONJOB

        public static final java.lang.String CRONJOB
        Generated constant - Attribute key of Trigger.cronJob attribute defined at extension processing.
        See Also:
        Constant Field Values
    • Constructor Detail

      • TriggerModel

        public TriggerModel()
        Generated constructor - Default constructor for generic creation.
      • TriggerModel

        public TriggerModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • TriggerModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public TriggerModel​(CronJobModel _cronJob,
                            JobModel _job,
                            ItemModel _owner)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _cronJob - initial attribute declared by type Trigger at extension processing
        _job - initial attribute declared by type Trigger at extension processing
        _owner - initial attribute declared by type Item at extension core
    • Method Detail

      • getActivationTime

        @Accessor(qualifier="activationTime",
                  type=GETTER)
        public java.util.Date getActivationTime()
        Generated method - Getter of the Trigger.activationTime attribute defined at extension processing.
        Returns:
        the activationTime - next activation time
      • getActive

        @Accessor(qualifier="active",
                  type=GETTER)
        public java.lang.Boolean getActive()
        Generated method - Getter of the Trigger.active attribute defined at extension processing.
        Returns:
        the active
      • getCronExpression

        @Accessor(qualifier="cronExpression",
                  type=GETTER)
        public java.lang.String getCronExpression()
        Generated method - Getter of the Trigger.cronExpression attribute defined at extension processing.
        Returns:
        the cronExpression
      • getCronJob

        @Accessor(qualifier="cronJob",
                  type=GETTER)
        public CronJobModel getCronJob()
        Generated method - Getter of the Trigger.cronJob attribute defined at extension processing.
        Returns:
        the cronJob - assigned cronjob
      • getDateRange

        @Accessor(qualifier="dateRange",
                  type=GETTER)
        public StandardDateRange getDateRange()
        Generated method - Getter of the Trigger.dateRange attribute defined at extension processing.
        Returns:
        the dateRange - date range the trigger is active
      • getDay

        @Accessor(qualifier="day",
                  type=GETTER)
        public java.lang.Integer getDay()
        Generated method - Getter of the Trigger.day attribute defined at extension processing.
        Returns:
        the day - time value day
      • getDaysOfWeek

        @Accessor(qualifier="daysOfWeek",
                  type=GETTER)
        public java.util.List<DayOfWeek> getDaysOfWeek()
        Generated method - Getter of the Trigger.daysOfWeek attribute defined at extension processing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the daysOfWeek - days of week the trigger is active
      • getHour

        @Accessor(qualifier="hour",
                  type=GETTER)
        public java.lang.Integer getHour()
        Generated method - Getter of the Trigger.hour attribute defined at extension processing.
        Returns:
        the hour - time value hour
      • getJob

        @Accessor(qualifier="job",
                  type=GETTER)
        public JobModel getJob()
        Generated method - Getter of the Trigger.job attribute defined at extension processing.
        Returns:
        the job - assigned job
      • getMaxAcceptableDelay

        @Accessor(qualifier="maxAcceptableDelay",
                  type=GETTER)
        public java.lang.Integer getMaxAcceptableDelay()
        Generated method - Getter of the Trigger.maxAcceptableDelay attribute defined at extension processing.
        Returns:
        the maxAcceptableDelay - the maximum acceptable delay (s) in which the job can be triggered, after which it is ignored.
      • getMinute

        @Accessor(qualifier="minute",
                  type=GETTER)
        public java.lang.Integer getMinute()
        Generated method - Getter of the Trigger.minute attribute defined at extension processing.
        Returns:
        the minute - time value minute
      • getMonth

        @Accessor(qualifier="month",
                  type=GETTER)
        public java.lang.Integer getMonth()
        Generated method - Getter of the Trigger.month attribute defined at extension processing.
        Returns:
        the month - time value month
      • getRelative

        @Accessor(qualifier="relative",
                  type=GETTER)
        public java.lang.Boolean getRelative()
        Generated method - Getter of the Trigger.relative attribute defined at extension processing.
        Returns:
        the relative - time values are considered as relative values
      • getSecond

        @Accessor(qualifier="second",
                  type=GETTER)
        public java.lang.Integer getSecond()
        Generated method - Getter of the Trigger.second attribute defined at extension processing.
        Returns:
        the second - time value second
      • getTimeTable

        @Accessor(qualifier="timeTable",
                  type=GETTER)
        public java.lang.String getTimeTable()
        Generated method - Getter of the Trigger.timeTable dynamic attribute defined at extension processing.
        Returns:
        the timeTable
      • getWeekInterval

        @Accessor(qualifier="weekInterval",
                  type=GETTER)
        public java.lang.Integer getWeekInterval()
        Generated method - Getter of the Trigger.weekInterval attribute defined at extension processing.
        Returns:
        the weekInterval - week interval for days of week
      • getYear

        @Accessor(qualifier="year",
                  type=GETTER)
        public java.lang.Integer getYear()
        Generated method - Getter of the Trigger.year attribute defined at extension processing.
        Returns:
        the year - time value year
      • setActivationTime

        @Accessor(qualifier="activationTime",
                  type=SETTER)
        public void setActivationTime​(java.util.Date value)
        Generated method - Setter of Trigger.activationTime attribute defined at extension processing.
        Parameters:
        value - the activationTime - next activation time
      • setActive

        @Accessor(qualifier="active",
                  type=SETTER)
        public void setActive​(java.lang.Boolean value)
        Generated method - Setter of Trigger.active attribute defined at extension processing.
        Parameters:
        value - the active
      • setCronExpression

        @Accessor(qualifier="cronExpression",
                  type=SETTER)
        public void setCronExpression​(java.lang.String value)
        Generated method - Setter of Trigger.cronExpression attribute defined at extension processing.
        Parameters:
        value - the cronExpression
      • setCronJob

        @Accessor(qualifier="cronJob",
                  type=SETTER)
        public void setCronJob​(CronJobModel value)
        Generated method - Initial setter of Trigger.cronJob attribute defined at extension processing. Can only be used at creation of model - before first save.
        Parameters:
        value - the cronJob - assigned cronjob
      • setDateRange

        @Accessor(qualifier="dateRange",
                  type=SETTER)
        public void setDateRange​(StandardDateRange value)
        Generated method - Setter of Trigger.dateRange attribute defined at extension processing.
        Parameters:
        value - the dateRange - date range the trigger is active
      • setDay

        @Accessor(qualifier="day",
                  type=SETTER)
        public void setDay​(java.lang.Integer value)
        Generated method - Setter of Trigger.day attribute defined at extension processing.
        Parameters:
        value - the day - time value day
      • setDaysOfWeek

        @Accessor(qualifier="daysOfWeek",
                  type=SETTER)
        public void setDaysOfWeek​(java.util.List<DayOfWeek> value)
        Generated method - Setter of Trigger.daysOfWeek attribute defined at extension processing.
        Parameters:
        value - the daysOfWeek - days of week the trigger is active
      • setHour

        @Accessor(qualifier="hour",
                  type=SETTER)
        public void setHour​(java.lang.Integer value)
        Generated method - Setter of Trigger.hour attribute defined at extension processing.
        Parameters:
        value - the hour - time value hour
      • setJob

        @Accessor(qualifier="job",
                  type=SETTER)
        public void setJob​(JobModel value)
        Generated method - Initial setter of Trigger.job attribute defined at extension processing. Can only be used at creation of model - before first save.
        Parameters:
        value - the job - assigned job
      • setMaxAcceptableDelay

        @Accessor(qualifier="maxAcceptableDelay",
                  type=SETTER)
        public void setMaxAcceptableDelay​(java.lang.Integer value)
        Generated method - Setter of Trigger.maxAcceptableDelay attribute defined at extension processing.
        Parameters:
        value - the maxAcceptableDelay - the maximum acceptable delay (s) in which the job can be triggered, after which it is ignored.
      • setMinute

        @Accessor(qualifier="minute",
                  type=SETTER)
        public void setMinute​(java.lang.Integer value)
        Generated method - Setter of Trigger.minute attribute defined at extension processing.
        Parameters:
        value - the minute - time value minute
      • setMonth

        @Accessor(qualifier="month",
                  type=SETTER)
        public void setMonth​(java.lang.Integer value)
        Generated method - Setter of Trigger.month attribute defined at extension processing.
        Parameters:
        value - the month - time value month
      • setRelative

        @Accessor(qualifier="relative",
                  type=SETTER)
        public void setRelative​(java.lang.Boolean value)
        Generated method - Setter of Trigger.relative attribute defined at extension processing.
        Parameters:
        value - the relative - time values are considered as relative values
      • setSecond

        @Accessor(qualifier="second",
                  type=SETTER)
        public void setSecond​(java.lang.Integer value)
        Generated method - Setter of Trigger.second attribute defined at extension processing.
        Parameters:
        value - the second - time value second
      • setWeekInterval

        @Accessor(qualifier="weekInterval",
                  type=SETTER)
        public void setWeekInterval​(java.lang.Integer value)
        Generated method - Setter of Trigger.weekInterval attribute defined at extension processing.
        Parameters:
        value - the weekInterval - week interval for days of week
      • setYear

        @Accessor(qualifier="year",
                  type=SETTER)
        public void setYear​(java.lang.Integer value)
        Generated method - Setter of Trigger.year attribute defined at extension processing.
        Parameters:
        value - the year - time value year