RecurringTaskParameters
Inheritance: java.lang.Object
public class RecurringTaskParameters
Represents the set of parameters are used to create a recurring task in a project.
Constructors
| Constructor | Description |
|---|---|
| RecurringTaskParameters() | Initializes a new instance of the RecurringTaskParameters class. |
Methods
| Method | Description |
|---|---|
| getDuration() | Gets the duration for one occurrence of the recurring task. |
| getIgnoreResourceCalendar() | Gets a value indicating whether to schedule the recurring task even if it does not happen when any resources are available to work on it. |
| getRecurrencePattern() | Gets the recurrence pattern of the recurring task. |
| getTaskName() | Gets the name of the recurring task. |
| setCalendar(Project project, String calendarName) | Set a calendar for recurring task. |
| setDuration(Duration value) | Sets the duration for one occurrence of the recurring task. |
| setIgnoreResourceCalendar(boolean value) | Sets a value indicating whether to schedule the recurring task even if it does not happen when any resources are available to work on it. |
| setRecurrencePattern(RecurrencePatternBase value) | Sets the recurrence pattern of the recurring task. |
| setTaskName(String value) | Sets the name of the recurring task. |
RecurringTaskParameters()
public RecurringTaskParameters()
Initializes a new instance of the RecurringTaskParameters class.
getDuration()
public final Duration getDuration()
Gets the duration for one occurrence of the recurring task.
Returns:
Duration - The instance of Duration(getDuration()/setDuration(Duration)) class.
getIgnoreResourceCalendar()
public final boolean getIgnoreResourceCalendar()
Gets a value indicating whether to schedule the recurring task even if it does not happen when any resources are available to work on it.
Returns: boolean - a value indicating whether to schedule the recurring task even if it does not happen when any resources are available to work on it.
getRecurrencePattern()
public final RecurrencePatternBase getRecurrencePattern()
Gets the recurrence pattern of the recurring task.
Can be one of the values of RecurrencePattern(getRecurrencePattern()/setRecurrencePattern(RecurrencePatternBase)) enumeration.
Returns: RecurrencePatternBase - the recurrence pattern of the recurring task.
getTaskName()
public final String getTaskName()
Gets the name of the recurring task.
Returns: java.lang.String - the name of the recurring task.
setCalendar(Project project, String calendarName)
public final void setCalendar(Project project, String calendarName)
Set a calendar for recurring task. The calendar is selected from project calendar collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| project | Project | The project with calendar collection. |
| calendarName | java.lang.String | The name of calendar. |
setDuration(Duration value)
public final void setDuration(Duration value)
Sets the duration for one occurrence of the recurring task.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Duration | The instance of Duration(getDuration()/setDuration(Duration)) class. |
setIgnoreResourceCalendar(boolean value)
public final void setIgnoreResourceCalendar(boolean value)
Sets a value indicating whether to schedule the recurring task even if it does not happen when any resources are available to work on it.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether to schedule the recurring task even if it does not happen when any resources are available to work on it. |
setRecurrencePattern(RecurrencePatternBase value)
public final void setRecurrencePattern(RecurrencePatternBase value)
Sets the recurrence pattern of the recurring task.
Can be one of the values of RecurrencePattern(getRecurrencePattern()/setRecurrencePattern(RecurrencePatternBase)) enumeration.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | RecurrencePatternBase | the recurrence pattern of the recurring task. |
setTaskName(String value)
public final void setTaskName(String value)
Sets the name of the recurring task.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | the name of the recurring task. |