MPXJ: Microsoft Project Exchange

net.sf.mpxj
Class ProjectHeader

java.lang.Object
  extended by net.sf.mpxj.ProjectEntity
      extended by net.sf.mpxj.ProjectHeader

public final class ProjectHeader
extends ProjectEntity

This class represents the ProjectHeader record as found in an MPX file. This record contains details of global settings relevant to the project plan. Note that a number of the fields in this record are calculated by Microsoft Project, and will therefore be ignored on import.


Constructor Summary
ProjectHeader(ProjectFile file)
          Default constructor.
 
Method Summary
 java.lang.Number getActualCost()
          Retrieves the actual project cost.
 Duration getActualDuration()
          Retrieves the actual project duration.
 java.util.Date getActualFinish()
          Retrieves the actual project finish date.
 boolean getActualsInSync()
          Retrieve the actuals in sync flag.
 java.util.Date getActualStart()
          Retrieves the actual project start date.
 Duration getActualWork()
          Retrieves the actual project work duration.
 boolean getAdminProject()
          Retrieve the admin project flag.
 java.lang.String getAMText()
          Gets the AM text.
 java.lang.String getAuthor()
          Retrieves the project author text.
 boolean getAutoAddNewResourcesAndTasks()
          Retrieve the auto add new resources and tasks flag.
 boolean getAutolink()
          Retrieves the autolink flag.
 ProjectDateFormat getBarTextDateFormat()
          Gets Bar Text Date Format.
 java.lang.Number getBaselineCost()
          Retrieves the baseline project cost.
 java.util.Date getBaselineDate(int index)
          Retrieve the date for a specific baseline.
 Duration getBaselineDuration()
          Retrieves the baseline duration value.
 java.util.Date getBaselineFinish()
          Retrieves the baseline project finish date.
 java.lang.Integer getBaselineForEarnedValue()
          Retrieve the number of the baseline to use for earned value calculations.
 java.util.Date getBaselineStart()
          Retrieves the baseline project start date.
 Duration getBaselineWork()
          Retrieves the baseline project work duration.
 boolean getCalculateMultipleCriticalPaths()
          Retrieves the calculate multiple critical paths flag.
 java.lang.String getCalendarName()
          Gets the Calendar used.
 java.lang.String getCategory()
          Retrieves the category text.
 java.lang.String getComments()
          Returns any comments.
 java.lang.String getCompany()
          Retrieves the company name.
 java.lang.Number getCost()
          Retrieves the project cost.
 java.util.Date getCreationDate()
          Retrieve the project creation date.
 java.lang.Integer getCriticalSlackLimit()
          Retrieve the critical slack limit.
 java.lang.String getCurrencyCode()
          Retrieve the currency code for this project.
 java.lang.Number getCurrencyDigits()
          Gets no of currency digits.
 java.lang.String getCurrencySymbol()
          Retrieves the currency symbol.
 java.util.Date getCurrentDate()
          Retrieves the current date.
 ProjectDateFormat getDateFormat()
          Gets the set Date Format.
 DateOrder getDateOrder()
          Gets constant representing set Date order eg DMY, MDY.
 char getDateSeparator()
          Gets the date separator.
 java.lang.Number getDaysPerMonth()
          Retrieve the number of days per month.
 char getDecimalSeparator()
          Gets the decimal separator.
 boolean getDefaultDurationIsFixed()
          Retrieves a flag indicating if the default duration type is fixed.
 TimeUnit getDefaultDurationUnits()
          Gets Default Duration units.
 java.util.Date getDefaultEndTime()
          Retrieves the default end time.
 AccrueType getDefaultFixedCostAccrual()
          Retrieve the default fixed cost accrual type.
 Rate getDefaultOvertimeRate()
          Get overtime rate.
 Rate getDefaultStandardRate()
          Retrieves the default standard rate.
 java.util.Date getDefaultStartTime()
          Retrieve the default start time, specified using the Java Date type.
 EarnedValueMethod getDefaultTaskEarnedValueMethod()
          Retrieves the default task earned value method.
 TaskType getDefaultTaskType()
          Retrieve the default task type.
 TimeUnit getDefaultWorkUnits()
          Default work units.
 java.util.Map<java.lang.Integer,java.lang.Object> getDocumentSummaryInformation()
          Retrieve the Document Summary Information.
 Duration getDuration()
          Retrieves the project duration.
 EarnedValueMethod getEarnedValueMethod()
          Retrieve the earned value method.
 boolean getEditableActualCosts()
          Retrieve the editable actual costs flag.
 java.util.Date getExtendedCreationDate()
          Retrieve the extended creation date.
 java.util.Date getFinishDate()
          Retrieves the project finish date.
 Duration getFinishVariance()
          Retrieves the project finish variance duration.
 boolean getFiscalYearStart()
          Retrieve the fiscal year start flag.
 java.lang.Integer getFiscalYearStartMonth()
          Retrieves the fiscal year start month (January=1, December=12).
 boolean getHonorConstraints()
          Retrieves the honor constraints flag.
 java.lang.String getHyperlinkBase()
          Gets the hyperlink base for this Project.
 boolean getInsertedProjectsLikeSummary()
          Retrieves the inserted projects like summary flag.
 java.lang.String getKeywords()
          Retrieves the project keyword text.
 java.util.Date getLastSaved()
          Retrieve the last saved date.
 java.lang.String getManager()
          Retrieves the manager name.
 boolean getMicrosoftProjectServerURL()
          Retrieves the Microsoft Project Server URL flag.
 java.lang.Number getMinutesPerDay()
          Retrieve the number of minutes per day.
 java.lang.Number getMinutesPerWeek()
          Retrieve the number of minutes per week.
 boolean getMoveCompletedEndsBack()
          Retrieve the move completed ends back flag.
 boolean getMoveCompletedEndsForward()
          Retrieve the move completed ends forward flag.
 boolean getMoveRemainingStartsBack()
          Retrieves the move remaining starts back flag.
 boolean getMoveRemainingStartsForward()
          Retrieve the move remaining starts forward flag.
 boolean getMultipleCriticalPaths()
          Retrieve the multiple critical paths flag.
 java.lang.String getName()
          Retrieves the project name.
 boolean getNewTasksEffortDriven()
          Retrieve the new tasks effort driven flag.
 boolean getNewTasksEstimated()
          Retrieve the new tasks estimated flag.
 boolean getNewTaskStartIsProjectStart()
          Retrieve the flag indicating if new tasks should default to the project start date (true) or the current date (false).
 java.lang.Number getPercentageComplete()
          Retrieves the project percentage complete.
 java.lang.String getPMText()
          Gets the PM text.
 boolean getProjectExternallyEdited()
          Retrieve the externally edited flag.
 java.lang.String getProjectTitle()
          Gets the project title.
 boolean getRemoveFileProperties()
          Retrieve the remove file properties flag.
 java.lang.Integer getRevision()
          Retrieve the project revision number.
 ScheduleFrom getScheduleFrom()
          Retrieves an enumerated value indicating if tasks in this project are scheduled from a start or a finish date.
 boolean getShowProjectSummaryTask()
          Retrieves the "show project summary task" flag.
 boolean getSplitInProgressTasks()
          Flag representing whether or not to split in-progress tasks.
 boolean getSpreadActualCost()
          Retrieve the spread actual cost flag.
 boolean getSpreadPercentComplete()
          Retrieves the spread percent complete flag.
 java.util.Date getStartDate()
          Retrieves the project start date.
 Duration getStartVariance()
          Retrieves the start variance duration.
 java.util.Date getStatusDate()
          Retrieve the status date.
 java.lang.String getSubject()
          Returns the project subject text.
 CurrencySymbolPosition getSymbolPosition()
          Retrieves a constant representing the position of the currency symbol.
 char getThousandsSeparator()
          Gets the thousands separator.
 ProjectTimeFormat getTimeFormat()
          Gets constant representing the Time Format.
 char getTimeSeparator()
          Gets the time separator.
 java.lang.String getUniqueID()
          Retrieve the unique ID for this project.
 boolean getUpdatingTaskStatusUpdatesResourceStatus()
          Flags whether updating Task status also updates resource status.
 Day getWeekStartDay()
          Retrieve the week start day.
 Duration getWork()
          Retrieves the project work duration.
 java.lang.Number getWork2()
          Retrieves the project's "Work 2" attribute.
 void setActualCost(java.lang.Number actualCost)
          Sets the actual project cost.
 void setActualDuration(Duration actualDuration)
          Sets the actual project duration.
 void setActualFinish(java.util.Date actualFinishDate)
          Sets the actual project finish date.
 void setActualsInSync(boolean actualsInSync)
          Set the actuals in sync flag.
 void setActualStart(java.util.Date actualStartDate)
          Sets the actual project start date.
 void setActualWork(Duration actualWork)
          Sets the actual project work duration.
 void setAdminProject(boolean adminProject)
          Set the admin project flag.
 void setAMText(java.lang.String amText)
          Sets the AM text.
 void setAuthor(java.lang.String author)
          Sets the project author text.
 void setAutoAddNewResourcesAndTasks(boolean autoAddNewResourcesAndTasks)
          Set the auto add new resources and tasks flag.
 void setAutolink(boolean autolink)
          Sets the autolink flag.
 void setBarTextDateFormat(ProjectDateFormat dateFormat)
          Sets Bar Text Date Format.
 void setBaselineCost(java.lang.Number baselineCost)
          Sets the baseline project cost.
 void setBaselineDate(int index, java.util.Date date)
          Set the date for a specific baseline.
 void setBaselineDuration(Duration baselineDuration)
          Sets the baseline project duration value.
 void setBaselineFinish(java.util.Date baselineFinishDate)
          Sets the baseline project finish date.
 void setBaselineForEarnedValue(java.lang.Integer baselineForEarnedValue)
          Set the number of the baseline to use for earned value calculations.
 void setBaselineStart(java.util.Date baselineStartDate)
          Sets the baseline project start date.
 void setBaselineWork(Duration baselineWork)
          Set the baseline project work duration.
 void setCalculateMultipleCriticalPaths(boolean flag)
          Sets the calculate multiple critical paths flag.
 void setCalendarName(java.lang.String calendarName)
          Sets the Calendar used.
 void setCategory(java.lang.String category)
          Sets the category text.
 void setComments(java.lang.String comments)
          Set comment text.
 void setCompany(java.lang.String company)
          Sets the company name.
 void setCost(java.lang.Number cost)
          Sets the project cost.
 void setCreationDate(java.util.Date creationDate)
          Set the project creation date.
 void setCriticalSlackLimit(java.lang.Integer criticalSlackLimit)
          Set the critical slack limit.
 void setCurrencyCode(java.lang.String currencyCode)
          Set the currency code for this project.
 void setCurrencyDigits(java.lang.Number currDigs)
          Sets no of currency digits.
 void setCurrencySymbol(java.lang.String symbol)
          Sets currency symbol.
 void setCurrentDate(java.util.Date currentDate)
          Sets the current date.
 void setDateFormat(ProjectDateFormat dateFormat)
          Sets the set Date Format.
 void setDateOrder(DateOrder dateOrder)
          Sets constant representing set Date order eg DMY, MDY.
 void setDateSeparator(char dateSeparator)
          Sets the date separator.
 void setDaysPerMonth(java.lang.Number daysPerMonth)
          Set the number of days per month.
 void setDecimalSeparator(char decSep)
          Sets the decimal separator.
 void setDefaultDurationIsFixed(boolean fixed)
          Sets a flag indicating if the default duration type is fixed.
 void setDefaultDurationUnits(TimeUnit units)
          Default duration units.
 void setDefaultEndTime(java.util.Date date)
          Sets the default end time.
 void setDefaultFixedCostAccrual(AccrueType defaultFixedCostAccrual)
          Sets the default fixed cost accrual type.
 void setDefaultOvertimeRate(Rate rate)
          Set default overtime rate.
 void setDefaultStandardRate(Rate rate)
          Sets the default standard rate.
 void setDefaultStartTime(java.util.Date defaultStartTime)
          Set the default start time, specified using the Java Date type.
 void setDefaultTaskEarnedValueMethod(EarnedValueMethod defaultTaskEarnedValueMethod)
          Sets the default task earned value method.
 void setDefaultTaskType(TaskType defaultTaskType)
          Set the default task type.
 void setDefaultWorkUnits(TimeUnit units)
          Default work units.
 void setDocumentSummaryInformation(java.util.Map<java.lang.Integer,java.lang.Object> documentSummaryInformation)
          Set the Document Summary Information.
 void setDuration(Duration duration)
          Sets the project duration.
 void setEarnedValueMethod(EarnedValueMethod earnedValueMethod)
          Set the earned value method.
 void setEditableActualCosts(boolean editableActualCosts)
          Set the editable actual costs flag.
 void setExtendedCreationDate(java.util.Date creationDate)
          Set the extended creation date.
 void setFinishDate(java.util.Date finishDate)
          Sets the project finish date.
 void setFinishVariance(Duration finishVariance)
          Sets the project finish variance duration.
 void setFiscalYearStart(boolean fiscalYearStart)
          Set the fiscal year start flag.
 void setFiscalYearStartMonth(java.lang.Integer fiscalYearStartMonth)
          Sets the fiscal year start month (January=1, December=12).
 void setHonorConstraints(boolean honorConstraints)
          Sets the honor constraints flag.
 void setHyperlinkBase(java.lang.String hyperlinkBase)
          Sets the hyperlink base for this Project.
 void setInsertedProjectsLikeSummary(boolean insertedProjectsLikeSummary)
          Sets the inserted projects like summary flag.
 void setIntegerDefaultStartTime(java.lang.Integer time)
          This internal method is used to convert from an integer representing minutes past midnight into a Date instance whose time component represents the start time.
 void setKeywords(java.lang.String keywords)
          Sets the project keyword text.
 void setLastSaved(java.util.Date lastSaved)
          Set the last saved date.
 void setManager(java.lang.String manager)
          Sets the manager name.
 void setMicrosoftProjectServerURL(boolean microsoftProjectServerURL)
          Sets the Microsoft Project Server URL flag.
 void setMinutesPerDay(java.lang.Number minutesPerDay)
          Set the number of minutes per day.
 void setMinutesPerWeek(java.lang.Number minutesPerWeek)
          Set the number of minutes per week.
 void setMoveCompletedEndsBack(boolean moveCompletedEndsBack)
          Set the move completed ends back flag.
 void setMoveCompletedEndsForward(boolean moveCompletedEndsForward)
          Sets the move completed ends forward flag.
 void setMoveRemainingStartsBack(boolean moveRemainingStartsBack)
          Sets the move remaining starts back flag.
 void setMoveRemainingStartsForward(boolean moveRemainingStartsForward)
          Set the move remaining starts forward flag.
 void setMultipleCriticalPaths(boolean multipleCriticalPaths)
          Set the multiple critical paths flag.
 void setName(java.lang.String name)
          Sets the project name.
 void setNewTasksEffortDriven(boolean newTasksEffortDriven)
          Sets the new tasks effort driven flag.
 void setNewTasksEstimated(boolean newTasksEstimated)
          Set the new tasks estimated flag.
 void setNewTaskStartIsProjectStart(boolean newTaskStartIsProjectStart)
          Sets the flag indicating if new tasks should default to the project start date (true) or the current date (false).
 void setPercentageComplete(java.lang.Number percentComplete)
          Sets project percentage complete.
 void setPMText(java.lang.String pmText)
          Sets the PM text.
 void setProjectExternallyEdited(boolean projectExternallyEdited)
          Set the externally edited flag.
 void setProjectTitle(java.lang.String projectTitle)
          Sets the project title.
 void setRemoveFileProperties(boolean removeFileProperties)
          Set the remove file properties flag.
 void setRevision(java.lang.Integer revision)
          Set the project revision number.
 void setScheduleFrom(ScheduleFrom scheduleFrom)
          Sets an enumerated value indicating if tasks in this project are scheduled from a start or a finish date.
 void setShowProjectSummaryTask(boolean value)
          Sets the "show project summary task" flag.
 void setSplitInProgressTasks(boolean flag)
          Flag representing whether or not to split in-progress tasks.
 void setSpreadActualCost(boolean spreadActualCost)
          Set the spread actual cost flag.
 void setSpreadPercentComplete(boolean spreadPercentComplete)
          Sets the spread percent complete flag.
 void setStartDate(java.util.Date startDate)
          Sets the project start date.
 void setStartVariance(Duration startVariance)
          Sets the start variance duration.
 void setStatusDate(java.util.Date statusDate)
          Set the status date.
 void setSubject(java.lang.String subject)
          Sets the project subject text.
 void setSymbolPosition(CurrencySymbolPosition posn)
          Sets the position of the currency symbol.
 void setThousandsSeparator(char sep)
          Sets the thousands separator.
 void setTimeFormat(ProjectTimeFormat timeFormat)
          Sets constant representing the time format.
 void setTimeSeparator(char timeSeparator)
          Sets the time separator.
 void setTimeSeparator(java.lang.Character timeSeparator)
          Sets the time separator.
 void setUniqueID(java.lang.String uniqueID)
          Set the unique ID for this project.
 void setUpdatingTaskStatusUpdatesResourceStatus(boolean flag)
          Flags whether updating Task status also updates resource status.
 void setWeekStartDay(Day weekStartDay)
          Set the week start day.
 void setWork(Duration work)
          Sets the project work duration.
 void setWork2(java.lang.Number work2)
          Sets the project's "Work 2" attribute.
 
