TaskCalendar (java-api 21.0.12 API)

java.lang.Object
- com.uc4.api.objects.TaskCalendar

All Implemented Interfaces:: java.lang.Iterable<CalendarCondition>

public class TaskCalendar
extends java.lang.Object
implements java.lang.Iterable<CalendarCondition>

Task calendar conditions.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`TaskCalendar()` Constructs an empty TaskCalendar where `ConditionMatchOne` is set to `true`.
`protected`	`TaskCalendar(com.uc4.util.XMLDocument doc, org.w3c.dom.Element task)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCalendarCondition(CalendarCondition cale)` Adds a new `CalendarCondition`.
`void`	`clearCalendarList()` Removes all calendar conditions.
`TaskCalendar`	`clone()`
`boolean`	`isConditionMatchAll()` Returns `true` if the task will be executed when the date of JobPlan activation or the logical date matches all specified calendar conditions.
`boolean`	`isConditionMatchExt()` Returns `true` if the calendar definition of external dependency should be used.
`boolean`	`isConditionMatchNone()` Returns `true` if the task will be executed when the date of JobPlan activation or the logical date does not match any of the specified calendar conditions.
`boolean`	`isConditionMatchOne()` Returns `true` if the task will be executed when the date of JobPlan activation or the logical date matches one of the specified calendar conditions.
`java.util.Iterator<CalendarCondition>`	`iterator()` Returns an iterator over `CalendarCondition`.
`void`	`setCalendarConditions(java.util.List<CalendarCondition> calendarConditions)` Overrides `CalendarCondition`
`void`	`setConditionMatchAll()` The task will be executed when the date of JobPlan activation or the logical date matches all specified calendar conditions.
`void`	`setConditionMatchExt()` Use calendar definition of external dependency.
`void`	`setConditionMatchNone()` The task will be executed when the date of JobPlan activation or the logical date does not match any of the specified calendar conditions.
`void`	`setConditionMatchOne()` The task will be executed when the date of JobPlan activation or the logical date matches one of the specified calendar conditions.
`int`	`size()` Returns the number of calendar conditions.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - TaskCalendar
```
public TaskCalendar()
```
    Constructs an empty TaskCalendar where ConditionMatchOne is set to true.
  - TaskCalendar
```
protected TaskCalendar(com.uc4.util.XMLDocument doc,
                       org.w3c.dom.Element task)
```
- Method Detail
  - addCalendarCondition
```
public void addCalendarCondition(CalendarCondition cale)
```
    Adds a new CalendarCondition.
    
    Parameters:
    
    cale - CalendarCondition which should be added
  - setCalendarConditions
```
public void setCalendarConditions(java.util.List<CalendarCondition> calendarConditions)
```
    Overrides CalendarCondition
    
    Parameters:
    
    calendarConditions - CalendarCondition which are overriding existing ones
  - iterator
```
public java.util.Iterator<CalendarCondition> iterator()
```
    Returns an iterator over CalendarCondition.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<CalendarCondition>
    
    Returns:
    
    Iterator which can be used to get the CalendarCondition
  - clearCalendarList
```
public void clearCalendarList()
```
    Removes all calendar conditions.
  - setConditionMatchOne
```
public void setConditionMatchOne()
```
    The task will be executed when the date of JobPlan activation or the logical date matches one of the specified calendar conditions.
  - isConditionMatchOne
```
public boolean isConditionMatchOne()
```
    Returns true if the task will be executed when the date of JobPlan activation or the logical date matches one of the specified calendar conditions.
    
    Returns:
    
    True if one condition matches
  - setConditionMatchNone
```
public void setConditionMatchNone()
```
    The task will be executed when the date of JobPlan activation or the logical date does not match any of the specified calendar conditions.
  - isConditionMatchNone
```
public boolean isConditionMatchNone()
```
    Returns true if the task will be executed when the date of JobPlan activation or the logical date does not match any of the specified calendar conditions.
    
    Returns:
    
    Execute if no condition matches
  - setConditionMatchAll
```
public void setConditionMatchAll()
```
    The task will be executed when the date of JobPlan activation or the logical date matches all specified calendar conditions.
  - isConditionMatchAll
```
public boolean isConditionMatchAll()
```
    Returns true if the task will be executed when the date of JobPlan activation or the logical date matches all specified calendar conditions.
    
    Returns:
    
    Execute if all conditions match
  - setConditionMatchExt
```
public void setConditionMatchExt()
```
    Use calendar definition of external dependency. This option is only available for external dependencies.
  - isConditionMatchExt
```
public boolean isConditionMatchExt()
```
    Returns true if the calendar definition of external dependency should be used. This option is only available for external dependencies.
    
    Returns:
    
    True if the calendar definition of external dependency should be used
  - size
```
public int size()
```
    Returns the number of calendar conditions.
    
    Returns:
    
    number of calendar conditions
  - clone
```
public TaskCalendar clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class TaskCalendar

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

TaskCalendar

TaskCalendar

Method Detail

addCalendarCondition

setCalendarConditions

iterator

clearCalendarList

setConditionMatchOne

isConditionMatchOne

setConditionMatchNone

isConditionMatchNone

setConditionMatchAll

isConditionMatchAll

setConditionMatchExt

isConditionMatchExt

size

clone