public class Project extends Object
Represents a project.
Constructor and Description |
---|
Project()
Initializes a new instance of the
Project class. |
Project(DbSettings settings)
Initializes a new instance of the
Project class to read data from a database which is specified by the instance of the DbSettings class. |
Project(InputStream stream)
Initializes a new instance of the
Project class from a template(existent mpp or mpt file). |
Project(InputStream stream,
LoadOptions options)
Initializes a new instance of the
Project class from the Stream
with the specified instance of the LoadOptions class. |
Project(InputStream stream,
ParseErrorCallback parseErrorHandler)
Initializes a new instance of the
Project class from a template(existent mpp or mpt file). |
Project(InputStream stream,
PrimaveraXmlReadingOptions options)
Initializes a new instance of the
Project class from the specified stream with the specified instance of the PrimaveraXmlReadingOptions class. |
Project(InputStream stream,
String protectionPassword)
Initializes a new instance of the
Project class from a template(existent mpp or mpt file). |
Project(String projectTemplate)
Initializes a new instance of the
Project class from a template (existent mpp or mpt file). |
Project(String projectTemplate,
LoadOptions options)
Initializes a new instance of the
Project class from a template (existent mpp or mpt file)
with the specified instance of the LoadOptions class. |
Project(String projectTemplate,
ParseErrorCallback parseErrorHandler)
Initializes a new instance of the
Project class from a template (existent mpp or mpt file). |
Project(String projectTemplate,
ParseErrorCallback parseErrorHandler,
PrimaveraXmlReadingOptions options)
Initializes a new instance of the
Project class from a template (existent mpp or mpt file)
with the specified instance of the PrimaveraXmlReadingOptions class. |
Project(String projectTemplate,
PrimaveraXmlReadingOptions options)
Initializes a new instance of the
Project class from a template (existent mpp or mpt file)
with the specified instance of the PrimaveraXmlReadingOptions class. |
Project(String template,
String protectionPassword)
Initializes a new instance of the
Project class from a password protected template (existent mpp or mpt file). |
Modifier and Type | Method and Description |
---|---|
void |
calcResourceFields()
Recalculates Id, Start and Finish of resources.
|
void |
calcResourceStartFinish()
Recalculates Start and Finish of resources.
|
void |
copyTo(Project another)
Copies project's main data and properties to another project.
|
<T> T |
get(Key<T,Integer> key)
Returns the value to which the property is mapped in this container.
|
Date |
getBaselineSaveTime(int baselineNumber)
Returns the baseline save time.
|
int |
getCalculationMode()
Specifies calculation mode of a project.
|
CalendarCollection |
getCalendars()
Returns
CalendarCollection object of this Project instance. |
TaskCollection |
getCriticalPath()
Returns TaskCollection which contains a list of Critical tasks which comprise Critical Path of this project.
|
Map<String,Object> |
getCustomProperties()
Returns project custom properties map.
|
View |
getDefaultView()
Gets default view of the project.
|
WeekDayCollection |
getDefaultWeekWorkingDays()
Returns the instance of
WeekDayCollection class which represents a collection of project default week working days and working times. |
ProjectDisplayOptions |
getDisplayOptions()
Returns an instance of the
ProjectDisplayOptions class. |
Duration |
getDuration(double val)
Gets
Duration object with the specified double value and default duration format. |
Duration |
getDuration(double val,
int timeUnit)
Gets
Duration object with the specified TimeSpan value and specified TimeUnitType value. |
ExtendedAttributeDefinitionCollection |
getExtendedAttributes()
Returns ExtendedAttributeDefinitionCollection object.
|
OleObjectCollection |
getOleObjects()
Returns a collection containing the instances of the
OleObject class which are linked or embedded to this project file. |
OutlineCodeDefinitionCollection |
getOutlineCodes()
Returns OutlineCodeDefinitionCollection object.
|
int |
getPageCount_PageSize(int pageSize,
int scale)
Returns page count for the project to be rendered using given
Timescale and PageSize . |
int |
getPageCount_PageSize(int pageSize,
int scale,
Date startDate,
Date endDate)
Returns page count for the project to be rendered using given
Timescale , PresentationFormat and date range. |
int |
getPageCount_PresentationFormat(int format)
Returns page count for the project to be rendered using default
Timescale (Days) and given PresentationFormat |
int |
getPageCount_Timescale(int scale)
Returns page count for the project to be rendered using given
Timescale . |
int |
getPageCount()
Returns page count for the project to be rendered using default
Timescale (Days). |
int |
getPageCount(int format,
int scale)
Returns page count for the project to be rendered using given
Timescale and PresentationFormat . |
TaskLinkCollection |
getPredecessors(Task task)
Returns a collection of task links which are predecessors of the specified task.
|
static ProjectFileInfo |
getProjectFileInfo(InputStream stream)
/**
|
static ProjectFileInfo |
getProjectFileInfo(String filename)
Read project file info from the file.
|
ResourceAssignmentCollection |
getResourceAssignments()
Returns the instance of
ResourceAssignmentCollection class. |
FilterCollection |
getResourceFilters()
Represents all the resource-based filter definitions.
|
GroupCollection |
getResourceGroups()
Represents all of the resource-based group definitions.
|
ResourceCollection |
getResources()
Returns ResourceCollection object.
|
Task |
getRootTask()
Returns the root of the tree of tasks.
|
TableCollection |
getTables()
Contains a list of
Table objects. |
FilterCollection |
getTaskFilters()
Represents all the task-based filter definitions.
|
GroupCollection |
getTaskGroups()
Represents all the task-based group definitions.
|
TaskLinkCollection |
getTaskLinks()
Returns
TaskLinkCollection object. |
VbaProject |
getVbaProject()
Represents an instance of VbaProject class.
|
ViewCollection |
getViews()
Contains a list of
View objects. |
WBSCodeDefinition |
getWBSCodeDefinition()
Gets WBS Code Definition for the project.
|
Duration |
getWork(double val)
Gets
Duration object with the specified double value and default work format. |
void |
recalculate()
Reschedules all project tasks ids, outline levels, start/finish dates, sets early/late dates, calculates slacks, work and cost fields.
|
void |
recalculate(boolean validate)
Reschedules all project tasks ids, outline levels, start/finish dates, sets early/late dates, calculates slacks, work and cost fields with optional validation.
|
void |
removeInvalidResourceAssignments()
Eliminates invalid resource assignments from the project resource assignments list.
|
void |
renumberWBSCode()
Renumber WBS code of all tasks.
|
void |
renumberWBSCode(List<Integer> taskIds)
Renumber WBS code of passed tasks.
|
void |
rescheduleUncompletedWorkToStartAfter(Date after)
Reschedules uncompleted project work to start after a specified date.
|
void |
rescheduleUncompletedWorkToStartAfter(Date after,
List<Task> tasks)
Reschedules uncompleted work for a specified list of tasks to start after a specified date.
|
void |
save(OutputStream stream,
int format)
Saves the project data to the output stream.
|
void |
save(OutputStream stream,
MPPSaveOptions options)
Saves the project to a stream using the specified save options.
|
void |
save(OutputStream stream,
SaveOptions options)
Saves the project to a stream using the specified save options.
|
void |
save(String filename,
int format)
Saves the project data to the file.
|
void |
save(String filename,
MPPSaveOptions options)
Saves the document to mpp file format using the specified save options.
|
void |
save(String filename,
SaveOptions options)
Saves the document to a file using the specified save options.
|
void |
saveAsTemplate(OutputStream stream)
Saves the project as a template to a specified stream.
|
void |
saveAsTemplate(OutputStream stream,
SaveTemplateOptions options)
Saves the project as a template to a specified stream.
|
void |
saveAsTemplate(String fileName)
Saves the project as a template to the specified file path.
|
void |
saveAsTemplate(String fileName,
SaveTemplateOptions options)
Saves the project as a template.
|
void |
saveReport(OutputStream stream)
Saves the project overview report to the stream.
|
void |
saveReport(OutputStream stream,
int reportType)
Saves the project report of the specified type to the specified stream.
|
void |
saveReport(String fileName)
Saves the project overview report to pdf file.
|
void |
saveReport(String fileName,
int reportType)
Saves the project report of the specified type in pdf format to the specified file path.
|
List<Task> |
selectAllChildTasks()
Recursively collects all child tasks of this task.
|
void |
set(Key<Date,Integer> key,
Date val)
Maps the specified property to the specified value in this container.
|
<T> void |
set(Key<T,Integer> key,
T val)
Maps the specified property to the specified value in this container.
|
void |
setBaseline(int baselineType)
Saves baseline fields to the specified baseline for the entire project.
|
void |
setBaseline(int baselineType,
Iterable<Task> tasks)
Saves baseline fields to the specified baseline for the selected tasks.
|
void |
setCalculationMode(int value)
Specifies calculation mode of a project.
|
void |
setWBSCodeDefinition(WBSCodeDefinition value)
Sets WBS Code Definition for the project.
|
void |
updateProjectWorkAsComplete(Date completeThrough,
boolean setZeroOrHundredPercentCompleteOnly)
Updates all work as complete through a specified date for the entire project.
|
void |
updateProjectWorkAsComplete(Date completeThrough,
boolean setZeroOrHundredPercentCompleteOnly,
List<Task> tasks)
Updates all work as complete through a specified date for the specified list of tasks.
|
public Project()
Initializes a new instance of the Project
class.
public Project(String template, String protectionPassword)
Initializes a new instance of the Project
class from a password protected template (existent mpp or mpt file).
template
- Path to template to create project from.protectionPassword
- Protection password.
Reading password protected files currently supported for MSP 2003 file format only.
public Project(String projectTemplate)
Initializes a new instance of the Project
class from a template (existent mpp or mpt file).
projectTemplate
- Path to template to create project from.public Project(String projectTemplate, ParseErrorCallback parseErrorHandler)
Initializes a new instance of the Project
class from a template (existent mpp or mpt file).
projectTemplate
- Path to template to create project from.parseErrorHandler
- the specified callback method to handle xml parse errors.public Project(InputStream stream)
Initializes a new instance of the Project
class from a template(existent mpp or mpt file).
stream
- Stream
to load a template from.public Project(InputStream stream, PrimaveraXmlReadingOptions options)
Initializes a new instance of the Project
class from the specified stream with the specified instance of the PrimaveraXmlReadingOptions
class.
stream
- Stream
to load a template from.options
- the specified instance of the PrimaveraXmlReadingOptions
class.public Project(String projectTemplate, PrimaveraXmlReadingOptions options)
Initializes a new instance of the Project
class from a template (existent mpp or mpt file)
with the specified instance of the PrimaveraXmlReadingOptions
class.
projectTemplate
- Path to template to create project fromoptions
- the specified instance of the PrimaveraXmlReadingOptions
class.public Project(String projectTemplate, ParseErrorCallback parseErrorHandler, PrimaveraXmlReadingOptions options)
Initializes a new instance of the Project
class from a template (existent mpp or mpt file)
with the specified instance of the PrimaveraXmlReadingOptions
class.
projectTemplate
- Path to template to create project fromparseErrorHandler
- the specified callback method to handle xml parse errorsoptions
- the specified instance of the PrimaveraXmlReadingOptions
class.public Project(DbSettings settings)
Initializes a new instance of the Project
class to read data from a database which is specified by the instance of the DbSettings
class.
settings
- the specified instance of the DbSettings
class.public Project(InputStream stream, ParseErrorCallback parseErrorHandler)
Initializes a new instance of the Project
class from a template(existent mpp or mpt file).
stream
- Stream
to load a template from.parseErrorHandler
- the specified callback method to handle xml parse errors.public Project(InputStream stream, String protectionPassword)
Initializes a new instance of the Project
class from a template(existent mpp or mpt file).
stream
- Stream
to load a template from.protectionPassword
- Protection password.
Reading password protected files currently supported for MSP 2003 file format only.
public Project(String projectTemplate, LoadOptions options)
Initializes a new instance of the Project
class from a template (existent mpp or mpt file)
with the specified instance of the LoadOptions
class.
projectTemplate
- Path to template to create project fromoptions
- the specified instance of the LoadOptions
class.public Project(InputStream stream, LoadOptions options)
Initializes a new instance of the Project
class from the Stream
with the specified instance of the LoadOptions
class.
stream
- Stream of the Project System.IO.Stream
classoptions
- the specified instance of the LoadOptions
classpublic int getCalculationMode()
Specifies calculation mode of a project.
Can be one of the values of CalculationMode
enumeration.
public void setCalculationMode(int value)
Specifies calculation mode of a project.
Can be one of the values of CalculationMode
enumeration.
value
- one of the values of CalculationMode
enumeration which specifies calculation mode of a project.public CalendarCollection getCalendars()
Returns CalendarCollection
object of this Project instance.
Read only CalendarCollection
.
public TaskCollection getCriticalPath()
Returns TaskCollection which contains a list of Critical tasks which comprise Critical Path of this project.
TaskCollection
which represents a list of all critical tasks.
this is an O(n) operation, where n is the number of tasks in the project.
public Map<String,Object> getCustomProperties()
Returns project custom properties map.
Read/write Map<String,Object>
.
public View getDefaultView()
Gets default view of the project.
public WeekDayCollection getDefaultWeekWorkingDays()
Returns the instance of WeekDayCollection
class which represents a collection of project default week working days and working times.
The data contains only in mpp files (not in xml).
WeekDayCollection
class which contains a list of WeekDay
objects.public ProjectDisplayOptions getDisplayOptions()
Returns an instance of the ProjectDisplayOptions
class.
ProjectDisplayOptions
class.public ExtendedAttributeDefinitionCollection getExtendedAttributes()
Returns ExtendedAttributeDefinitionCollection object.
The collection of extended attribute (custom fields) definitions associated with a project.
Read only ExtendedAttributeDefinitionCollection
instance.
public OleObjectCollection getOleObjects()
Returns a collection containing the instances of the OleObject
class which are linked or embedded to this project file.
Available for mpp file format only.
OleObject
class which are linked or embedded to this project file.public OutlineCodeDefinitionCollection getOutlineCodes()
Returns OutlineCodeDefinitionCollection object.
The collection of outline code definitions associated with a project.
Read only OutlineCodeDefinitionCollection
instance.
public int getPageCount()
Returns page count for the project to be rendered using default Timescale
(Days).
public ResourceAssignmentCollection getResourceAssignments()
Returns the instance of ResourceAssignmentCollection
class.
public FilterCollection getResourceFilters()
Represents all the resource-based filter definitions.
ResourceFilters is a collection of Filter
objects.
public GroupCollection getResourceGroups()
Represents all of the resource-based group definitions.
ResourceGroups is a collection of Group
objects.
public ResourceCollection getResources()
Returns ResourceCollection object.
Read-only ResourceCollection
object.
public Task getRootTask()
Returns the root of the tree of tasks.
Read-only instance of the Task
class.
public TableCollection getTables()
Contains a list of Table
objects.
public FilterCollection getTaskFilters()
Represents all the task-based filter definitions.
TaskFilters is a collection of Filter
objects.
public GroupCollection getTaskGroups()
Represents all the task-based group definitions.
TaskGroups is a collection of Group
objects.
public TaskLinkCollection getTaskLinks()
Returns TaskLinkCollection
object.
Read only TaskLinkCollection
.
public VbaProject getVbaProject()
Represents an instance of VbaProject class.
VbaProject
objects.public ViewCollection getViews()
Contains a list of View
objects.
public WBSCodeDefinition getWBSCodeDefinition()
Gets WBS Code Definition for the project.
public void setWBSCodeDefinition(WBSCodeDefinition value)
value
- WBS Code Definition for the project.public static ProjectFileInfo getProjectFileInfo(String filename)
Read project file info from the file.
filename
- The project filename.Aspose.Tasks.ProjectFileInfo
.public static ProjectFileInfo getProjectFileInfo(InputStream stream)
Gets project file info from the stream.
stream
- The data stream.Aspose.Tasks.ProjectFileInfo
class.public void calcResourceFields()
Recalculates Id, Start and Finish of resources.
public void calcResourceStartFinish()
Recalculates Start and Finish of resources.
public void copyTo(Project another)
Copies project's main data and properties to another project.
another
- Another project to copy data to.public <T> T get(Key<T,Integer> key)
Returns the value to which the property is mapped in this container.
key
- the specified property key. Prj
for getting the property key.public Date getBaselineSaveTime(int baselineNumber)
Returns the baseline save time. Returns DateTime.MinValue if the baseline was not saved.
baselineNumber
- The baseline's number Aspose.Tasks.BaselineType
.public Duration getDuration(double val)
Gets Duration
object with the specified double
value and default duration format.
val
- specified value.public Duration getDuration(double val, int timeUnit)
Gets Duration
object with the specified TimeSpan
value and specified TimeUnitType
value.
val
- specified double value.timeUnit
- specified TimeUnitType value.public int getPageCount(int format, int scale)
Returns page count for the project to be rendered using given Timescale
and PresentationFormat
.
format
- PresentationFormat
to get page count for.scale
- Timescale
to get page count for.public int getPageCount_PageSize(int pageSize, int scale, Date startDate, Date endDate)
Returns page count for the project to be rendered using given Timescale
, PresentationFormat
and date range.
pageSize
- PageSize
to get page count for.scale
- Timescale
to get page count for.startDate
- Start date to get page count for.endDate
- End date to get page count for.public int getPageCount_PageSize(int pageSize, int scale)
Returns page count for the project to be rendered using given Timescale
and PageSize
.
pageSize
- PageSize
to get page count for.scale
- Timescale
to get page count for.public int getPageCount_PresentationFormat(int format)
Returns page count for the project to be rendered using default Timescale
(Days) and given PresentationFormat
format
- PresentationFormat
to get page count for.public int getPageCount_Timescale(int scale)
Returns page count for the project to be rendered using given Timescale
.
scale
- Timescale
to get page count for.public TaskLinkCollection getPredecessors(Task task)
Returns a collection of task links which are predecessors of the specified task.
task
- the specified Task object.TaskLink
of the specified task.public Duration getWork(double val)
Gets Duration
object with the specified double
value and default work format.
val
- specified double value.public void recalculate()
Reschedules all project tasks ids, outline levels, start/finish dates, sets early/late dates, calculates slacks, work and cost fields.
public void recalculate(boolean validate)
Reschedules all project tasks ids, outline levels, start/finish dates, sets early/late dates, calculates slacks, work and cost fields with optional validation.
validate
- If true the validation of recalculation will be performed.
What data is validated:
At the moment only basic validation of task and task link date ranges is implemented.
Task's date ranges (e.g. ActualStart - ActualFinish, EarlyStart - EarlyFinish, etc.) as well as Task Links dates will be checked against the date criteria that start date is less or equal than finish date.
If any of conditions described above is failed then RecalculationValidationException
will be thrown.public void removeInvalidResourceAssignments()
Eliminates invalid resource assignments from the project resource assignments list. MS Project creates an empty resource assignment for each task. Call the method to remove them.
public void renumberWBSCode()
Renumber WBS code of all tasks.
public void renumberWBSCode(List<Integer> taskIds)
Renumber WBS code of passed tasks.
taskIds
- Task identifiers to renumber WBS codes.public void rescheduleUncompletedWorkToStartAfter(Date after)
Reschedules uncompleted project work to start after a specified date.
after
- DateTime
to reschedule uncompleted work after.
Ensure that Project.CanSplitsInProgressTasks flag is set to true before using this method.
public void rescheduleUncompletedWorkToStartAfter(Date after, List<Task> tasks)
Reschedules uncompleted work for a specified list of tasks to start after a specified date.
after
- DateTime
to reschedule uncompleted work after.tasks
- List<Task> of tasks to reschedule uncompleted work for.
Ensure that Project.CanSplitsInProgressTasks flag is set to true before using this method.
public void save(String filename, MPPSaveOptions options)
Saves the document to mpp file format using the specified save options.
filename
- The file name.options
- MPPSaveOptions
save options.public void save(String filename, SaveOptions options)
Saves the document to a file using the specified save options.
filename
- The file name.options
- SaveOptions
save options.public void save(String filename, int format)
Saves the project data to the file.
filename
- The file name.format
- SaveFileFormat
save file format.public void save(OutputStream stream, MPPSaveOptions options) throws IOException
Saves the project to a stream using the specified save options.
stream
- The stream.options
- MPPSaveOptions
save options.IOException
public void save(OutputStream stream, SaveOptions options) throws IOException
Saves the project to a stream using the specified save options.
stream
- The stream.options
- SaveOptions
save options.IOException
public void save(OutputStream stream, int format) throws IOException
Saves the project data to the output stream.
stream
- The output stream to save project data to.format
- the specified save file format.SaveFileFormat
IOException
public void saveAsTemplate(String fileName, SaveTemplateOptions options)
Saves the project as a template.
fileName
- The file name.options
- the specified save options SaveTemplateOptions
.public void saveAsTemplate(String fileName)
Saves the project as a template to the specified file path.
fileName
- the specified file name.public void saveAsTemplate(OutputStream stream)
Saves the project as a template to a specified stream.
stream
- the specified stream to save the project to.public void saveAsTemplate(OutputStream stream, SaveTemplateOptions options) throws IOException
Saves the project as a template to a specified stream.
stream
- Stream to save the project template to.options
- the specified save options SaveTemplateOptions
.IOException
public void saveReport(OutputStream stream) throws IOException
Saves the project overview report to the stream.
stream
- The stream to save project report to.IOException
public void saveReport(String fileName)
Saves the project overview report to pdf file.
fileName
- The file name.public void saveReport(OutputStream stream, int reportType) throws IOException
Saves the project report of the specified type to the specified stream.
stream
- the specified stream to save project report to.reportType
- the specified report type.ReportType
IOException
public void saveReport(String fileName, int reportType)
Saves the project report of the specified type in pdf format to the specified file path.
fileName
- the specified file name.reportType
- the specified report type.ReportType
public List<Task> selectAllChildTasks()
Recursively collects all child tasks of this task.
java.util.List<Task>
which consists of all child tasks of this task.public <T> void set(Key<T,Integer> key, T val)
T
- the type of the mapped value.key
- the specified property key. Prj
for getting the property key.val
- the value.public void set(Key<Date,Integer> key, Date val)
Maps the specified property to the specified value in this container.
key
- the specified property key. Prj
for getting the property key.val
- the value.public void setBaseline(int baselineType)
Saves baseline fields to the specified baseline for the entire project.
baselineType
- BaselineType
to save baseline data to.public void setBaseline(int baselineType, Iterable<Task> tasks)
Saves baseline fields to the specified baseline for the selected tasks.
baselineType
- BaselineType
to save baseline data to.tasks
- List of tasks to save baseline data for.public void updateProjectWorkAsComplete(Date completeThrough, boolean setZeroOrHundredPercentCompleteOnly)
Updates all work as complete through a specified date for the entire project.
completeThrough
- DateTime
to update work as completed through.setZeroOrHundredPercentCompleteOnly
- If set to true updates only those tasks as 100% complete whose finish date is before specified complete-through date.
Otherwise, calculates a percentage complete value based on scheduled start and complete-through dates.public void updateProjectWorkAsComplete(Date completeThrough, boolean setZeroOrHundredPercentCompleteOnly, List<Task> tasks)
Updates all work as complete through a specified date for the specified list of tasks.
completeThrough
- DateTime
to update work as completed through.setZeroOrHundredPercentCompleteOnly
- If set to true updates only those tasks as 100% complete whose finish date is before specified complete-through date.
Otherwise, calculates a percentage complete value based on scheduled start and complete-through dates.tasks
- List<Task> of tasks to update work for.Copyright (c) 2008-2018 Aspose Pty Ltd. All Rights Reserved.