com.flexive.shared.scripting
Class FxScriptSchedule

java.lang.Object
  extended by com.flexive.shared.scripting.FxScriptSchedule
All Implemented Interfaces:
SelectableObject, SelectableObjectWithName, java.io.Serializable
Direct Known Subclasses:
FxScriptScheduleEdit

public class FxScriptSchedule
extends java.lang.Object
implements java.io.Serializable, SelectableObjectWithName

Class describing a script schedule

Since:
3.1.2
Author:
Gerhard Glos (gerhard.glos@flexive.com)
See Also:
Serialized Form

Field Summary
protected  boolean active
           
protected  java.lang.String cronString
           
protected  java.util.Date endTime
           
protected  long id
           
protected  java.lang.String name
           
static int REPEAT_TIMES_UNBOUNDED
          Constant designating unbounded repeat times
(useful for script schedules that should run up to the specified end time, or indefinitely)
protected  long repeatInterval
           
protected  int repeatTimes
           
protected  long scriptId
           
protected  java.util.Date startTime
           
 
Constructor Summary
protected FxScriptSchedule()
           
  FxScriptSchedule(long id, long scriptId, java.lang.String name, boolean active, java.util.Date startTime, java.util.Date endTime, long repeatInterval, int repeatTimes, java.lang.String cronString)
          Constructor
 
Method Summary
 FxScriptScheduleEdit asEditable()
           
 java.lang.String getCronString()
           
 java.util.Date getEndTime()
           
 long getId()
          The object's unique identifier
 java.lang.String getName()
          The displayed name of the object.
 long getRepeatInterval()
           
 int getRepeatTimes()
           
 long getScriptId()
           
 java.util.Date getStartTime()
           
 boolean isActive()
           
 boolean isUnbounded()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REPEAT_TIMES_UNBOUNDED

public static final int REPEAT_TIMES_UNBOUNDED
Constant designating unbounded repeat times
(useful for script schedules that should run up to the specified end time, or indefinitely)

See Also:
Constant Field Values

repeatTimes

protected int repeatTimes

id

protected long id

scriptId

protected long scriptId

name

protected java.lang.String name

active

protected boolean active

startTime

protected java.util.Date startTime

endTime

protected java.util.Date endTime

repeatInterval

protected long repeatInterval

cronString

protected java.lang.String cronString
Constructor Detail

FxScriptSchedule

protected FxScriptSchedule()

FxScriptSchedule

public FxScriptSchedule(long id,
                        long scriptId,
                        java.lang.String name,
                        boolean active,
                        java.util.Date startTime,
                        java.util.Date endTime,
                        long repeatInterval,
                        int repeatTimes,
                        java.lang.String cronString)
Constructor

Parameters:
id - script schedule id
scriptId - script id
name - script schedule name
active - active flag
startTime - start time
endTime - end time
repeatInterval - repeat interval in ms
repeatTimes - number of repeat times
cronString - cron String
Method Detail

getId

public long getId()
Description copied from interface: SelectableObject
The object's unique identifier

Specified by:
getId in interface SelectableObject
Returns:
the object's unique identifier

getName

public java.lang.String getName()
Description copied from interface: SelectableObjectWithName
The displayed name of the object.

Specified by:
getName in interface SelectableObjectWithName
Returns:
the displayed name of the object.

isActive

public boolean isActive()

getStartTime

public java.util.Date getStartTime()

getEndTime

public java.util.Date getEndTime()

getRepeatTimes

public int getRepeatTimes()

getRepeatInterval

public long getRepeatInterval()

getCronString

public java.lang.String getCronString()

asEditable

public FxScriptScheduleEdit asEditable()

getScriptId

public long getScriptId()

isUnbounded

public boolean isUnbounded()