net.sf.mpxj

Class ProjectCalendarDays

java.lang.Object

net.sf.mpxj.ProjectCalendarDays

Direct Known Subclasses:

ProjectCalendar, ProjectCalendarWeek

public abstract class ProjectCalendarDays
extends Object

This class represents a basic working week, with no exceptions.

Field Summary

Fields

Modifier and Type	Field and Description
static LocalTimeRange	DEFAULT_WORKING_AFTERNOON
static LocalTimeRange	DEFAULT_WORKING_MORNING Constants representing the default working morning and afternoon hours.

Constructor Summary

Constructors

Constructor and Description
ProjectCalendarDays()

Method Summary

Modifier and Type	Method and Description
ProjectCalendarHours	addCalendarHours(DayOfWeek day) Used to add working hours to the calendar.
void	addDefaultCalendarDays() Convenience method to set up a standard working week.
void	addDefaultCalendarHours() This is a convenience method used to add a default set of calendar hours to a calendar.
void	addDefaultCalendarHours(DayOfWeek day) This is a convenience method used to add a default set of calendar hours to a calendar.
DayType	getCalendarDayType(DayOfWeek day) This method allows the retrieval of the actual working day flag, which can take the values DEFAULT, WORKING, or NONWORKING.
DayType[]	getCalendarDayTypes() Retrieves an array of DayType instances representing a week, where Sunday is the first entry in the array.
ProjectCalendarHours[]	getCalendarHours() Retrieves an array representing the working hours for each day of the week, where Sunday is the first entry in the array.
ProjectCalendarHours	getCalendarHours(DayOfWeek day) This method retrieves the calendar hours for the specified day.
String	getName() Calendar name.
void	removeCalendarHours(DayOfWeek day) Used to remove working hours from the calendar.
void	setCalendarDayType(DayOfWeek day, DayType type) Set the type of a given day.
void	setName(String name) Calendar name.
void	setWorkingDay(DayOfWeek day, boolean working) This is a convenience method provided to allow the day type to be set as working or non-working by supplying a simple Boolean argument.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WORKING_MORNING

public static final LocalTimeRange DEFAULT_WORKING_MORNING

Constants representing the default working morning and afternoon hours.

DEFAULT_WORKING_AFTERNOON

public static final LocalTimeRange DEFAULT_WORKING_AFTERNOON

Constructor Detail

ProjectCalendarDays

public ProjectCalendarDays()

Method Detail

setName

public void setName(String name)

Calendar name.

Parameters:

name - calendar name

getName

public String getName()

Calendar name.

Returns:

calendar name

getCalendarHours

public ProjectCalendarHours[] getCalendarHours()

Retrieves an array representing the working hours for each day of the week, where Sunday is the first entry in the array.

Returns:

array of ProjectCalendarHours instances, one for each week day

getCalendarHours

public ProjectCalendarHours getCalendarHours(DayOfWeek day)

This method retrieves the calendar hours for the specified day. Note that this method only returns the hours specification for the current calendar.If this is a derived calendar, it does not refer to the base calendar.

Parameters:

day - Day instance

Returns:

calendar hours

addDefaultCalendarHours

public void addDefaultCalendarHours()

This is a convenience method used to add a default set of calendar hours to a calendar.

addDefaultCalendarDays

public void addDefaultCalendarDays()

Convenience method to set up a standard working week.

addDefaultCalendarHours

public void addDefaultCalendarHours(DayOfWeek day)

This is a convenience method used to add a default set of calendar hours to a calendar.

Parameters:

day - Day for which to add default hours for

addCalendarHours

public ProjectCalendarHours addCalendarHours(DayOfWeek day)

Used to add working hours to the calendar.

Parameters:

day - target day

Returns:

new ProjectCalendarHours instance

removeCalendarHours

public void removeCalendarHours(DayOfWeek day)

Used to remove working hours from the calendar.

Parameters:

day - target day

getCalendarDayTypes

public DayType[] getCalendarDayTypes()

Retrieves an array of DayType instances representing a week, where Sunday is the first entry in the array.

Returns:

array of DayType instances

getCalendarDayType

public DayType getCalendarDayType(DayOfWeek day)

This method allows the retrieval of the actual working day flag, which can take the values DEFAULT, WORKING, or NONWORKING. This differs from the isWorkingDay method as it retrieves the actual flag value. The isWorkingDay method will always refer back to the base calendar to get a boolean value if the underlying flag value is DEFAULT. If isWorkingDay were the only method available to access this flag, it would not be possible to determine that a resource calendar had one or more flags set to DEFAULT.

Parameters:

day - required day

Returns:

value of underlying working day flag

setWorkingDay

public void setWorkingDay(DayOfWeek day,
                          boolean working)

This is a convenience method provided to allow the day type to be set as working or non-working by supplying a simple Boolean argument.

Parameters:

day - required day

working - flag indicating if the day is a working day

setCalendarDayType

public void setCalendarDayType(DayOfWeek day,
                               DayType type)

Set the type of a given day.

Parameters:

day - required day

type - day type flag