net.sf.mpxj

Class RecurringTask

java.lang.Object

net.sf.mpxj.RecurringTask

public final class RecurringTask
extends Object

This class represents the Recurring Task Record as found in an MPX file.

Constructor Summary

Constructors

Constructor and Description
RecurringTask()

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getDailyFrequency() Retrieves the recurring task frequency.
boolean	getDailyWorkday() Retrieve the daily workday flag.
Duration	getDuration() Retrieve the duration of the recurring task.
Date	getFinishDate() Gets the finish date of this recurring task.
Integer	getMonthlyAbsoluteDay() Retrieves the monthly absolute day.
Integer	getMonthlyAbsoluteFrequency() Retrieves the monthly absolute frequency.
boolean	getMonthlyRelative() Retrieves the monthly relative flag.
Day	getMonthlyRelativeDay() Retrieves the monthly relative day.
Integer	getMonthlyRelativeFrequency() Sets the monthly relative frequency.
Integer	getMonthlyRelativeOrdinal() Retrieves the monthly relative ordinal value.
Integer	getOccurrences() Sets the number of occurrences.
RecurrenceType	getRecurrenceType() Retrieves the recurrence type.
Date	getStartDate() Gets the start date of this recurring task.
boolean	getUseEndDate() Retrieves the use end date flag.
Integer	getWeeklyDays() Retrieves a bit field representing days of the week.
Integer	getWeeklyFrequency() Retrieves the recurring task frequency.
boolean	getYearlyAbsolute() Retrieve the yearly relative flag.
Date	getYearlyAbsoluteDate() Retrieves the yearly absolute date.
Day	getYearlyRelativeDay() Retrieve the yearly relative day.
Integer	getYearlyRelativeMonth() Retrieves the yearly relative month.
Integer	getYearlyRelativeOrdinal() Retrieves the yearly relative ordinal.
void	setDailyFrequency(Integer frequency) Set the recurring task frequency.
void	setDailyWorkday(boolean workday) Set the daily workday flag.
void	setDuration(Duration duration) Set the duration of the recurring task.
void	setFinishDate(Date val) Sets the finish date of this recurring task.
void	setMonthlyAbsoluteDay(Integer day) Sets the monthly absolute day.
void	setMonthlyAbsoluteFrequency(Integer frequency) Sets the monthly absolute frequency.
void	setMonthlyRelative(boolean relative) Sets the monthly relative flag.
void	setMonthlyRelativeDay(Day day) Sets the monthly relative day.
void	setMonthlyRelativeFrequency(Integer frequency) Retrieves the monthly relative frequency.
void	setMonthlyRelativeOrdinal(Integer ordinal) Sets the monthly relative ordinal value.
void	setOccurrences(Integer occurrences) Retrieves the number of occurrences.
void	setRecurrenceType(RecurrenceType type) Sets the recurrence type.
void	setStartDate(Date val) Sets the start date of this recurring task.
void	setUseEndDate(boolean useEndDate) Sets the use end date flag.
void	setWeeklyDays(Integer days) Sets a bit field representing days of the week.
void	setWeeklyFrequency(Integer frequency) Set the recurring task frequency.
void	setYearlyAbsolute(boolean absolute) Set the yearly relative flag.
void	setYearlyAbsoluteDate(Date date) Sets the yearly absolute date.
void	setYearlyRelativeDay(Day day) Sets the yearly relative day.
void	setYearlyRelativeMonth(Integer month) Sets the yearly relative month.
void	setYearlyRelativeOrdinal(Integer ordinal) Sets the yearly relative ordinal.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RecurringTask

public RecurringTask()

Method Detail

getStartDate

public Date getStartDate()

Gets the start date of this recurring task.

Returns:

date to start recurring task

setStartDate

public void setStartDate(Date val)

Sets the start date of this recurring task.

Parameters:

val - date to start recurring task

getFinishDate

public Date getFinishDate()

Gets the finish date of this recurring task.

Returns:

date to finish recurring task

setFinishDate

public void setFinishDate(Date val)

Sets the finish date of this recurring task.

Parameters:

val - date to finish recurring task

getDuration

public Duration getDuration()

Retrieve the duration of the recurring task.

Returns:

duration of recurring task

setDuration

public void setDuration(Duration duration)

Set the duration of the recurring task.

Parameters:

duration - duration of the recurring task

getOccurrences

public Integer getOccurrences()

Sets the number of occurrences.

Returns:

number of occurrences

setOccurrences

public void setOccurrences(Integer occurrences)

Retrieves the number of occurrences.

Parameters:

occurrences - number of occurrences

getRecurrenceType

public RecurrenceType getRecurrenceType()

Retrieves the recurrence type.

Returns:

RecurrenceType instance

setRecurrenceType

public void setRecurrenceType(RecurrenceType type)

Sets the recurrence type.

Parameters:

type - recurrence type

getUseEndDate

public boolean getUseEndDate()

Retrieves the use end date flag.

