MPXJ: Microsoft Project Exchange

net.sf.mpxj
Class ProjectCalendarException

java.lang.Object
  net.sf.mpxj.ProjectCalendarDateRanges
      net.sf.mpxj.ProjectCalendarException

All Implemented Interfaces:

java.lang.Comparable<ProjectCalendarException>, java.lang.Iterable<DateRange>

public final class ProjectCalendarException
extends ProjectCalendarDateRanges
implements java.lang.Comparable<ProjectCalendarException>

This class represents instances of Calendar Exception records from an MPX file. It is used to define exceptions to the working days described in both base and resource calendars.

Constructor Summary

ProjectCalendarException()

Method Summary

int	compareTo(ProjectCalendarException o)
boolean	contains(java.util.Date date) This method determines whether the given date falls in the range of dates covered by this exception.
java.util.Date	getFromDate() Returns the from date.
java.util.Date	getToDate() Get to date.
boolean	getWorking() Gets working status.
void	setFromDate(java.util.Date from) Sets from date.
void	setToDate(java.util.Date to) Sets To Date.
void	setWorking(boolean flag) Sets working status of this exception.
java.lang.String	toString()

Methods inherited from class net.sf.mpxj.ProjectCalendarDateRanges

addRange, getRange, getRangeCount, iterator, setRange

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectCalendarException

public ProjectCalendarException()

Method Detail

getFromDate

public java.util.Date getFromDate()

Returns the from date.

Returns:

Date

setFromDate

public void setFromDate(java.util.Date from)

Sets from date.

Parameters:

from - date

getToDate

public java.util.Date getToDate()

Get to date.

Returns:

Date

setToDate

public void setToDate(java.util.Date to)

Sets To Date.

Parameters:

to - Date

getWorking

public boolean getWorking()

Gets working status.

Returns:

boolean value

setWorking

public void setWorking(boolean flag)

Sets working status of this exception.

Parameters:

flag - Boolean flag

contains

public boolean contains(java.util.Date date)

This method determines whether the given date falls in the range of dates covered by this exception. Note that this method assumes that both the start and end date of this exception have been set.

Parameters:

date - Date to be tested

Returns:

Boolean value

compareTo

public int compareTo(ProjectCalendarException o)

Specified by:

compareTo in interface java.lang.Comparable<ProjectCalendarException>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object