Methods inherited from class net.sf.mpxj.ProjectEntity
getParentFile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProjectHeader

ProjectHeader(ProjectFile file)
Default constructor.

Parameters:
file - the parent file to which this record belongs.
Method Detail

getDefaultDurationUnits

public TimeUnit getDefaultDurationUnits()
Gets Default Duration units. The constants used to define the duration units are defined by the TimeUnit class.

Returns:
int constant
See Also:
TimeUnit

setDefaultDurationUnits

public void setDefaultDurationUnits(TimeUnit units)
Default duration units. The constants used to define the duration units are defined by the TimeUnit class.

Parameters:
units - default time units
See Also:
TimeUnit

getDefaultDurationIsFixed

public boolean getDefaultDurationIsFixed()
Retrieves a flag indicating if the default duration type is fixed.

Returns:
boolean flag

setDefaultDurationIsFixed

public void setDefaultDurationIsFixed(boolean fixed)
Sets a flag indicating if the default duration type is fixed.

Parameters:
fixed - boolean flag

getDefaultWorkUnits

public TimeUnit getDefaultWorkUnits()
Default work units. The constants used to define the work units are defined by the TimeUnit class.

Returns:
int representing default
See Also:
TimeUnit

setDefaultWorkUnits

public void setDefaultWorkUnits(TimeUnit units)
Default work units. The constants used to define the work units are defined by the TimeUnit class.

