net.sf.mpxj

Class ProjectConfig

java.lang.Object

net.sf.mpxj.ProjectConfig

public class ProjectConfig
extends Object

Container for configuration details used to control the behaviour of the ProjectFile class.

Constructor Summary

Constructors

Constructor and Description
ProjectConfig(ProjectFile projectFile) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	getAutoAssignmentUniqueID() Retrieve the flag that determines whether the assignment unique ID is generated automatically.
boolean	getAutoCalendarUniqueID() Retrieve the flag that determines whether the calendar unique ID is generated automatically.
boolean	getAutoOutlineLevel() Retrieve the flag that determines whether outline level is generated automatically.
boolean	getAutoOutlineNumber() Retrieve the flag that determines whether outline numbers are generated automatically.
boolean	getAutoRelationUniqueID() Retrieve the flag that determines whether the relation unique ID is generated automatically.
boolean	getAutoResourceID() Retrieve the flag that determines whether the resource ID is generated automatically.
boolean	getAutoResourceUniqueID() Retrieve the flag that determines whether the resource unique ID is generated automatically.
boolean	getAutoTaskID() Retrieve the flag that determines whether the task ID is generated automatically.
boolean	getAutoTaskUniqueID() Retrieve the flag that determines whether the task unique ID is generated automatically.
boolean	getAutoWBS() Retrieve the flag that determines whether WBS is generated automatically.
BaselineStrategy	getBaselineStrategy() Retrieve the strategy used by this project to populate baseline attributes from another schedule.
boolean	getCompleteThroughIsNextWorkStart() Returns true if a task's Complete Through attribute is reported as the time work can next start.
int	getNextCalendarUniqueID() Deprecated. use ProjectFile.getCalendars().getNextUniqueID()
int	getNextRelationUniqueID() Deprecated. use ProjectFile.getRelations().getNextUniqueID()
int	getNextResourceID() Deprecated. use ProjectFile.getResources().getNextID()
int	getNextResourceUniqueID() Deprecated. use ProjectFile.getResources().getNextUniqueID()
int	getNextTaskID() Deprecated. use ProjectFile.getTasks().getNextID()
int	getNextTaskUniqueID() Deprecated. use ProjectFile.getTasks().getNextUniqueID()
File	getSubprojectWorkingDirectory() Retrieve the directory to search for subproject files.
void	setAutoAssignmentUniqueID(boolean flag) Used to set whether the assignment unique ID field is automatically populated.
void	setAutoCalendarUniqueID(boolean flag) Used to set whether the calendar unique ID field is automatically populated.
void	setAutoOutlineLevel(boolean flag) Used to set whether outline level numbers are automatically created.
void	setAutoOutlineNumber(boolean flag) Used to set whether outline numbers are automatically created.
void	setAutoRelationUniqueID(boolean flag) Used to set whether the relation unique ID field is automatically populated.
void	setAutoResourceID(boolean flag) Used to set whether the resource ID field is automatically populated.
void	setAutoResourceUniqueID(boolean flag) Used to set whether the resource unique ID field is automatically populated.
void	setAutoTaskID(boolean flag) Used to set whether the task ID field is automatically populated.
void	setAutoTaskUniqueID(boolean flag) Used to set whether the task unique ID field is automatically populated.
void	setAutoWBS(boolean flag) Used to set whether WBS numbers are automatically created.
void	setBaselineStrategy(BaselineStrategy strategy) Set the strategy used by this project to populate baseline attributes from another schedule.
void	setCompleteThroughIsNextWorkStart(boolean completeThroughIsNextWorkStart) When set to true a task's Complete Through attribute is reported as the time work can next start.
void	setSubprojectWorkingDirectory(File workingDirectory) Specify a directory to use when searching for subproject files to expand.
void	updateAssignmentUniqueCounter() Deprecated.
void	updateCalendarUniqueCounter() Deprecated. use ProjectFile.getResources().updateUniqueIdCounter()
void	updateResourceUniqueCounter() Deprecated. use ProjectFile.getResources().updateUniqueIdCounter()
void	updateTaskUniqueCounter() Deprecated. use ProjectFile.getTasks().updateUniqueIdCounter()
void	updateUniqueCounters() Deprecated. use ProjectFile.updateUniqueCounters

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectConfig

public ProjectConfig(ProjectFile projectFile)

Constructor.

Parameters:

projectFile - parent project

Method Detail

setAutoWBS

public void setAutoWBS(boolean flag)

Used to set whether WBS numbers are automatically created.

Parameters:

flag - true if automatic WBS required.

setAutoOutlineLevel

public void setAutoOutlineLevel(boolean flag)

Used to set whether outline level numbers are automatically created.

Parameters:

flag - true if automatic outline level required.

setAutoOutlineNumber

public void setAutoOutlineNumber(boolean flag)

Used to set whether outline numbers are automatically created.

Parameters:

flag - true if automatic outline number required.

setAutoTaskUniqueID

public void setAutoTaskUniqueID(boolean flag)

Used to set whether the task unique ID field is automatically populated.

Parameters:

flag - true if automatic unique ID required.

setAutoCalendarUniqueID

public void setAutoCalendarUniqueID(boolean flag)

Used to set whether the calendar unique ID field is automatically populated.

Parameters:

flag - true if automatic unique ID required.

setAutoAssignmentUniqueID

public void setAutoAssignmentUniqueID(boolean flag)

Used to set whether the assignment unique ID field is automatically populated.

Parameters:

flag - true if automatic unique ID required.

setAutoTaskID

public void setAutoTaskID(boolean flag)

Used to set whether the task ID field is automatically populated.

Parameters:

flag - true if automatic ID required.

getAutoWBS

public boolean getAutoWBS()

Retrieve the flag that determines whether WBS is generated automatically.

Returns:

boolean, default is false.

getAutoOutlineLevel

public boolean getAutoOutlineLevel()

Retrieve the flag that determines whether outline level is generated automatically.

Returns:

boolean, default is false.

getAutoOutlineNumber

public boolean getAutoOutlineNumber()

Retrieve the flag that determines whether outline numbers are generated automatically.

Returns:

boolean, default is false.

getAutoTaskUniqueID

public boolean getAutoTaskUniqueID()

Retrieve the flag that determines whether the task unique ID is generated automatically.

Returns:

boolean, default is false.

getAutoCalendarUniqueID

public boolean getAutoCalendarUniqueID()

Retrieve the flag that determines whether the calendar unique ID is generated automatically.

Returns:

boolean, default is false.

getAutoAssignmentUniqueID

public boolean getAutoAssignmentUniqueID()

Retrieve the flag that determines whether the assignment unique ID is generated automatically.

Returns:

boolean, default is true.

getAutoTaskID

public boolean getAutoTaskID()

Retrieve the flag that determines whether the task ID is generated automatically.

Returns:

boolean, default is false.

setAutoResourceUniqueID

public void setAutoResourceUniqueID(boolean flag)

Used to set whether the resource unique ID field is automatically populated.

Parameters:

flag - true if automatic unique ID required.

setAutoResourceID

public void setAutoResourceID(boolean flag)

Used to set whether the resource ID field is automatically populated.

Parameters:

flag - true if automatic ID required.

getAutoResourceUniqueID

public boolean getAutoResourceUniqueID()

Retrieve the flag that determines whether the resource unique ID is generated automatically.

Returns:

boolean, default is false.

getAutoResourceID

public boolean getAutoResourceID()

Retrieve the flag that determines whether the resource ID is generated automatically.

Returns:

boolean, default is false.

setAutoRelationUniqueID

public void setAutoRelationUniqueID(boolean flag)

Used to set whether the relation unique ID field is automatically populated.

Parameters:

flag - true if automatic unique ID required.

getAutoRelationUniqueID

public boolean getAutoRelationUniqueID()

Retrieve the flag that determines whether the relation unique ID is generated automatically.

Returns:

boolean, default is false.

getNextTaskUniqueID

