org.mpxj

Class ProjectCalendarWeek

java.lang.Object

org.mpxj.ProjectCalendarDays

org.mpxj.ProjectCalendarWeek

All Implemented Interfaces:

Comparable<ProjectCalendarWeek>

public class ProjectCalendarWeek
extends ProjectCalendarDays
implements Comparable<ProjectCalendarWeek>

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

Field Summary

Fields inherited from class org.mpxj.ProjectCalendarDays

DEFAULT_WORKING_AFTERNOON, DEFAULT_WORKING_MORNING

Constructor Summary

Constructors

Constructor and Description
ProjectCalendarWeek()

Method Summary

Modifier and Type	Method and Description
int	compareTo(ProjectCalendarWeek o)
List<ProjectCalendarException>	convertToRecurringExceptions(LocalDate earliestStartDate, LocalDate latestFinishDate) Converts this working week into a set of equivalent recurring exceptions.
LocalDateRange	getDateRange() Retrieves the data range for which this week is valid.
void	setDateRange(LocalDateRange range) Sets the date range for this week.
String	toString()

Methods inherited from class org.mpxj.ProjectCalendarDays

addCalendarHours, addDefaultCalendarDays, addDefaultCalendarHours, addDefaultCalendarHours, getCalendarDayType, getCalendarDayTypes, getCalendarHours, getCalendarHours, getName, removeCalendarHours, setCalendarDayType, setName, setWorkingDay

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectCalendarWeek

public ProjectCalendarWeek()

Method Detail

getDateRange

public LocalDateRange getDateRange()

Retrieves the data range for which this week is valid. Returns null if this is the default week.

Returns:

date range, or null

setDateRange

public void setDateRange(LocalDateRange range)

Sets the date range for this week. Set this to null to indicate the default week.

Parameters:

range - date range, or null

convertToRecurringExceptions

public List<ProjectCalendarException> convertToRecurringExceptions(LocalDate earliestStartDate,
                                                                   LocalDate latestFinishDate)

Converts this working week into a set of equivalent recurring exceptions. Note that this can't be applied to the default working week.

Parameters:

earliestStartDate - earliest start date for recurring exceptions

latestFinishDate - latest finish date for recurring exceptions

Returns:

recurring exceptions equivalent to this working week

compareTo

public int compareTo(ProjectCalendarWeek o)

Specified by:

compareTo in interface Comparable<ProjectCalendarWeek>

toString

public String toString()

Overrides:

toString in class Object