com.prozima.pengine
Class Schedule

java.lang.Object
  com.prozima.pengine.Schedule

All Implemented Interfaces:

java.lang.Cloneable

public class Schedule
extends java.lang.Object
implements java.lang.Cloneable

Encapsulates all the information which describes a schedule. Each schedule consists of activities and milestones which may have interconnecting relationships.

Constructor Summary

Schedule()

Method Summary

boolean	addNodeID(int inID) Add the ID of schedule node to the schedule.
Schedule	clone()
boolean	equals(java.lang.Object inOtherObject)
java.lang.Integer	getID() Retrieve the ID of the schedule.
java.lang.String	getName() Retrieve the name of the Schedule.
java.util.Set<java.lang.Integer>	getNodeIDs() Retrieve the IDs of the nodes that make up the schedule.
java.lang.Integer	getProjectID() Retrieve the ID of the parent project.
int	hashCode()
boolean	isBaseline() Retrieve the baseline status of this schedule.
boolean	setID(int inID) Set the ID of the schedule.
void	setIsBaseline(boolean inIsBaseline) Sets the baseline status of the schedule.
boolean	setName(java.lang.String inName) Set the name of the Schedule.
boolean	setProjectID(int inID) Set the ID of the parent project.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Schedule

public Schedule()

Method Detail

addNodeID

public boolean addNodeID(int inID)

Add the ID of schedule node to the schedule.

Parameters:

inID - ID of a schedule node.

clone

public Schedule clone()
               throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object inOtherObject)

Overrides:

equals in class java.lang.Object

getID

public java.lang.Integer getID()

Retrieve the ID of the schedule.

Returns:

Integer containing the ID of the schedule or null if its not yet assigned an ID.

getName

public java.lang.String getName()

Retrieve the name of the Schedule.

Returns:

String containing the name of the Schedule. May be null if it was not set.

getNodeIDs

public java.util.Set<java.lang.Integer> getNodeIDs()

Retrieve the IDs of the nodes that make up the schedule.

Returns:

A set of schedule node IDs. Set may be empty if the schedule contains no nodes. null should not be returned.

getProjectID

public java.lang.Integer getProjectID()

Retrieve the ID of the parent project.

Returns:

ID of a project or null if it has not been set.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isBaseline

public boolean isBaseline()

Retrieve the baseline status of this schedule.

Returns:

true if the schedule is a baseline.

setID

public boolean setID(int inID)

Set the ID of the schedule.

Returns:

Always returns true.

setIsBaseline

public void setIsBaseline(boolean inIsBaseline)

Sets the baseline status of the schedule.

Parameters:

inIsBaseline - true if the schedule IS a baseline schedule.

setName

public boolean setName(java.lang.String inName)

Set the name of the Schedule.

Returns:

true if the name was not null and contains characters, otherwise false.

setProjectID

public boolean setProjectID(int inID)

Set the ID of the parent project.

Returns:

true if new ID was valid, otherwise false.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object