@Deprecated
public int getNextTaskUniqueID()

Deprecated. use ProjectFile.getTasks().getNextUniqueID()

This method is used to retrieve the next unique ID for a task.

Returns:

next unique ID

getNextCalendarUniqueID

@Deprecated
public int getNextCalendarUniqueID()

Deprecated. use ProjectFile.getCalendars().getNextUniqueID()

This method is used to retrieve the next unique ID for a calendar.

Returns:

next unique ID

getNextTaskID

@Deprecated
public int getNextTaskID()

Deprecated. use ProjectFile.getTasks().getNextID()

This method is used to retrieve the next ID for a task.

Returns:

next ID

getNextResourceUniqueID

@Deprecated
public int getNextResourceUniqueID()

Deprecated. use ProjectFile.getResources().getNextUniqueID()

This method is used to retrieve the next unique ID for a resource.

Returns:

next unique ID

getNextResourceID

@Deprecated
public int getNextResourceID()

Deprecated. use ProjectFile.getResources().getNextID()

This method is used to retrieve the next ID for a resource.

Returns:

next ID

getNextRelationUniqueID

@Deprecated
public int getNextRelationUniqueID()

Deprecated. use ProjectFile.getRelations().getNextUniqueID()

This method is used to retrieve the next unique ID for a relation.

Returns:

next unique ID

getCompleteThroughIsNextWorkStart

public boolean getCompleteThroughIsNextWorkStart()

Returns true if a task's Complete Through attribute is reported as the time work can next start. Defaults to false. When set to true this matches the behaviour of MS Project versions prior to 2007.

Returns:

true if Complete Through is next work start date

setCompleteThroughIsNextWorkStart

public void setCompleteThroughIsNextWorkStart(boolean completeThroughIsNextWorkStart)

When set to true a task's Complete Through attribute is reported as the time work can next start. Defaults to false. When set to true this matches the behaviour of MS Project versions prior to 2007.

Parameters:

completeThroughIsNextWorkStart - true if Complete Through is next work start date

updateUniqueCounters

@Deprecated
public void updateUniqueCounters()

Deprecated. use ProjectFile.updateUniqueCounters

This method is called to ensure that after a project file has been read, the cached unique ID values used to generate new unique IDs start after the end of the existing set of unique IDs.

updateTaskUniqueCounter

@Deprecated
public void updateTaskUniqueCounter()

Deprecated. use ProjectFile.getTasks().updateUniqueIdCounter()

Ensure unique ID counter is in sync with project file.

updateResourceUniqueCounter

@Deprecated
public void updateResourceUniqueCounter()

Deprecated. use ProjectFile.getResources().updateUniqueIdCounter()

Ensure unique ID counter is in sync with project file.

updateCalendarUniqueCounter

@Deprecated
public void updateCalendarUniqueCounter()

Deprecated. use ProjectFile.getResources().updateUniqueIdCounter()

Ensure unique ID counter is in sync with project file.

updateAssignmentUniqueCounter

@Deprecated
public void updateAssignmentUniqueCounter()

Deprecated.

Ensure unique ID counter is in sync with project file.

getBaselineStrategy

public BaselineStrategy getBaselineStrategy()

Retrieve the strategy used by this project to populate baseline attributes from another schedule.

Returns:

baseline strategy

setBaselineStrategy

public void setBaselineStrategy(BaselineStrategy strategy)

Set the strategy used by this project to populate baseline attributes from another schedule.

Parameters:

strategy - baseline strategy

setSubprojectWorkingDirectory

public void setSubprojectWorkingDirectory(File workingDirectory)

Specify a directory to use when searching for subproject files to expand. MPXJ will attempt to use the full path of a subproject when attempting to expand it, or the process working directory. If a value is supplied here, this directory will be used instead of the process working directory.

Parameters:

workingDirectory - directory to search for subproject files

getSubprojectWorkingDirectory

public File getSubprojectWorkingDirectory()

Retrieve the directory to search for subproject files.

Returns:

directory to search for subproject files