Parameters:
units - int representing default
See Also:
TimeUnit

getDefaultStandardRate

public Rate getDefaultStandardRate()
Retrieves the default standard rate.

Returns:
default standard rate

setDefaultStandardRate

public void setDefaultStandardRate(Rate rate)
Sets the default standard rate.

Parameters:
rate - default standard rate

getDefaultOvertimeRate

public Rate getDefaultOvertimeRate()
Get overtime rate.

Returns:
rate

setDefaultOvertimeRate

public void setDefaultOvertimeRate(Rate rate)
Set default overtime rate.

Parameters:
rate - default overtime rate

getUpdatingTaskStatusUpdatesResourceStatus

public boolean getUpdatingTaskStatusUpdatesResourceStatus()
Flags whether updating Task status also updates resource status.

Returns:
boolean flag

setUpdatingTaskStatusUpdatesResourceStatus

public void setUpdatingTaskStatusUpdatesResourceStatus(boolean flag)
Flags whether updating Task status also updates resource status.

Parameters:
flag - boolean flag

getSplitInProgressTasks

public boolean getSplitInProgressTasks()
Flag representing whether or not to split in-progress tasks.

Returns:
Boolean value

setSplitInProgressTasks

public void setSplitInProgressTasks(boolean flag)
Flag representing whether or not to split in-progress tasks.