Returns:

use end date flag

setUseEndDate

public void setUseEndDate(boolean useEndDate)

Sets the use end date flag.

Parameters:

useEndDate - use end date flag

getDailyWorkday

public boolean getDailyWorkday()

Retrieve the daily workday flag.

Returns:

boolean flag

setDailyWorkday

public void setDailyWorkday(boolean workday)

Set the daily workday flag.

Parameters:

workday - workday flag

getWeeklyDays

public Integer getWeeklyDays()

Retrieves a bit field representing days of the week. MSB=Sunday, LSB=Saturday.

Returns:

integer bit field

setWeeklyDays

public void setWeeklyDays(Integer days)

Sets a bit field representing days of the week. MSB=Sunday, LSB=Saturday.

Parameters:

days - integer bit field

getMonthlyRelative

public boolean getMonthlyRelative()

Retrieves the monthly relative flag.

Returns:

boolean flag

setMonthlyRelative

public void setMonthlyRelative(boolean relative)

Sets the monthly relative flag.

Parameters:

relative - boolean flag

getYearlyAbsolute

public boolean getYearlyAbsolute()

Retrieve the yearly relative flag.

Returns:

boolean flag

setYearlyAbsolute

public void setYearlyAbsolute(boolean absolute)

Set the yearly relative flag.

Parameters:

absolute - boolean flag

getDailyFrequency

public Integer getDailyFrequency()

Retrieves the recurring task frequency.

Returns:

recurring task frequency

setDailyFrequency

public void setDailyFrequency(Integer frequency)

Set the recurring task frequency.

Parameters:

frequency - recurring task frequency

getWeeklyFrequency

public Integer getWeeklyFrequency()

Retrieves the recurring task frequency.

Returns:

recurring task frequency

setWeeklyFrequency

public void setWeeklyFrequency(Integer frequency)

Set the recurring task frequency.

Parameters:

frequency - recurring task frequency

getMonthlyRelativeOrdinal

public Integer getMonthlyRelativeOrdinal()

Retrieves the monthly relative ordinal value.

Returns:

monthly relative ordinal value

setMonthlyRelativeOrdinal

public void setMonthlyRelativeOrdinal(Integer ordinal)

Sets the monthly relative ordinal value.

Parameters:

ordinal - monthly relative ordinal value

getMonthlyRelativeDay

public Day getMonthlyRelativeDay()

Retrieves the monthly relative day.

Returns:

monthly relative day

setMonthlyRelativeDay

public void setMonthlyRelativeDay(Day day)

Sets the monthly relative day.

Parameters:

day - monthly relative day

getMonthlyRelativeFrequency

public Integer getMonthlyRelativeFrequency()

Sets the monthly relative frequency.

Returns:

monthly relative frequency

setMonthlyRelativeFrequency

public void setMonthlyRelativeFrequency(Integer frequency)

Retrieves the monthly relative frequency.

Parameters:

frequency - monthly relative frequency

getMonthlyAbsoluteDay

public Integer getMonthlyAbsoluteDay()

Retrieves the monthly absolute day.

Returns:

monthly absolute day.

setMonthlyAbsoluteDay

public void setMonthlyAbsoluteDay(Integer day)

Sets the monthly absolute day.

Parameters:

day - monthly absolute day

getMonthlyAbsoluteFrequency

public Integer getMonthlyAbsoluteFrequency()

Retrieves the monthly absolute frequency.

Returns:

monthly absolute frequency

setMonthlyAbsoluteFrequency

public void setMonthlyAbsoluteFrequency(Integer frequency)

Sets the monthly absolute frequency.

Parameters:

frequency - monthly absolute frequency

getYearlyRelativeOrdinal

public Integer getYearlyRelativeOrdinal()

Retrieves the yearly relative ordinal.

Returns:

yearly relative ordinal

setYearlyRelativeOrdinal

public void setYearlyRelativeOrdinal(Integer ordinal)

Sets the yearly relative ordinal.

Parameters:

ordinal - yearly relative ordinal

getYearlyRelativeDay

public Day getYearlyRelativeDay()

Retrieve the yearly relative day.

Returns:

yearly relative day

setYearlyRelativeDay

public void setYearlyRelativeDay(Day day)

Sets the yearly relative day.

Parameters:

day - yearly relative day

getYearlyRelativeMonth

public Integer getYearlyRelativeMonth()

Retrieves the yearly relative month.

Returns:

yearly relative month

setYearlyRelativeMonth

public void setYearlyRelativeMonth(Integer month)

Sets the yearly relative month.

Parameters:

month - yearly relative month

getYearlyAbsoluteDate

public Date getYearlyAbsoluteDate()

Retrieves the yearly absolute date.

Returns:

yearly absolute date

setYearlyAbsoluteDate

public void setYearlyAbsoluteDate(Date date)

Sets the yearly absolute date.

Parameters:

date - yearly absolute date

toString

public String toString()

Overrides:

toString in class Object