com.prozima.pengine
Class NodeDates

java.lang.Object
  extended by com.prozima.pengine.NodeDates
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
ActivityDates, MilestoneDates

public abstract class NodeDates
extends java.lang.Object
implements java.lang.Cloneable

Holds a description of the start and finish dates which have been assigned to a schedule node by PEngine.


Method Summary
 NodeDates clone()
           
 java.util.Date getActualFinishDate()
          Retrieve the actual finish date of the ScheduleNode.
 java.util.Date getActualStartDate()
          Retrieve the actual start date of the ScheduleNode.
 java.lang.Integer getNodeID()
          Retrieve the ID of the Schedule Node.
 java.lang.Integer getProjectID()
          Retrieve the ID of the parent Project.
 java.util.Date getScheduledFinishDate()
          Retrieve the scheduled finish date of the ScheduleNode.
 java.util.Date getScheduledStartDate()
          Retrieve the scheduled start date of the ScheduleNode.
 java.lang.Integer getScheduleID()
          Retrieve the ID of the parent Schedule.
 boolean isCritical()
          Query if the ScheduleNode is on the critical path.
 boolean isFinished()
          Query if this ScheduleNode has been finished i.e.
 boolean isScheduled()
          Query if this ScheduleNode has had its start and finish dates correctly scheduled.
 boolean isStarted()
          Query if this ScheduleNode has been started i.e.
 void setScheduledFinishDate(java.util.Date inDate)
          Store the scheduled finish date of the ScheduleNode.
 void setScheduledStartDate(java.util.Date inDate)
          Store the scheduled start date of the ScheduleNode.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

clone

public NodeDates clone()
                throws java.lang.CloneNotSupportedException
Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException

getActualFinishDate

public java.util.Date getActualFinishDate()
Retrieve the actual finish date of the ScheduleNode.

Returns:
Finish date or null if no date is set.

getActualStartDate

public java.util.Date getActualStartDate()
Retrieve the actual start date of the ScheduleNode.

Returns:
Start date or null if no date is set.

getNodeID

public java.lang.Integer getNodeID()
Retrieve the ID of the Schedule Node.

Returns:
ID of the Schedule Node. null should never be returned.

getProjectID

public java.lang.Integer getProjectID()
Retrieve the ID of the parent Project.

Returns:
ID of a Project. null should never be returned.

getScheduledFinishDate

public java.util.Date getScheduledFinishDate()
Retrieve the scheduled finish date of the ScheduleNode.

Returns:
Finish date or null if no date is set.

getScheduledStartDate

public java.util.Date getScheduledStartDate()
Retrieve the scheduled start date of the ScheduleNode.

Returns:
Start date or null if no date is set.

getScheduleID

public java.lang.Integer getScheduleID()
Retrieve the ID of the parent Schedule.

Returns:
ID of a Schedule. null should never be returned.

isCritical

public boolean isCritical()
Query if the ScheduleNode is on the critical path.

Returns:
true if the node is on the critical path, otherwise false.

isFinished

public boolean isFinished()
Query if this ScheduleNode has been finished i.e. all the required work has been logged towards the ScheduleNode if it´s an Activity or all work has been logged towards its predecessor if it´s a Milestone.

Returns:
true if the ScheduleNode has finished, otherwise false.

isScheduled

public boolean isScheduled()
Query if this ScheduleNode has had its start and finish dates correctly scheduled. Schedule dates are not calculated when the node is already finished, therefore finished nodes also return true.

Returns:
true if the ScheduleNode is correctly scheduled. false if one or more of the scheduled dates has not been calculated. A finished node also returns true.

isStarted

public boolean isStarted()
Query if this ScheduleNode has been started i.e. work has been logged towards the ScheduleNode if its an Activity or work has been logged towards a predecessor if it´s a Milestone.

Returns:
true if the ScheduleNode has started, otherwise false.

setScheduledFinishDate

public void setScheduledFinishDate(java.util.Date inDate)
Store the scheduled finish date of the ScheduleNode.

Parameters:
inDate - New scheduled data or null if stored date is being cancelled.

setScheduledStartDate

public void setScheduledStartDate(java.util.Date inDate)
Store the scheduled start date of the ScheduleNode.

Parameters:
inDate - New scheduled data or null if stored date is being cancelled.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object