Parameters:
flag - boolean value

getDateOrder

public DateOrder getDateOrder()
Gets constant representing set Date order eg DMY, MDY.

Returns:
constant value for date order

setDateOrder

public void setDateOrder(DateOrder dateOrder)
Sets constant representing set Date order eg DMY, MDY.

Parameters:
dateOrder - date order value

getTimeFormat

public ProjectTimeFormat getTimeFormat()
Gets constant representing the Time Format.

Returns:
time format constant

setTimeFormat

public void setTimeFormat(ProjectTimeFormat timeFormat)
Sets constant representing the time format.

Parameters:
timeFormat - constant value

setIntegerDefaultStartTime

public void setIntegerDefaultStartTime(java.lang.Integer time)
This internal method is used to convert from an integer representing minutes past midnight into a Date instance whose time component represents the start time.

Parameters:
time - integer representing the start time in minutes past midnight

getDefaultStartTime

public java.util.Date getDefaultStartTime()
Retrieve the default start time, specified using the Java Date type. Note that this assumes that the value returned from the getTime method starts at zero... i.e. the date part of the date/time value has not been set.

Returns:
default start time

setDefaultStartTime

public void setDefaultStartTime(java.util.Date defaultStartTime)
Set the default start time, specified using the Java Date type. Note that this assumes that the value returned from the getTime method starts at zero... i.e. the date part of the date/time value has not been set.

Parameters:
defaultStartTime - default time

getDateSeparator

public char getDateSeparator()
Gets the date separator.

Returns:
date separator as set.

setDateSeparator

public void setDateSeparator(char dateSeparator)
Sets the date separator.

Parameters:
dateSeparator - date separator as set.

getTimeSeparator

public char getTimeSeparator()
Gets the time separator.

Returns:
time separator as set.

setTimeSeparator

public void setTimeSeparator(char timeSeparator)
Sets the time separator.

Parameters:
timeSeparator - time separator

setTimeSeparator

public void setTimeSeparator(java.lang.Character timeSeparator)
Sets the time separator.

Parameters:
timeSeparator - time separator

getAMText

public java.lang.String getAMText()
Gets the AM text.

Returns:
AM Text as set.

setAMText

public void setAMText(java.lang.String amText)
Sets the AM text.

Parameters:
amText - AM Text as set.

getPMText

public java.lang.String getPMText()
Gets the PM text.

Returns:
PM Text as set.

setPMText

public void setPMText(java.lang.String pmText)
Sets the PM text.

Parameters:
pmText - PM Text as set.

getDateFormat

public ProjectDateFormat getDateFormat()
Gets the set Date Format.

Returns:
int representing Date Format

setDateFormat

public void setDateFormat(ProjectDateFormat dateFormat)
Sets the set Date Format.

Parameters:
dateFormat - int representing Date Format

getBarTextDateFormat

public ProjectDateFormat getBarTextDateFormat()
Gets Bar Text Date Format.

Returns:
int value

setBarTextDateFormat

public void setBarTextDateFormat(ProjectDateFormat dateFormat)
Sets Bar Text Date Format.

Parameters:
dateFormat - value to be set

getDefaultEndTime

public java.util.Date getDefaultEndTime()
Retrieves the default end time.

Returns:
End time

setDefaultEndTime

public void setDefaultEndTime(java.util.Date date)
Sets the default end time.

Parameters:
date - End time

setProjectTitle

public void setProjectTitle(java.lang.String projectTitle)
Sets the project title.

Parameters:
projectTitle - project title

getProjectTitle

public java.lang.String getProjectTitle()
Gets the project title.

Returns:
project title

setCompany

public void setCompany(java.lang.String company)
Sets the company name.

Parameters:
company - company name

getCompany

