public class Period extends UC4Object
Usage Example:
Period period = (Period) open("NAME.OF.PERIOD.OBJECT");
//Create a ExecuteRecurring instance with the settings from the Period object.
ExecuteRecurring er = period.createExecuteRecurring();
executeObject.executeRecurring(er);
Constructor and Description |
---|
Period() |
Modifier and Type | Method and Description |
---|---|
ExecuteRecurring |
createExecuteRecurring()
Creates a new
ExecuteRecurring instance with the settings copied from this Period object. |
TaskCalendar |
getCalendarCondition()
Deprecated.
|
int |
getDateRangeRuns()
Deprecated.
|
ExecuteRecurring |
getExecuteRecurring()
This method will return the
ExecuteRecurring details. |
int |
getExecutionInterval()
Deprecated.
|
int |
getGapInterval()
Deprecated.
|
DateTime |
getRangeEndDate()
Deprecated.
|
DateTime |
getRangeStartDate()
Deprecated.
|
Time |
getTimeframeEnd()
Deprecated.
|
Time |
getTimeframeStart()
Deprecated.
|
Time |
getTimeOfSingleExecution()
Deprecated.
|
boolean |
hasDateRangeRuns()
Deprecated.
|
boolean |
hasDateRangeWithEndTime()
Deprecated.
|
boolean |
hasDateRangeWithoutEnd()
Deprecated.
|
boolean |
hasTimeframeAdjustment()
Deprecated.
|
Header |
header()
Returns the header data of this object.
|
boolean |
isAllowOneOverlap()
Deprecated.
|
boolean |
isExecutable()
Returns
true if this Object can be executed. |
boolean |
isExecutedAtTime()
Deprecated.
|
boolean |
isExecutedInterval()
Deprecated.
|
boolean |
isExecutedWithGap()
Deprecated.
|
boolean |
isFriday()
Deprecated.
|
boolean |
isMonday()
Deprecated.
|
boolean |
isSaturday()
Deprecated.
|
boolean |
isSunday()
Deprecated.
|
boolean |
isThursday()
Deprecated.
|
boolean |
isTuesday()
Deprecated.
|
boolean |
isWednesday()
Deprecated.
|
boolean |
runsOnDefinedCalendar()
Deprecated.
|
boolean |
runsOnDefinedWeekdays()
Deprecated.
|
void |
setAllowOneOverlap(boolean overlap)
Deprecated.
|
void |
setAtTime(Time time)
Deprecated.
|
void |
setCalendarCondition(TaskCalendar calendar)
Deprecated.
|
void |
setDateRange(DateTime startDate,
DateTime endDate)
Deprecated.
|
void |
setDateRange(DateTime startDate,
int runs)
Deprecated.
|
void |
setExecuteRecurring(ExecuteRecurring executeRecurring)
This method is used to set the
ExecuteRecurring details. |
void |
setExecutionInterval(int every)
Deprecated.
|
void |
setGapToPreviousRun(int gap)
Deprecated.
|
void |
setRangeWithoutEnd(DateTime startDate)
Deprecated.
|
void |
setTimeframe(Time start,
Time end,
boolean forceAdjustment)
Deprecated.
|
void |
setWeekDays(boolean mo,
boolean tu,
boolean we,
boolean th,
boolean fr,
boolean sa,
boolean su)
Deprecated.
|
public Header header()
public boolean isExecutable()
UC4Object
true
if this Object can be executed.isExecutable
in class UC4Object
@Deprecated public void setTimeframe(Time start, Time end, boolean forceAdjustment)
start
- Start timeend
- End timeforceAdjustment
- Aligns the start time on the time frame if set to true@Deprecated public Time getTimeframeStart()
setTimeframe
.@Deprecated public Time getTimeframeEnd()
setTimeframe
.@Deprecated public boolean hasTimeframeAdjustment()
@Deprecated public void setExecutionInterval(int every)
every
- Number of minutes of the execution interval@Deprecated public boolean isExecutedInterval()
@Deprecated public int getExecutionInterval()
@Deprecated public void setGapToPreviousRun(int gap)
gap
- Time gap in minutes@Deprecated public boolean isExecutedWithGap()
@Deprecated public int getGapInterval()
@Deprecated public void setAtTime(Time time)
time
- Start time@Deprecated public Time getTimeOfSingleExecution()
setAtTime
.@Deprecated public boolean isExecutedAtTime()
@Deprecated public void setAllowOneOverlap(boolean overlap)
overlap
is set to false
there will only
be one task at one time even if the old run has not finished.overlap
- True if one overlap is allowed@Deprecated public boolean isAllowOneOverlap()
@Deprecated public void setDateRange(DateTime startDate, DateTime endDate)
startDate
- Start dateendDate
- End date@Deprecated public boolean hasDateRangeWithEndTime()
@Deprecated public DateTime getRangeStartDate()
setDateRange
.@Deprecated public DateTime getRangeEndDate()
setDateRange
.@Deprecated public void setRangeWithoutEnd(DateTime startDate)
startDate
- start date@Deprecated public boolean hasDateRangeWithoutEnd()
@Deprecated public void setDateRange(DateTime startDate, int runs)
startDate
- Start dateruns
- Number of run@Deprecated public int getDateRangeRuns()
@Deprecated public boolean hasDateRangeRuns()
@Deprecated public void setCalendarCondition(TaskCalendar calendar)
calendar
- Calendar condition@Deprecated public TaskCalendar getCalendarCondition()
setCalendarCondition
.@Deprecated public void setWeekDays(boolean mo, boolean tu, boolean we, boolean th, boolean fr, boolean sa, boolean su)
mo
- Mondaytu
- Tuesdaywe
- Wednesdayth
- Thursdayfr
- Fridaysa
- Saturdaysu
- Sunday@Deprecated public boolean runsOnDefinedWeekdays()
true
if setWeekDays
has been called before.
Note: When this method returns true, calls to runsOnDefinedCalendar()
will return false.
@Deprecated public boolean runsOnDefinedCalendar()
true
if setCalendarCondition(TaskCalendar)
has been called before.
Note: When this method returns true, calls to runsOnDefinedWeekdays()
will return false.
@Deprecated public boolean isSunday()
@Deprecated public boolean isMonday()
@Deprecated public boolean isTuesday()
@Deprecated public boolean isWednesday()
@Deprecated public boolean isThursday()
@Deprecated public boolean isFriday()
@Deprecated public boolean isSaturday()
public ExecuteRecurring createExecuteRecurring()
ExecuteRecurring
instance with the settings copied from this Period object.
The content of header()
.getTitle() is transfered to the description field of the returned ExecuteRecurring
object.
IllegalArgumentException
- When header()
.getTitle() is longer than 255 characters.ExecuteRecurring.getPeriodDescription()
,
Header.getTitle()
public void setExecuteRecurring(ExecuteRecurring executeRecurring)
ExecuteRecurring
details.executeRecurring
- ExecuteRecurring instancepublic ExecuteRecurring getExecuteRecurring()
ExecuteRecurring
details.Copyright © 2021. All rights reserved.