public java.lang.String getCompany()
Retrieves the company name.

Returns:
company name

setManager

public void setManager(java.lang.String manager)
Sets the manager name.

Parameters:
manager - manager name

getManager

public java.lang.String getManager()
Retrieves the manager name.

Returns:
manager name

setCalendarName

public void setCalendarName(java.lang.String calendarName)
Sets the Calendar used. 'Standard' if no value is set.

Parameters:
calendarName - Calendar name

getCalendarName

public java.lang.String getCalendarName()
Gets the Calendar used. 'Standard' if no value is set.

Returns:
Calendar name

setStartDate

public void setStartDate(java.util.Date startDate)
Sets the project start date.

Parameters:
startDate - project start date

getStartDate

public java.util.Date getStartDate()
Retrieves the project start date. If an explicit start date has not been set, this method calculates the start date by looking for the earliest task start date.

Returns:
project start date

getFinishDate

public java.util.Date getFinishDate()
Retrieves the project finish date. If an explicit finish date has not been set, this method calculates the finish date by looking for the latest task finish date.

Returns:
Finish Date

setFinishDate

public void setFinishDate(java.util.Date finishDate)
Sets the project finish date.

Parameters:
finishDate - project finish date

getScheduleFrom

public ScheduleFrom getScheduleFrom()
Retrieves an enumerated value indicating if tasks in this project are scheduled from a start or a finish date.

Returns:
schedule from flag

setScheduleFrom

public void setScheduleFrom(ScheduleFrom scheduleFrom)
Sets an enumerated value indicating if tasks in this project are scheduled from a start or a finish date.

Parameters:
scheduleFrom - schedule from value

getCurrentDate

public java.util.Date getCurrentDate()
Retrieves the current date.

Returns:
current date

setCurrentDate

public void setCurrentDate(java.util.Date currentDate)
Sets the current date.

Parameters:
currentDate - current date

getComments

public java.lang.String getComments()
Returns any comments.

Returns:
comments attached to the Project Header

setComments

public void setComments(java.lang.String comments)
Set comment text.

Parameters:
comments - comment text

getCost

public java.lang.Number getCost()
Retrieves the project cost.

Returns:
project cost

setCost

public void setCost(java.lang.Number cost)
Sets the project cost.

Parameters:
cost - project cost

setBaselineCost

public void setBaselineCost(java.lang.Number baselineCost)
Sets the baseline project cost.

Parameters:
baselineCost - baseline project cost

getBaselineCost

public java.lang.Number getBaselineCost()
Retrieves the baseline project cost.

Returns:
baseline project cost

setActualCost

public void setActualCost(java.lang.Number actualCost)
Sets the actual project cost.

Parameters:
actualCost - actual project cost

getActualCost

public java.lang.Number getActualCost()
Retrieves the actual project cost.

Returns:
actual project cost

setWork

public void setWork(Duration work)
Sets the project work duration.

Parameters:
work - project work duration

getWork

public Duration getWork()
Retrieves the project work duration.

Returns:
project work duration

setBaselineWork

public void setBaselineWork(Duration baselineWork)
Set the baseline project work duration.

Parameters:
baselineWork - baseline project work duration

getBaselineWork

public Duration getBaselineWork()
Retrieves the baseline project work duration.

Returns:
baseline project work duration

setActualWork

public void setActualWork(Duration actualWork)
Sets the actual project work duration.

Parameters:
actualWork - actual project work duration

getActualWork

public Duration getActualWork()
Retrieves the actual project work duration.

Returns:
actual project work duration

getWork2

public java.lang.Number getWork2()
Retrieves the project's "Work 2" attribute.

Returns:
Work 2 attribute

setWork2

public void setWork2(java.lang.Number work2)
Sets the project's "Work 2" attribute.

Parameters:
work2 - work2 percentage value

getDuration

public Duration getDuration()
Retrieves the project duration.

Returns:
project duration

setDuration

public void setDuration(Duration duration)
Sets the project duration.

Parameters:
duration - project duration

getBaselineDuration

public Duration getBaselineDuration()
Retrieves the baseline duration value.

Returns:
baseline project duration value

setBaselineDuration

public void setBaselineDuration(Duration baselineDuration)
Sets the baseline project duration value.

Parameters:
baselineDuration - baseline project duration

getActualDuration

public Duration getActualDuration()
Retrieves the actual project duration.

Returns:
actual project duration

setActualDuration

public void setActualDuration(Duration actualDuration)
Sets the actual project duration.

Parameters:
actualDuration - actual project duration

getPercentageComplete

public java.lang.Number getPercentageComplete()
Retrieves the project percentage complete.

Returns:
percentage value

setPercentageComplete

public void setPercentageComplete(java.lang.Number percentComplete)
Sets project percentage complete.

Parameters:
percentComplete - project percent complete

setBaselineStart

public void setBaselineStart(java.util.Date baselineStartDate)
Sets the baseline project start date.

Parameters:
baselineStartDate - baseline project start date

getBaselineStart

public java.util.Date getBaselineStart()
Retrieves the baseline project start date.

Returns:
baseline project start date

setBaselineFinish

public void setBaselineFinish(java.util.Date baselineFinishDate)
Sets the baseline project finish date.

Parameters:
baselineFinishDate - baseline project finish date

getBaselineFinish

public java.util.Date getBaselineFinish()
Retrieves the baseline project finish date.

Returns:
baseline project finish date

setActualStart

public void setActualStart(java.util.Date actualStartDate)
Sets the actual project start date.

Parameters:
actualStartDate - actual project start date

getActualStart

public java.util.Date getActualStart()
Retrieves the actual project start date.

Returns:
actual project start date

setActualFinish

public void setActualFinish(java.util.Date actualFinishDate)
Sets the actual project finish date.

Parameters:
actualFinishDate - actual project finish date

getActualFinish

public java.util.Date getActualFinish()
Retrieves the actual project finish date.

Returns:
actual project finish date

getStartVariance

public Duration getStartVariance()
Retrieves the start variance duration.

Returns:
start date variance

setStartVariance

public void setStartVariance(Duration startVariance)
Sets the start variance duration.

Parameters:
startVariance - the start date variance

getFinishVariance

public Duration getFinishVariance()
Retrieves the project finish variance duration.

Returns:
project finish variance duration

setFinishVariance

public void setFinishVariance(Duration finishVariance)
Sets the project finish variance duration.

Parameters:
finishVariance - project finish variance duration

getSubject

public java.lang.String getSubject()
Returns the project subject text.

Returns:
subject text

setSubject

public void setSubject(java.lang.String subject)
Sets the project subject text.

Parameters:
subject - subject text

getAuthor

public java.lang.String getAuthor()
Retrieves the project author text.

Returns:
author text

setAuthor

public void setAuthor(java.lang.String author)
Sets the project author text.

Parameters:
author - project author text

getKeywords

public java.lang.String getKeywords()
Retrieves the project keyword text.

Returns:
project keyword text

setKeywords

public void setKeywords(java.lang.String keywords)
Sets the project keyword text.

Parameters:
keywords - project keyword text

setCurrencySymbol

public void setCurrencySymbol(java.lang.String symbol)
Sets currency symbol.

Parameters:
symbol - currency symbol

getCurrencySymbol

public java.lang.String getCurrencySymbol()
Retrieves the currency symbol.

Returns:
currency symbol

setSymbolPosition

public void setSymbolPosition(CurrencySymbolPosition posn)
Sets the position of the currency symbol.

Parameters:
posn - currency symbol position.

getSymbolPosition

public CurrencySymbolPosition getSymbolPosition()
Retrieves a constant representing the position of the currency symbol.

Returns:
position

setCurrencyDigits

public void setCurrencyDigits(java.lang.Number currDigs)
Sets no of currency digits.

Parameters:
currDigs - Available values, 0,1,2

getCurrencyDigits

public java.lang.Number getCurrencyDigits()
Gets no of currency digits.

Returns:
Available values, 0,1,2

setThousandsSeparator

public void setThousandsSeparator(char sep)
Sets the thousands separator. Note that this separator defines the thousands separator for all decimal numbers that appear in the MPX file.

Parameters:
sep - character

getThousandsSeparator

public char getThousandsSeparator()
Gets the thousands separator. Note that this separator defines the thousands separator for all decimal numbers that appear in the MPX file.

Returns:
character

setDecimalSeparator

public void setDecimalSeparator(char decSep)
Sets the decimal separator. Note that this separator defines the decimal separator for all decimal numbers that appear in the MPX file.

Parameters:
decSep - character

getDecimalSeparator

public char getDecimalSeparator()
Gets the decimal separator. Note that this separator defines the decimal separator for all decimal numbers that appear in the MPX file.

Returns:
character

getProjectExternallyEdited

public boolean getProjectExternallyEdited()
Retrieve the externally edited flag.

Returns:
externally edited flag

setProjectExternallyEdited

public void setProjectExternallyEdited(boolean projectExternallyEdited)
Set the externally edited flag.

Parameters:
projectExternallyEdited - externally edited flag

getCategory

public java.lang.String getCategory()
Retrieves the category text.

Returns:
category text

setCategory

public void setCategory(java.lang.String category)
Sets the category text.

Parameters:
category - category text

getDaysPerMonth

public java.lang.Number getDaysPerMonth()
Retrieve the number of days per month.

Returns:
days per month

setDaysPerMonth

public void setDaysPerMonth(java.lang.Number daysPerMonth)
Set the number of days per month.

Parameters:
daysPerMonth - days per month

getMinutesPerDay

public java.lang.Number getMinutesPerDay()
Retrieve the number of minutes per day.

Returns:
minutes per day

setMinutesPerDay

public void setMinutesPerDay(java.lang.Number minutesPerDay)
Set the number of minutes per day.

Parameters:
minutesPerDay - minutes per day

getMinutesPerWeek

public java.lang.Number getMinutesPerWeek()
Retrieve the number of minutes per week.

Returns:
minutes per week

setMinutesPerWeek

public void setMinutesPerWeek(java.lang.Number minutesPerWeek)
Set the number of minutes per week.

Parameters:
minutesPerWeek - minutes per week

getFiscalYearStart

public boolean getFiscalYearStart()
Retrieve the fiscal year start flag.

Returns:
fiscal year start flag

setFiscalYearStart

public void setFiscalYearStart(boolean fiscalYearStart)
Set the fiscal year start flag.

Parameters:
fiscalYearStart - fiscal year start

getDefaultTaskEarnedValueMethod

public EarnedValueMethod getDefaultTaskEarnedValueMethod()
Retrieves the default task earned value method.

Returns:
default task earned value method

setDefaultTaskEarnedValueMethod

public void setDefaultTaskEarnedValueMethod(EarnedValueMethod defaultTaskEarnedValueMethod)
Sets the default task earned value method.

Parameters:
defaultTaskEarnedValueMethod - default task earned value method

getRemoveFileProperties

public boolean getRemoveFileProperties()
Retrieve the remove file properties flag.

Returns:
remove file properties flag

setRemoveFileProperties

public void setRemoveFileProperties(boolean removeFileProperties)
Set the remove file properties flag.

Parameters:
removeFileProperties - remove file properties flag

getMoveCompletedEndsBack

public boolean getMoveCompletedEndsBack()
Retrieve the move completed ends back flag.

Returns:
move completed ends back flag

setMoveCompletedEndsBack

public void setMoveCompletedEndsBack(boolean moveCompletedEndsBack)
Set the move completed ends back flag.

Parameters:
moveCompletedEndsBack - move completed ends back flag

getNewTasksEstimated

public boolean getNewTasksEstimated()
Retrieve the new tasks estimated flag.

Returns:
new tasks estimated flag

setNewTasksEstimated

public void setNewTasksEstimated(boolean newTasksEstimated)
Set the new tasks estimated flag.

Parameters:
newTasksEstimated - new tasks estimated flag

getSpreadActualCost

public boolean getSpreadActualCost()
Retrieve the spread actual cost flag.

Returns:
spread actual cost flag

setSpreadActualCost

public void setSpreadActualCost(boolean spreadActualCost)
Set the spread actual cost flag.

Parameters:
spreadActualCost - spread actual cost flag

getMultipleCriticalPaths

public boolean getMultipleCriticalPaths()
Retrieve the multiple critical paths flag.

Returns:
multiple critical paths flag

setMultipleCriticalPaths

public void setMultipleCriticalPaths(boolean multipleCriticalPaths)
Set the multiple critical paths flag.

Parameters:
multipleCriticalPaths - multiple critical paths flag

getAutoAddNewResourcesAndTasks

public boolean getAutoAddNewResourcesAndTasks()
Retrieve the auto add new resources and tasks flag.

Returns:
auto add new resources and tasks flag

setAutoAddNewResourcesAndTasks

public void setAutoAddNewResourcesAndTasks(boolean autoAddNewResourcesAndTasks)
Set the auto add new resources and tasks flag.

Parameters:
autoAddNewResourcesAndTasks - auto add new resources and tasks flag

getLastSaved

public java.util.Date getLastSaved()
Retrieve the last saved date.

Returns:
last saved date

setLastSaved

public void setLastSaved(java.util.Date lastSaved)
Set the last saved date.

Parameters:
lastSaved - last saved date

getStatusDate

public java.util.Date getStatusDate()
Retrieve the status date.

Returns:
status date

setStatusDate

public void setStatusDate(java.util.Date statusDate)
Set the status date.

Parameters:
statusDate - status date

getMoveRemainingStartsBack

public boolean getMoveRemainingStartsBack()
Retrieves the move remaining starts back flag.

Returns:
move remaining starts back flag

setMoveRemainingStartsBack

public void setMoveRemainingStartsBack(boolean moveRemainingStartsBack)
Sets the move remaining starts back flag.

Parameters:
moveRemainingStartsBack - remaining starts back flag

getAutolink

public boolean getAutolink()
Retrieves the autolink flag.

Returns:
autolink flag

setAutolink

public void setAutolink(boolean autolink)
Sets the autolink flag.

Parameters:
autolink - autolink flag

getMicrosoftProjectServerURL

public boolean getMicrosoftProjectServerURL()
Retrieves the Microsoft Project Server URL flag.

Returns:
Microsoft Project Server URL flag

setMicrosoftProjectServerURL

public void setMicrosoftProjectServerURL(boolean microsoftProjectServerURL)
Sets the Microsoft Project Server URL flag.

Parameters:
microsoftProjectServerURL - Microsoft Project Server URL flag

getHonorConstraints

public boolean getHonorConstraints()
Retrieves the honor constraints flag.

Returns:
honor constraints flag

setHonorConstraints

public void setHonorConstraints(boolean honorConstraints)
Sets the honor constraints flag.

Parameters:
honorConstraints - honor constraints flag

getAdminProject

public boolean getAdminProject()
Retrieve the admin project flag.

Returns:
admin project flag

setAdminProject

public void setAdminProject(boolean adminProject)
Set the admin project flag.

Parameters:
adminProject - admin project flag

getInsertedProjectsLikeSummary

public boolean getInsertedProjectsLikeSummary()
Retrieves the inserted projects like summary flag.

Returns:
inserted projects like summary flag

setInsertedProjectsLikeSummary

public void setInsertedProjectsLikeSummary(boolean insertedProjectsLikeSummary)
Sets the inserted projects like summary flag.

Parameters:
insertedProjectsLikeSummary - inserted projects like summary flag

getName

public java.lang.String getName()
Retrieves the project name.

Returns:
project name

setName

public void setName(java.lang.String name)
Sets the project name.

Parameters:
name - project name

getSpreadPercentComplete

public boolean getSpreadPercentComplete()
Retrieves the spread percent complete flag.

Returns:
spread percent complete flag

setSpreadPercentComplete

public void setSpreadPercentComplete(boolean spreadPercentComplete)
Sets the spread percent complete flag.

Parameters:
spreadPercentComplete - spread percent complete flag

getMoveCompletedEndsForward

public boolean getMoveCompletedEndsForward()
Retrieve the move completed ends forward flag.

Returns:
move completed ends forward flag

setMoveCompletedEndsForward

public void setMoveCompletedEndsForward(boolean moveCompletedEndsForward)
Sets the move completed ends forward flag.

Parameters:
moveCompletedEndsForward - move completed ends forward flag

getEditableActualCosts

public boolean getEditableActualCosts()
Retrieve the editable actual costs flag.

Returns:
editable actual costs flag

setEditableActualCosts

public void setEditableActualCosts(boolean editableActualCosts)
Set the editable actual costs flag.

Parameters:
editableActualCosts - editable actual costs flag

getUniqueID

public java.lang.String getUniqueID()
Retrieve the unique ID for this project.

Returns:
unique ID

setUniqueID

public void setUniqueID(java.lang.String uniqueID)
Set the unique ID for this project.

Parameters:
uniqueID - unique ID

getRevision

public java.lang.Integer getRevision()
Retrieve the project revision number.

Returns:
revision number

getNewTasksEffortDriven

public boolean getNewTasksEffortDriven()
Retrieve the new tasks effort driven flag.

Returns:
new tasks effort driven flag

setNewTasksEffortDriven

public void setNewTasksEffortDriven(boolean newTasksEffortDriven)
Sets the new tasks effort driven flag.

Parameters:
newTasksEffortDriven - new tasks effort driven flag

setRevision

public void setRevision(java.lang.Integer revision)
Set the project revision number.

Parameters:
revision - revision number

getMoveRemainingStartsForward

public boolean getMoveRemainingStartsForward()
Retrieve the move remaining starts forward flag.

Returns:
move remaining starts forward flag

setMoveRemainingStartsForward

public void setMoveRemainingStartsForward(boolean moveRemainingStartsForward)
Set the move remaining starts forward flag.

Parameters:
moveRemainingStartsForward - move remaining starts forward flag

getActualsInSync

public boolean getActualsInSync()
Retrieve the actuals in sync flag.

Returns:
actuals in sync flag

setActualsInSync

public void setActualsInSync(boolean actualsInSync)
Set the actuals in sync flag.

Parameters:
actualsInSync - actuals in sync flag

getDefaultTaskType

public TaskType getDefaultTaskType()
Retrieve the default task type.

Returns:
default task type

setDefaultTaskType

public void setDefaultTaskType(TaskType defaultTaskType)
Set the default task type.

Parameters:
defaultTaskType - default task type

getEarnedValueMethod

public EarnedValueMethod getEarnedValueMethod()
Retrieve the earned value method.

Returns:
earned value method

setEarnedValueMethod

public void setEarnedValueMethod(EarnedValueMethod earnedValueMethod)
Set the earned value method.

Parameters:
earnedValueMethod - earned value method

getCreationDate

public java.util.Date getCreationDate()
Retrieve the project creation date.

Returns:
project creation date

setCreationDate

public void setCreationDate(java.util.Date creationDate)
Set the project creation date.

Parameters:
creationDate - project creation date

getExtendedCreationDate

public java.util.Date getExtendedCreationDate()
Retrieve the extended creation date.

Returns:
extended creation date

getDefaultFixedCostAccrual

public AccrueType getDefaultFixedCostAccrual()
Retrieve the default fixed cost accrual type.

Returns:
default fixed cost accrual type

setDefaultFixedCostAccrual

public void setDefaultFixedCostAccrual(AccrueType defaultFixedCostAccrual)
Sets the default fixed cost accrual type.

Parameters:
defaultFixedCostAccrual - default fixed cost accrual type

setExtendedCreationDate

public void setExtendedCreationDate(java.util.Date creationDate)
Set the extended creation date.

Parameters:
creationDate - extended creation date

getCriticalSlackLimit

public java.lang.Integer getCriticalSlackLimit()
Retrieve the critical slack limit.

Returns:
critical slack limit

setCriticalSlackLimit

public void setCriticalSlackLimit(java.lang.Integer criticalSlackLimit)
Set the critical slack limit.

Parameters:
criticalSlackLimit - critical slack limit

getBaselineForEarnedValue

public java.lang.Integer getBaselineForEarnedValue()
Retrieve the number of the baseline to use for earned value calculations.

Returns:
baseline for earned value

setBaselineForEarnedValue

public void setBaselineForEarnedValue(java.lang.Integer baselineForEarnedValue)
Set the number of the baseline to use for earned value calculations.

Parameters:
baselineForEarnedValue - baseline for earned value

getFiscalYearStartMonth

public java.lang.Integer getFiscalYearStartMonth()
Retrieves the fiscal year start month (January=1, December=12).

Returns:
fiscal year start month

setFiscalYearStartMonth

public void setFiscalYearStartMonth(java.lang.Integer fiscalYearStartMonth)
Sets the fiscal year start month (January=1, December=12).

Parameters:
fiscalYearStartMonth - fiscal year start month

getNewTaskStartIsProjectStart

public boolean getNewTaskStartIsProjectStart()
Retrieve the flag indicating if new tasks should default to the project start date (true) or the current date (false).

Returns:
new task start is project start

setNewTaskStartIsProjectStart

public void setNewTaskStartIsProjectStart(boolean newTaskStartIsProjectStart)
Sets the flag indicating if new tasks should default to the project start date (true) or the current date (false).

Parameters:
newTaskStartIsProjectStart - new task start is project start

getWeekStartDay

public Day getWeekStartDay()
Retrieve the week start day.

Returns:
week start day

setWeekStartDay

public void setWeekStartDay(Day weekStartDay)
Set the week start day.

Parameters:
weekStartDay - week start day

setCalculateMultipleCriticalPaths

public void setCalculateMultipleCriticalPaths(boolean flag)
Sets the calculate multiple critical paths flag.

Parameters:
flag - boolean flag

getCalculateMultipleCriticalPaths

public boolean getCalculateMultipleCriticalPaths()
Retrieves the calculate multiple critical paths flag.

Returns:
boolean flag

getCurrencyCode

public java.lang.String getCurrencyCode()
Retrieve the currency code for this project.

Returns:
currency code

setCurrencyCode

public void setCurrencyCode(java.lang.String currencyCode)
Set the currency code for this project.

Parameters:
currencyCode - currency code

setDocumentSummaryInformation

public void setDocumentSummaryInformation(java.util.Map<java.lang.Integer,java.lang.Object> documentSummaryInformation)
Set the Document Summary Information.

Parameters:
documentSummaryInformation - The Document Summary Information Map

getDocumentSummaryInformation

public java.util.Map<java.lang.Integer,java.lang.Object> getDocumentSummaryInformation()
Retrieve the Document Summary Information. This allows the caller to examine custom document summary fields which may be present in the project.

Returns:
the Document Summary Information Map

setHyperlinkBase

public void setHyperlinkBase(java.lang.String hyperlinkBase)
Sets the hyperlink base for this Project.

Parameters:
hyperlinkBase - Hyperlink base

getHyperlinkBase

public java.lang.String getHyperlinkBase()
Gets the hyperlink base for this Project. If any.

Returns:
Hyperlink base

getShowProjectSummaryTask

public boolean getShowProjectSummaryTask()
Retrieves the "show project summary task" flag.

Returns:
boolean flag

setShowProjectSummaryTask

public void setShowProjectSummaryTask(boolean value)
Sets the "show project summary task" flag.

Parameters:
value - boolean flag

getBaselineDate

public java.util.Date getBaselineDate(int index)
Retrieve the date for a specific baseline. Note that index 0 represents "Baseline", index 1 represents "Baseline1" and so on.

Parameters:
index - baseline index
Returns:
baseline date, null if baseline not set

setBaselineDate

public void setBaselineDate(int index,
                            java.util.Date date)
Set the date for a specific baseline. Note that index 0 represents "Baseline", index 1 represents "Baseline1" and so on.

Parameters:
index - baseline index
date - baseline date, null if baseline not set


Copyright © 2000-2014 Packwood Software. All Rights Reserved.