Class Project
- java.lang.Object
-
- com.aspose.tasks.Project
-
public class Project extends Object
Represents a project.
The Project is a central class in the Aspose.Tasks library.
One can use Project to read one of supported project management formats: MPP, MPT, MPX, XML.To load an existing document in any of the supported formats, pass a file name or a stream into one of the Project constructors. To create a blank project, call the parameterless constructor.
Use one of the Save method overloads to save the project in any of the
SaveFileFormatformats: Primavera: P6 XML, PM XER; Microsoft Excel: XLSX, XML; Fixed Layout: PDF; Images: JPEG, PNG, BMP, TIFF, SVG; Text: TXT; Others: HTML.To print the project, use one of the
print()method overloads.The Project stores project-wide information such as
Aspose.Tasks.Project.Views(getViews()/setViews(ViewCollection)),Aspose.Tasks.Project.BuiltInProps(getBuiltInProps()/setBuiltInProps(BuiltInProjectPropertyCollection)),Aspose.Tasks.Project.CustomProps(getCustomProps()/setCustomProps(CustomProjectPropertyCollection)), andAspose.Tasks.Project.ExtendedAttributes(getExtendedAttributes()/setExtendedAttributes(ExtendedAttributeDefinitionCollection)). Most of these objects are accessible via the corresponding properties of the Project class.The Project is a root entity that contains entry points to manipulate other project entities, such as
The Project entities can be accessed via typed collections, for exampleTask,Resource,ResourceAssignment,ExtendedAttributeandCalendar.Aspose.Tasks.Task.Children(Task.getChildren()/Task.setChildren(TaskCollection)),Aspose.Tasks.Project.Resources(getResources()/setResources(ResourceCollection)),Aspose.Tasks.Project.ResourceAssignments(getResourceAssignments()/setResourceAssignments(ResourceAssignmentCollection)), etc.
-
-
Constructor Summary
Constructors Constructor Description Project()Initializes a new instance of theProjectclass.Project(DbSettings settings)Initializes a new instance of theProjectclass to read data from a database which is specified by the instance of theDbSettingsclass.Project(InputStream stream)Initializes a new instance of theProjectclass from a stream.Project(InputStream stream, LoadOptions options)Initializes a new instance of theProjectclass from the Stream with the specified instance of theLoadOptionsclass.Project(InputStream stream, ParseErrorCallback parseErrorHandler)Initializes a new instance of theProjectclass from a template(existent mpp or mpt file).Project(InputStream stream, PrimaveraReadOptions options)Initializes a new instance of theProjectclass from the Stream with the specified instance of thePrimaveraReadOptionsclass.Project(InputStream stream, String protectionPassword)Initializes a new instance of theProjectclass from a template(existent mpp or mpt file).Project(String projectTemplate)Initializes a new instance of theProjectclass from a template (existent mpp or mpt file).Project(String projectTemplate, LoadOptions options)Initializes a new instance of theProjectclass from a template (existent mpp or mpt file) with the specified instance of theLoadOptionsclass.Project(String projectTemplate, ParseErrorCallback parseErrorHandler)Initializes a new instance of theProjectclass from a template (existent mpp or mpt file).Project(String projectTemplate, PrimaveraReadOptions options)Initializes a new instance of theProjectclass from a template (existent MPP or MPT file) with the specified instance of thePrimaveraReadOptionsclass.Project(String projectTemplate, String protectionPassword)Initializes a new instance of theProjectclass from a password protected template (existent mpp or mpt file).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcopyTo(Project another)Copies project's main data and properties to another project.voidcopyTo(Project another, CopyToOptions options)Copies project's main data and properties to another project.Iterable<Task>enumerateAllChildTasks()Recursively enumerates all project's tasks including root task.<T> Tget(Key<T,Byte> key)Returns the value to which the property is mapped in this container.NullableBoolgetActualsInSync()Gets a value indicating whether ActualsInSync is set or not.NullableBoolgetAdminProject()Gets a value indicating whether AdminProject is set or not.NullableBoolgetAreEditableActualCosts()Gets a value indicating whether AreEditableActualCosts is set or not.StringgetAuthor()Gets a value of Author.NullableBoolgetAutoAddNewResourcesAndTasks()Gets a value indicating whether AutoAddNewResourcesAndTasks is set or not.booleangetAutoCalculateAssignmentCosts()Gets whether assignment cost and remaining cost should be auto calculated using assignment's work and resource rates.NullableBoolgetAutolink()Gets a value indicating whether Autolink is set or not.intgetBaselineForEarnedValue()Gets a value of BaselineForEarnedValue.DategetBaselineSaveTime(int baselineNumber)Returns the baseline save time.BuiltInProjectPropertyCollectiongetBuiltInProps()Gets project's built-in properties collection.intgetCalculationMode()Gets calculation mode of a project.CalendargetCalendar()Gets a value of Calendar.CalendarCollectiongetCalendars()GetsCalendarCollectionobject of this Project instance.StringgetCategory()Gets a value of Category.StringgetComments()Gets a value of Comments.StringgetCompany()Gets a value of Company.DategetCreationDate()Gets a value of CreationDate.TaskCollectiongetCriticalPath()Gets a collection which contains a list of Critical tasks which comprise Critical Path of this project.intgetCriticalSlackLimit()Gets a value of CriticalSlackLimit.StringgetCurrencyCode()Gets a value of CurrencyCode.intgetCurrencyDigits()Gets a value of CurrencyDigits.StringgetCurrencySymbol()Gets a value of CurrencySymbol.intgetCurrencySymbolPosition()Gets a value of CurrencySymbolPosition.DategetCurrentDate()Gets a value of CurrentDate.StringgetCustomDateFormat()Gets a value of CustomDateFormat.CustomProjectPropertyCollectiongetCustomProps()Gets project's custom properties collection.intgetDateFormat()Gets a value of DateFormat.intgetDaysPerMonth()Gets a value of DaysPerMonth.DategetDefaultFinishTime()Gets a value of DefaultFinishTime.intgetDefaultFixedCostAccrual()Gets a value of DefaultFixedCostAccrual.doublegetDefaultOvertimeRate()Gets a value of DefaultOvertimeRate.doublegetDefaultStandardRate()Gets a value of DefaultStandardRate.DategetDefaultStartTime()Gets a value of DefaultStartTime.intgetDefaultTaskEVMethod()Gets a value of DefaultTaskEVMethod.intgetDefaultTaskType()Gets a value of DefaultTaskType.ViewgetDefaultView()Gets default view of the project.WeekDayCollectiongetDefaultWeekWorkingDays()Gets the instance ofWeekDayCollectionclass which represents a collection of project default week working days and working times.ProjectDisplayOptionsgetDisplayOptions()Gets an instance of theProjectDisplayOptionsclass.DurationgetDuration(double val)GetsDurationobject with the specified number of units and default duration format which is defined in project's settingsPrj.DURATION_FORMAT.DurationgetDuration(double val, byte timeUnit)GetsDurationobject with the specified number ofTimeUnitTypeunits.bytegetDurationFormat()Gets a value of DurationFormat.intgetEarnedValueMethod()Gets a value of EarnedValueMethod.ExtendedAttributeDefinitionCollectiongetExtendedAttributes()Gets ExtendedAttributeDefinitionCollection object.DategetExtendedCreationDate()Gets a value of ExtendedCreationDate.DategetFinishDate()Gets a value of FinishDate.NullableBoolgetFiscalYearStart()Gets a value indicating whether FiscalYearStart is set or not.intgetFyStartDate()Gets a value of FyStartDate.UUIDgetGuid()Gets a value of Guid.NullableBoolgetHonorConstraints()Gets a value indicating whether HonorConstraints is set or not.StringgetHyperlinkBase()Gets a value of HyperlinkBase.NullableBoolgetInsertedProjectsLikeSummary()Gets a value indicating whether InsertedProjectsLikeSummary is set or not.NullableBoolgetKeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled()Gets a value indicating whether KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled is set or not.StringgetKeywords()Gets a value of Keywords.StringgetLastAuthor()Gets a value of LastAuthor.DategetLastPrinted()Gets a value of LastPrinted.DategetLastSaved()Gets a value of LastSaved.StringgetManager()Gets a value of Manager.NullableBoolgetMicrosoftProjectServerURL()Gets a value indicating whether MicrosoftProjectServerURL is set or not.intgetMinutesPerDay()Gets a value of MinutesPerDay.intgetMinutesPerWeek()Gets a value of MinutesPerWeek.NullableBoolgetMoveCompletedEndsBack()Gets a value indicating whether MoveCompletedEndsBack is set or not.NullableBoolgetMoveCompletedEndsForward()Gets a value indicating whether MoveCompletedEndsForward is set or not.NullableBoolgetMoveRemainingStartsBack()Gets a value indicating whether MoveRemainingStartsBack is set or not.NullableBoolgetMoveRemainingStartsForward()Gets a value indicating whether MoveRemainingStartsForward is set or not.NullableBoolgetMultipleCriticalPaths()Gets a value indicating whether MultipleCriticalPaths is set or not.StringgetName()Gets a value of Name.NullableBoolgetNewTasksAreManual()Gets a value indicating whether NewTasksAreManual is set or not.NullableBoolgetNewTasksEffortDriven()Gets a value indicating whether NewTasksEffortDriven is set or not.NullableBoolgetNewTasksEstimated()Gets a value indicating whether NewTasksEstimated is set or not.intgetNewTaskStartDate()Gets a value of NewTaskStartDate.OleObjectCollectiongetOleObjects()Gets a collection containing the instances of theOleObjectclass which are linked or embedded to this project file.OutlineCodeDefinitionCollectiongetOutlineCodes()Gets OutlineCodeDefinitionCollection object.intgetPageCount()Returns page count for the project to be rendered using defaultTimescale(Days).intgetPageCount(int format, int scale)Returns page count for the project to be rendered using givenTimescaleandPresentationFormat.intgetPageCount(SaveOptions saveOptions)Returns page count for the project to be rendered using givenSaveOptions.intgetPageCount_PageSize(int pageSize, int scale)intgetPageCount_PageSize(int pageSize, int scale, Date startDate, Date endDate)Returns page count for the project to be rendered using givenTimescale,PresentationFormatand date range.intgetPageCount_PresentationFormat(int format)Returns page count for the project to be rendered using defaultTimescale(Days) and givenPresentationFormatintgetPageCount_Timescale(int scale)Returns page count for the project to be rendered using givenTimescale.TaskLinkCollectiongetPredecessors(Task task)Returns a collection of task links which are predecessors of the specified task.PrimaveraProjectPropertiesgetPrimaveraProperties()Gets an object containing Primavera-specific properties for a project read from Primavera file.NullableBoolgetProjectExternallyEdited()Gets a value indicating whether ProjectExternallyEdited is set or not.static ProjectFileInfogetProjectFileInfo(InputStream stream)Gets project file info from the stream.static ProjectFileInfogetProjectFileInfo(String filename)Read project file info from the file.NullableBoolgetRemoveFileProperties()Gets a value indicating whether RemoveFileProperties is set or not.ResourceAssignmentCollectiongetResourceAssignments()Gets ResourceAssignmentCollection object.FilterCollectiongetResourceFilters()Gets all the resource-based filter definitions.GroupCollectiongetResourceGroups()Gets all of the resource-based group definitions.ResourceCollectiongetResources()Gets ResourceCollection object.intgetRevision()Gets a value of Revision.TaskgetRootTask()Gets the root of the tree of tasks.intgetSaveVersion()Gets a value of SaveVersion.NullableBoolgetScheduleFromStart()Gets a value indicating whether ScheduleFromStart is set or not.booleangetShowProjectSummaryTask()Gets a value indicating whether ShowProjectSummaryTask is set or not.NullableBoolgetSplitsInProgressTasks()Gets a value indicating whether SplitsInProgressTasks is set or not.NullableBoolgetSpreadActualCost()Gets a value indicating whether SpreadActualCost is set or not.NullableBoolgetSpreadPercentComplete()Gets a value indicating whether SpreadPercentComplete is set or not.DategetStartDate()Gets a value of StartDate.DategetStatusDate()Gets a value of StatusDate.StringgetSubject()Gets a value of Subject.TableCollectiongetTables()Gets a list ofTableobjects.FilterCollectiongetTaskFilters()Gets all the task-based filter definitions.GroupCollectiongetTaskGroups()Gets all the task-based group definitions.TaskLinkCollectiongetTaskLinks()GetsTaskLinkCollectionobject.NullableBoolgetTaskUpdatesResource()Gets a value indicating whether TaskUpdatesResource is set or not.StringgetTemplate()Gets a value of Template.DategetTimescaleFinish()Gets a value of TimescaleFinish.DategetTimescaleStart()Gets a value of TimescaleStart.StringgetTitle()Gets a value of Title.StringgetUid()Gets a value of Uid.NullableBoolgetUpdateManuallyScheduledTasksWhenEditingLinks()Gets a value indicating whether UpdateManuallyScheduledTasksWhenEditingLinks is set or not.VbaProjectgetVbaProject()ViewCollectiongetViews()Gets a list ofViewobjects.WBSCodeDefinitiongetWBSCodeDefinition()Gets WBS Code Definition for the project.intgetWeekStartDay()Gets a value of WeekStartDay.DurationgetWork(double val)GetsDurationobject with the specifieddoublevalue and default work format.bytegetWorkFormat()Gets a value of WorkFormat.voidprint()Prints project to the default printer with default printer settings using the standard (no User Interface) print controller.voidprint(PrinterSettings printerSettings)Prints project according to the specified printer settings using the standard (no User Interface) print controller.voidprint(PrinterSettings printerSettings, PrintOptions options)Prints project according to the specified printer settings and custom save options using the standard (no User Interface) print controller.voidprint(PrinterSettings printerSettings, PrintOptions options, String documentName)Prints project according to the specified printer settings, custom save options and the specified document name using the standard (no User Interface) print controller.voidprint(PrinterSettings printerSettings, String documentName)Prints project according to the specified printer settings using the standard (no User Interface) print controller.voidprint(PrintOptions options)Prints project to the default printer with default printer settings and custom save options using the standard (no User Interface) print controller.voidprint(String printerName)Prints project to the specified printer with default printer settings using the standard (no User Interface) print controller.voidrecalculate()Reschedules all project tasks ids, outline levels, start/finish dates, sets early/late dates, calculates slacks, work and cost fields.voidrecalculate(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.voidrecalculateResourceFields()Recalculates Id, Start and Finish of resources.voidrecalculateResourceStartFinish()Recalculates Start and Finish of resources.voidremoveInvalidResourceAssignments()Eliminates invalid resource assignments from the project resource assignments list.voidrenumberWBSCode()Renumber WBS code of all tasks.voidrenumberWBSCode(List<Integer> taskIds)Renumber WBS code of passed tasks.voidrescheduleUncompletedWorkToStartAfter(Date after)Reschedules uncompleted project work to start after a specified date.voidrescheduleUncompletedWorkToStartAfter(Date after, List<Task> taskCollection)Reschedules uncompleted work for a specified list of tasks to start after a specified date.voidsave(OutputStream stream, int format)Saves the project data to the stream.voidsave(OutputStream stream, SimpleSaveOptions options)Saves the project to a stream using the specified save options.voidsave(String filename)Saves the project data to the file in mpp format.voidsave(String filename, int format)Saves the project data to the file.voidsave(String filename, SimpleSaveOptions options)Saves the document to a file using the specified save options.voidsaveAsTemplate(OutputStream stream)Saves the project as a template to a specified stream.voidsaveAsTemplate(OutputStream stream, SaveTemplateOptions options)Saves the project as a template to a specified stream.voidsaveAsTemplate(String fileName)Saves the project as a template to the specified file path.voidsaveAsTemplate(String fileName, SaveTemplateOptions options)Saves the project as a template.voidsaveReport(OutputStream stream)Saves the project overview report to the stream.voidsaveReport(OutputStream stream, int reportType)Saves the project report of the specified type to the specified stream.voidsaveReport(String fileName)Saves the project overview report to PDF file.voidsaveReport(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 the root task.voidset(Key<Date,Byte> key, Date val)Maps the specified property to the specified value in this container.<T> voidset(Key<T,Byte> key, T val)Maps the specified property to the specified value in this container.voidsetActualsInSync(NullableBool value)Sets a value indicating whether ActualsInSync is set or not.voidsetAdminProject(NullableBool value)Sets a value indicating whether AdminProject is set or not.voidsetAreEditableActualCosts(NullableBool value)Sets a value indicating whether AreEditableActualCosts is set or not.voidsetAuthor(String value)Sets a value of Author.voidsetAutoAddNewResourcesAndTasks(NullableBool value)Sets a value indicating whether AutoAddNewResourcesAndTasks is set or not.voidsetAutoCalculateAssignmentCosts(boolean value)Sets whether assignment cost and remaining cost should be auto calculated using assignment's work and resource rates.voidsetAutolink(NullableBool value)Sets a value indicating whether Autolink is set or not.voidsetBaseline(int baselineType)Saves baseline fields to the specified baseline for the entire project.voidsetBaseline(int baselineType, Iterable<Task> taskCollection)Saves baseline fields to the specified baseline for the selected tasks.voidsetBaselineForEarnedValue(int value)Sets a value of BaselineForEarnedValue.voidsetBaselineSaveTime(int baselineNumber, Date value)Sets the baseline save time.voidsetCalculationMode(int value)Sets calculation mode of a project.voidsetCalendar(Calendar value)Sets a value of Calendar.voidsetCategory(String value)Sets a value of Category.voidsetComments(String value)Sets a value of Comments.voidsetCompany(String value)Sets a value of Company.voidsetCreationDate(Date value)Sets a value of CreationDate.voidsetCriticalSlackLimit(int value)Sets a value of CriticalSlackLimit.voidsetCurrencyCode(String value)Sets a value of CurrencyCode.voidsetCurrencyDigits(int value)Sets a value of CurrencyDigits.voidsetCurrencySymbol(String value)Sets a value of CurrencySymbol.voidsetCurrencySymbolPosition(int value)Sets a value of CurrencySymbolPosition.voidsetCurrentDate(Date value)Sets a value of CurrentDate.voidsetCustomDateFormat(String value)Sets a value of CustomDateFormat.voidsetDateFormat(int value)Sets a value of DateFormat.voidsetDaysPerMonth(int value)Sets a value of DaysPerMonth.voidsetDefaultFinishTime(Date value)Sets a value of DefaultFinishTime.voidsetDefaultFixedCostAccrual(int value)Sets a value of DefaultFixedCostAccrual.voidsetDefaultOvertimeRate(double value)Sets a value of DefaultOvertimeRate.voidsetDefaultStandardRate(double value)Sets a value of DefaultStandardRate.voidsetDefaultStartTime(Date value)Sets a value of DefaultStartTime.voidsetDefaultTaskEVMethod(int value)Sets a value of DefaultTaskEVMethod.voidsetDefaultTaskType(int value)Sets a value of DefaultTaskType.voidsetDefaultView(View value)Sets default view of the project.voidsetDurationFormat(byte value)Sets a value of DurationFormat.voidsetEarnedValueMethod(int value)Sets a value of EarnedValueMethod.voidsetExtendedCreationDate(Date value)Sets a value of ExtendedCreationDate.voidsetFinishDate(Date value)Sets a value of FinishDate.voidsetFiscalYearStart(NullableBool value)Sets a value indicating whether FiscalYearStart is set or not.voidsetFyStartDate(int value)Sets a value of FyStartDate.voidsetGuid(UUID value)Sets a value of Guid.voidsetHonorConstraints(NullableBool value)Sets a value indicating whether HonorConstraints is set or not.voidsetHyperlinkBase(String value)Sets a value of HyperlinkBase.voidsetInsertedProjectsLikeSummary(NullableBool value)Sets a value indicating whether InsertedProjectsLikeSummary is set or not.voidsetKeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled(NullableBool value)Sets a value indicating whether KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled is set or not.voidsetKeywords(String value)Sets a value of Keywords.voidsetLastAuthor(String value)Sets a value of LastAuthor.voidsetLastPrinted(Date value)Sets a value of LastPrinted.voidsetLastSaved(Date value)Sets a value of LastSaved.voidsetManager(String value)Sets a value of Manager.voidsetMicrosoftProjectServerURL(NullableBool value)Sets a value indicating whether MicrosoftProjectServerURL is set or not.voidsetMinutesPerDay(int value)Sets a value of MinutesPerDay.voidsetMinutesPerWeek(int value)Sets a value of MinutesPerWeek.voidsetMoveCompletedEndsBack(NullableBool value)Sets a value indicating whether MoveCompletedEndsBack is set or not.voidsetMoveCompletedEndsForward(NullableBool value)Sets a value indicating whether MoveCompletedEndsForward is set or not.voidsetMoveRemainingStartsBack(NullableBool value)Sets a value indicating whether MoveRemainingStartsBack is set or not.voidsetMoveRemainingStartsForward(NullableBool value)Sets a value indicating whether MoveRemainingStartsForward is set or not.voidsetMultipleCriticalPaths(NullableBool value)Sets a value indicating whether MultipleCriticalPaths is set or not.voidsetName(String value)Sets a value of Name.voidsetNewTasksAreManual(NullableBool value)Sets a value indicating whether NewTasksAreManual is set or not.voidsetNewTasksEffortDriven(NullableBool value)Sets a value indicating whether NewTasksEffortDriven is set or not.voidsetNewTasksEstimated(NullableBool value)Sets a value indicating whether NewTasksEstimated is set or not.voidsetNewTaskStartDate(int value)Sets a value of NewTaskStartDate.voidsetProjectExternallyEdited(NullableBool value)Sets a value indicating whether ProjectExternallyEdited is set or not.voidsetRemoveFileProperties(NullableBool value)Sets a value indicating whether RemoveFileProperties is set or not.voidsetRevision(int value)Sets a value of Revision.voidsetSaveVersion(int value)Sets a value of SaveVersion.voidsetScheduleFromStart(NullableBool value)Sets a value indicating whether ScheduleFromStart is set or not.voidsetShowProjectSummaryTask(boolean value)Sets a value indicating whether ShowProjectSummaryTask is set or not.voidsetSplitsInProgressTasks(NullableBool value)Sets a value indicating whether SplitsInProgressTasks is set or not.voidsetSpreadActualCost(NullableBool value)Sets a value indicating whether SpreadActualCost is set or not.voidsetSpreadPercentComplete(NullableBool value)Sets a value indicating whether SpreadPercentComplete is set or not.voidsetStartDate(Date value)Sets a value of StartDate.voidsetStatusDate(Date value)Sets a value of StatusDate.voidsetSubject(String value)Sets a value of Subject.voidsetTaskUpdatesResource(NullableBool value)Sets a value indicating whether TaskUpdatesResource is set or not.voidsetTemplate(String value)Sets a value of Template.voidsetTimescaleFinish(Date value)Sets a value of TimescaleFinish.voidsetTimescaleStart(Date value)Sets a value of TimescaleStart.voidsetTitle(String value)Sets a value of Title.voidsetUid(String value)Sets a value of Uid.voidsetUpdateManuallyScheduledTasksWhenEditingLinks(NullableBool value)Sets a value indicating whether UpdateManuallyScheduledTasksWhenEditingLinks is set or not.voidsetWBSCodeDefinition(WBSCodeDefinition value)Sets WBS Code Definition for the project.voidsetWeekStartDay(int value)Sets a value of WeekStartDay.voidsetWorkFormat(byte value)Sets a value of WorkFormat.voidupdateProjectWorkAsComplete(Date completeThrough, boolean setZeroOrHundredPercentCompleteOnly)Updates all work as complete through a specified date for the entire project.voidupdateProjectWorkAsComplete(Date completeThrough, boolean setZeroOrHundredPercentCompleteOnly, List<Task> taskCollection)Updates all work as complete through a specified date for the specified list of tasks.
-
-
-
Constructor Detail
-
Project
public Project()
Initializes a new instance of the
Projectclass.
-
Project
public Project(String projectTemplate, String protectionPassword)
Initializes a new instance of the
Projectclass from a password protected template (existent mpp or mpt file).- Parameters:
projectTemplate- Path to template to create project from.protectionPassword- Protection password.
Reading password protected files currently supported for MSP 2003 file format only.
-
Project
public Project(String projectTemplate)
Initializes a new instance of the
Projectclass from a template (existent mpp or mpt file).- Parameters:
projectTemplate- Path to template to create project from.
-
Project
public Project(InputStream stream, PrimaveraReadOptions options)
Initializes a new instance of the
Projectclass from the Stream with the specified instance of thePrimaveraReadOptionsclass.- Parameters:
stream- Stream of the ProjectInputStreamclassoptions- the specified instance of thePrimaveraReadOptionsclass which allows to customize reading of Primavera formats (XER or XML).
-
Project
public Project(String projectTemplate, ParseErrorCallback parseErrorHandler)
Initializes a new instance of the
Projectclass from a template (existent mpp or mpt file).- Parameters:
projectTemplate- Path to template to create project from.parseErrorHandler- the specified callback method to handle xml parse errors.
-
Project
public Project(InputStream stream)
Initializes a new instance of the
Projectclass from a stream.- Parameters:
stream-InputStreamto load a template from.
-
Project
public Project(String projectTemplate, PrimaveraReadOptions options)
Initializes a new instance of the
Projectclass from a template (existent MPP or MPT file) with the specified instance of thePrimaveraReadOptionsclass.- Parameters:
projectTemplate- Path to template to create project fromoptions- the specified instance of thePrimaveraReadOptionsclass.
-
Project
public Project(DbSettings settings)
Initializes a new instance of the
Projectclass to read data from a database which is specified by the instance of theDbSettingsclass.- Parameters:
settings- the specified instance of theDbSettingsclass.
-
Project
public Project(InputStream stream, ParseErrorCallback parseErrorHandler)
Initializes a new instance of the
Projectclass from a template(existent mpp or mpt file).- Parameters:
stream-InputStreamto load a template from.parseErrorHandler- the specified callback method to handle xml parse errors.
-
Project
public Project(InputStream stream, String protectionPassword)
Initializes a new instance of the
Projectclass from a template(existent mpp or mpt file).- Parameters:
stream-InputStreamto load a template from.protectionPassword- Protection password.
Reading password protected files currently supported for MSP 2003 file format only.
-
Project
public Project(String projectTemplate, LoadOptions options)
Initializes a new instance of the
Projectclass from a template (existent mpp or mpt file) with the specified instance of theLoadOptionsclass.- Parameters:
projectTemplate- Path to template to create project fromoptions- the specified instance of theLoadOptionsclass.
-
Project
public Project(InputStream stream, LoadOptions options)
Initializes a new instance of the
Projectclass from the Stream with the specified instance of theLoadOptionsclass.- Parameters:
stream- Stream of the ProjectInputStreamclassoptions- the specified instance of theLoadOptionsclass
-
-
Method Detail
-
copyTo
public final void copyTo(Project another)
Copies project's main data and properties to another project.
- Parameters:
another- Another project to copy data to.
-
copyTo
public final void copyTo(Project another, CopyToOptions options)
Copies project's main data and properties to another project.
- Parameters:
another- Another project to copy data to.options- Copy options to control copy process.
-
enumerateAllChildTasks
public final Iterable<Task> enumerateAllChildTasks()
Recursively enumerates all project's tasks including root task.
- Returns:
- IEnumerable which can be used to iterate over all project's tasks.
Provides a more lightweight way to iterate over tasks compared toselectAllChildTasks()method as it does not allocate memory for all tasks.
-
get
public final <T> T get(Key<T,Byte> key)
Returns the value to which the property is mapped in this container.
- Parameters:
key- the specified property key.Prjfor getting the property key.- Returns:
- the value to which the property is mapped in this container.
-
getActualsInSync
public final NullableBool getActualsInSync()
Gets a value indicating whether ActualsInSync is set or not.
- Returns:
- a value indicating whether ActualsInSync is set or not.
-
setActualsInSync
public final void setActualsInSync(NullableBool value)
Sets a value indicating whether ActualsInSync is set or not.
- Parameters:
value- a value indicating whether ActualsInSync is set or not.
-
getAdminProject
public final NullableBool getAdminProject()
Gets a value indicating whether AdminProject is set or not.
- Returns:
- a value indicating whether AdminProject is set or not.
-
setAdminProject
public final void setAdminProject(NullableBool value)
Sets a value indicating whether AdminProject is set or not.
- Parameters:
value- a value indicating whether AdminProject is set or not.
-
getAreEditableActualCosts
public final NullableBool getAreEditableActualCosts()
Gets a value indicating whether AreEditableActualCosts is set or not.
- Returns:
- a value indicating whether AreEditableActualCosts is set or not.
-
setAreEditableActualCosts
public final void setAreEditableActualCosts(NullableBool value)
Sets a value indicating whether AreEditableActualCosts is set or not.
- Parameters:
value- a value indicating whether AreEditableActualCosts is set or not.
-
getAuthor
public final String getAuthor()
Gets a value of Author.
- Returns:
- a value of Author.
-
setAuthor
public final void setAuthor(String value)
Sets a value of Author.
- Parameters:
value- a value of Author.
-
getAutoAddNewResourcesAndTasks
public final NullableBool getAutoAddNewResourcesAndTasks()
Gets a value indicating whether AutoAddNewResourcesAndTasks is set or not.
- Returns:
- a value indicating whether AutoAddNewResourcesAndTasks is set or not.
-
setAutoAddNewResourcesAndTasks
public final void setAutoAddNewResourcesAndTasks(NullableBool value)
Sets a value indicating whether AutoAddNewResourcesAndTasks is set or not.
- Parameters:
value- a value indicating whether AutoAddNewResourcesAndTasks is set or not.
-
getAutoCalculateAssignmentCosts
public final boolean getAutoCalculateAssignmentCosts()
Gets whether assignment cost and remaining cost should be auto calculated using assignment's work and resource rates.
- Returns:
- whether assignment cost and remaining cost should be auto calculated using assignment's work and resource rates.
-
setAutoCalculateAssignmentCosts
public final void setAutoCalculateAssignmentCosts(boolean value)
Sets whether assignment cost and remaining cost should be auto calculated using assignment's work and resource rates.
- Parameters:
value- whether assignment cost and remaining cost should be auto calculated using assignment's work and resource rates.
-
getAutolink
public final NullableBool getAutolink()
Gets a value indicating whether Autolink is set or not.
- Returns:
- a value indicating whether Autolink is set or not.
-
setAutolink
public final void setAutolink(NullableBool value)
Sets a value indicating whether Autolink is set or not.
- Parameters:
value- a value indicating whether Autolink is set or not.
-
getBaselineForEarnedValue
public final int getBaselineForEarnedValue()
Gets a value of BaselineForEarnedValue.
- Returns:
- a value of BaselineForEarnedValue.
-
setBaselineForEarnedValue
public final void setBaselineForEarnedValue(int value)
Sets a value of BaselineForEarnedValue.
- Parameters:
value- a value of BaselineForEarnedValue.
-
getBaselineSaveTime
public final Date getBaselineSaveTime(int baselineNumber)
Returns the baseline save time. Returns DateTime.MinValue (00:00:00.0000000 UTC, 1st January 0001) if the baseline was not saved.
- Parameters:
baselineNumber- The baseline's numberBaselineType.- Returns:
- The baseline's last save date and time.
-
getBuiltInProps
public final BuiltInProjectPropertyCollection getBuiltInProps()
Gets project's built-in properties collection.
- Returns:
- project's built-in properties collection.
-
getCalculationMode
public final int getCalculationMode()
Gets calculation mode of a project. Can be one of the values of
CalculationMode(getCalculationMode()/setCalculationMode(int)) enumeration.- Returns:
- calculation mode of a project.
-
setCalculationMode
public final void setCalculationMode(int value)
Sets calculation mode of a project. Can be one of the values of
CalculationMode(getCalculationMode()/setCalculationMode(int)) enumeration.- Parameters:
value- calculation mode of a project.
-
getCalendar
public final Calendar getCalendar()
Gets a value of Calendar.
- Returns:
- a value of Calendar.
-
setCalendar
public final void setCalendar(Calendar value)
Sets a value of Calendar.
- Parameters:
value- a value of Calendar.
-
getCalendars
public final CalendarCollection getCalendars()
Gets
CalendarCollectionobject of this Project instance.- Returns:
CalendarCollectionobject of this Project instance.
-
getCategory
public final String getCategory()
Gets a value of Category.
- Returns:
- a value of Category.
-
setCategory
public final void setCategory(String value)
Sets a value of Category.
- Parameters:
value- a value of Category.
-
getComments
public final String getComments()
Gets a value of Comments.
- Returns:
- a value of Comments.
-
setComments
public final void setComments(String value)
Sets a value of Comments.
- Parameters:
value- a value of Comments.
-
getCompany
public final String getCompany()
Gets a value of Company.
- Returns:
- a value of Company.
-
setCompany
public final void setCompany(String value)
Sets a value of Company.
- Parameters:
value- a value of Company.
-
getCreationDate
public final Date getCreationDate()
Gets a value of CreationDate.
- Returns:
- a value of CreationDate.
-
setCreationDate
public final void setCreationDate(Date value)
Sets a value of CreationDate.
- Parameters:
value- a value of CreationDate.
-
getCriticalPath
public final TaskCollection getCriticalPath()
Gets a collection which contains a list of Critical tasks which comprise Critical Path of this project.
- Returns:
- a collection which represents a list of all critical tasks.
This is an O(n) operation, where n is the number of tasks in the project.
-
getCriticalSlackLimit
public final int getCriticalSlackLimit()
Gets a value of CriticalSlackLimit.
- Returns:
- a value of CriticalSlackLimit.
-
setCriticalSlackLimit
public final void setCriticalSlackLimit(int value)
Sets a value of CriticalSlackLimit.
- Parameters:
value- a value of CriticalSlackLimit.
-
getCurrencyCode
public final String getCurrencyCode()
Gets a value of CurrencyCode.
- Returns:
- a value of CurrencyCode.
-
setCurrencyCode
public final void setCurrencyCode(String value)
Sets a value of CurrencyCode.
- Parameters:
value- a value of CurrencyCode.
-
getCurrencyDigits
public final int getCurrencyDigits()
Gets a value of CurrencyDigits.
- Returns:
- a value of CurrencyDigits.
-
setCurrencyDigits
public final void setCurrencyDigits(int value)
Sets a value of CurrencyDigits.
- Parameters:
value- a value of CurrencyDigits.
-
getCurrencySymbol
public final String getCurrencySymbol()
Gets a value of CurrencySymbol.
- Returns:
- a value of CurrencySymbol.
-
setCurrencySymbol
public final void setCurrencySymbol(String value)
Sets a value of CurrencySymbol.
- Parameters:
value- a value of CurrencySymbol.
-
getCurrencySymbolPosition
public final int getCurrencySymbolPosition()
Gets a value of CurrencySymbolPosition.
- Returns:
- a value of CurrencySymbolPosition.
-
setCurrencySymbolPosition
public final void setCurrencySymbolPosition(int value)
Sets a value of CurrencySymbolPosition.
- Parameters:
value- a value of CurrencySymbolPosition.
-
getCurrentDate
public final Date getCurrentDate()
Gets a value of CurrentDate.
- Returns:
- a value of CurrentDate.
-
setCurrentDate
public final void setCurrentDate(Date value)
Sets a value of CurrentDate.
- Parameters:
value- a value of CurrentDate.
-
getCustomDateFormat
public final String getCustomDateFormat()
Gets a value of CustomDateFormat.
- Returns:
- a value of CustomDateFormat.
-
setCustomDateFormat
public final void setCustomDateFormat(String value)
Sets a value of CustomDateFormat.
- Parameters:
value- a value of CustomDateFormat.
-
getCustomProps
public final CustomProjectPropertyCollection getCustomProps()
Gets project's custom properties collection.
- Returns:
- project's custom properties collection.
-
getDateFormat
public final int getDateFormat()
Gets a value of DateFormat.
- Returns:
- a value of DateFormat.
-
setDateFormat
public final void setDateFormat(int value)
Sets a value of DateFormat.
- Parameters:
value- a value of DateFormat.
-
getDaysPerMonth
public final int getDaysPerMonth()
Gets a value of DaysPerMonth.
- Returns:
- a value of DaysPerMonth.
-
setDaysPerMonth
public final void setDaysPerMonth(int value)
Sets a value of DaysPerMonth.
- Parameters:
value- a value of DaysPerMonth.
-
getDefaultFinishTime
public final Date getDefaultFinishTime()
Gets a value of DefaultFinishTime.
- Returns:
- a value of DefaultFinishTime.
-
setDefaultFinishTime
public final void setDefaultFinishTime(Date value)
Sets a value of DefaultFinishTime.
- Parameters:
value- a value of DefaultFinishTime.
-
getDefaultFixedCostAccrual
public final int getDefaultFixedCostAccrual()
Gets a value of DefaultFixedCostAccrual.
- Returns:
- a value of DefaultFixedCostAccrual.
-
setDefaultFixedCostAccrual
public final void setDefaultFixedCostAccrual(int value)
Sets a value of DefaultFixedCostAccrual.
- Parameters:
value- a value of DefaultFixedCostAccrual.
-
getDefaultOvertimeRate
public final double getDefaultOvertimeRate()
Gets a value of DefaultOvertimeRate.
- Returns:
- a value of DefaultOvertimeRate.
-
setDefaultOvertimeRate
public final void setDefaultOvertimeRate(double value)
Sets a value of DefaultOvertimeRate.
- Parameters:
value- a value of DefaultOvertimeRate.
-
getDefaultStandardRate
public final double getDefaultStandardRate()
Gets a value of DefaultStandardRate.
- Returns:
- a value of DefaultStandardRate.
-
setDefaultStandardRate
public final void setDefaultStandardRate(double value)
Sets a value of DefaultStandardRate.
- Parameters:
value- a value of DefaultStandardRate.
-
getDefaultStartTime
public final Date getDefaultStartTime()
Gets a value of DefaultStartTime.
- Returns:
- a value of DefaultStartTime.
-
setDefaultStartTime
public final void setDefaultStartTime(Date value)
Sets a value of DefaultStartTime.
- Parameters:
value- a value of DefaultStartTime.
-
getDefaultTaskEVMethod
public final int getDefaultTaskEVMethod()
Gets a value of DefaultTaskEVMethod.
- Returns:
- a value of DefaultTaskEVMethod.
-
setDefaultTaskEVMethod
public final void setDefaultTaskEVMethod(int value)
Sets a value of DefaultTaskEVMethod.
- Parameters:
value- a value of DefaultTaskEVMethod.
-
getDefaultTaskType
public final int getDefaultTaskType()
Gets a value of DefaultTaskType.
- Returns:
- a value of DefaultTaskType.
-
setDefaultTaskType
public final void setDefaultTaskType(int value)
Sets a value of DefaultTaskType.
- Parameters:
value- a value of DefaultTaskType.
-
getDefaultView
public final View getDefaultView()
Gets default view of the project.
- Returns:
- default view of the project.
-
setDefaultView
public final void setDefaultView(View value)
Sets default view of the project.
- Parameters:
value- default view of the project.
-
getDefaultWeekWorkingDays
public final WeekDayCollection getDefaultWeekWorkingDays()
Gets the instance of
WeekDayCollectionclass which represents a collection of project default week working days and working times.- Returns:
- The instance of
WeekDayCollectionclass which contains a list ofWeekDayobjects.
The data contains only in mpp files (not in xml).
-
getDisplayOptions
public final ProjectDisplayOptions getDisplayOptions()
Gets an instance of the
ProjectDisplayOptionsclass.- Returns:
- an instance of the
ProjectDisplayOptionsclass.
-
getDuration
public final Duration getDuration(double val)
Gets
Durationobject with the specified number of units and default duration format which is defined in project's settingsPrj.DURATION_FORMAT.- Parameters:
val- specified number of units.
This method should be used carefully because it returns different durations depending on Project.DurationFormat setting. For example, GetWork(1.0) will return 1 hour when Project.DurationFormat is TimeUnitType.Hour or 1 day if Project.DurationFormat is TimeUnitType.Day.- Returns:
- Duration object.
-
getDuration
public final Duration getDuration(double val, byte timeUnit)
Gets
Durationobject with the specified number ofTimeUnitTypeunits.- Parameters:
val- specified number of units.timeUnit- specified TimeUnitType value.- Returns:
- Duration object.
-
getDurationFormat
public final byte getDurationFormat()
Gets a value of DurationFormat.
- Returns:
- a value of DurationFormat.
-
setDurationFormat
public final void setDurationFormat(byte value)
Sets a value of DurationFormat.
- Parameters:
value- a value of DurationFormat.
-
getEarnedValueMethod
public final int getEarnedValueMethod()
Gets a value of EarnedValueMethod.
- Returns:
- a value of EarnedValueMethod.
-
setEarnedValueMethod
public final void setEarnedValueMethod(int value)
Sets a value of EarnedValueMethod.
- Parameters:
value- a value of EarnedValueMethod.
-
getExtendedAttributes
public final ExtendedAttributeDefinitionCollection getExtendedAttributes()
Gets ExtendedAttributeDefinitionCollection object. The collection of extended attribute (custom fields) definitions associated with a project.
- Returns:
- ExtendedAttributeDefinitionCollection object.
-
getExtendedCreationDate
public final Date getExtendedCreationDate()
Gets a value of ExtendedCreationDate.
- Returns:
- a value of ExtendedCreationDate.
-
setExtendedCreationDate
public final void setExtendedCreationDate(Date value)
Sets a value of ExtendedCreationDate.
- Parameters:
value- a value of ExtendedCreationDate.
-
getFinishDate
public final Date getFinishDate()
Gets a value of FinishDate.
- Returns:
- a value of FinishDate.
-
setFinishDate
public final void setFinishDate(Date value)
Sets a value of FinishDate.
- Parameters:
value- a value of FinishDate.
-
getFiscalYearStart
public final NullableBool getFiscalYearStart()
Gets a value indicating whether FiscalYearStart is set or not.
- Returns:
- a value indicating whether FiscalYearStart is set or not.
-
setFiscalYearStart
public final void setFiscalYearStart(NullableBool value)
Sets a value indicating whether FiscalYearStart is set or not.
- Parameters:
value- a value indicating whether FiscalYearStart is set or not.
-
getFyStartDate
public final int getFyStartDate()
Gets a value of FyStartDate.
- Returns:
- a value of FyStartDate.
-
setFyStartDate
public final void setFyStartDate(int value)
Sets a value of FyStartDate.
- Parameters:
value- a value of FyStartDate.
-
getGuid
public final UUID getGuid()
Gets a value of Guid.
- Returns:
- a value of Guid.
-
setGuid
public final void setGuid(UUID value)
Sets a value of Guid.
- Parameters:
value- a value of Guid.
-
getHonorConstraints
public final NullableBool getHonorConstraints()
Gets a value indicating whether HonorConstraints is set or not.
- Returns:
- a value indicating whether HonorConstraints is set or not.
-
setHonorConstraints
public final void setHonorConstraints(NullableBool value)
Sets a value indicating whether HonorConstraints is set or not.
- Parameters:
value- a value indicating whether HonorConstraints is set or not.
-
getHyperlinkBase
public final String getHyperlinkBase()
Gets a value of HyperlinkBase.
- Returns:
- a value of HyperlinkBase.
-
setHyperlinkBase
public final void setHyperlinkBase(String value)
Sets a value of HyperlinkBase.
- Parameters:
value- a value of HyperlinkBase.
-
getInsertedProjectsLikeSummary
public final NullableBool getInsertedProjectsLikeSummary()
Gets a value indicating whether InsertedProjectsLikeSummary is set or not.
- Returns:
- a value indicating whether InsertedProjectsLikeSummary is set or not.
-
setInsertedProjectsLikeSummary
public final void setInsertedProjectsLikeSummary(NullableBool value)
Sets a value indicating whether InsertedProjectsLikeSummary is set or not.
- Parameters:
value- a value indicating whether InsertedProjectsLikeSummary is set or not.
-
getKeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled
public final NullableBool getKeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled()
Gets a value indicating whether KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled is set or not.
- Returns:
- a value indicating whether KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled is set or not.
-
setKeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled
public final void setKeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled(NullableBool value)
Sets a value indicating whether KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled is set or not.
- Parameters:
value- a value indicating whether KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled is set or not.
-
getKeywords
public final String getKeywords()
Gets a value of Keywords.
- Returns:
- a value of Keywords.
-
setKeywords
public final void setKeywords(String value)
Sets a value of Keywords.
- Parameters:
value- a value of Keywords.
-
getLastAuthor
public final String getLastAuthor()
Gets a value of LastAuthor.
- Returns:
- a value of LastAuthor.
-
setLastAuthor
public final void setLastAuthor(String value)
Sets a value of LastAuthor.
- Parameters:
value- a value of LastAuthor.
-
getLastPrinted
public final Date getLastPrinted()
Gets a value of LastPrinted.
- Returns:
- a value of LastPrinted.
-
setLastPrinted
public final void setLastPrinted(Date value)
Sets a value of LastPrinted.
- Parameters:
value- a value of LastPrinted.
-
getLastSaved
public final Date getLastSaved()
Gets a value of LastSaved.
- Returns:
- a value of LastSaved.
-
setLastSaved
public final void setLastSaved(Date value)
Sets a value of LastSaved.
- Parameters:
value- a value of LastSaved.
-
getManager
public final String getManager()
Gets a value of Manager.
- Returns:
- a value of Manager.
-
setManager
public final void setManager(String value)
Sets a value of Manager.
- Parameters:
value- a value of Manager.
-
getMicrosoftProjectServerURL
public final NullableBool getMicrosoftProjectServerURL()
Gets a value indicating whether MicrosoftProjectServerURL is set or not.
- Returns:
- a value indicating whether MicrosoftProjectServerURL is set or not.
-
setMicrosoftProjectServerURL
public final void setMicrosoftProjectServerURL(NullableBool value)
Sets a value indicating whether MicrosoftProjectServerURL is set or not.
- Parameters:
value- a value indicating whether MicrosoftProjectServerURL is set or not.
-
getMinutesPerDay
public final int getMinutesPerDay()
Gets a value of MinutesPerDay.
- Returns:
- a value of MinutesPerDay.
-
setMinutesPerDay
public final void setMinutesPerDay(int value)
Sets a value of MinutesPerDay.
- Parameters:
value- a value of MinutesPerDay.
-
getMinutesPerWeek
public final int getMinutesPerWeek()
Gets a value of MinutesPerWeek.
- Returns:
- a value of MinutesPerWeek.
-
setMinutesPerWeek
public final void setMinutesPerWeek(int value)
Sets a value of MinutesPerWeek.
- Parameters:
value- a value of MinutesPerWeek.
-
getMoveCompletedEndsBack
public final NullableBool getMoveCompletedEndsBack()
Gets a value indicating whether MoveCompletedEndsBack is set or not.
- Returns:
- a value indicating whether MoveCompletedEndsBack is set or not.
-
setMoveCompletedEndsBack
public final void setMoveCompletedEndsBack(NullableBool value)
Sets a value indicating whether MoveCompletedEndsBack is set or not.
- Parameters:
value- a value indicating whether MoveCompletedEndsBack is set or not.
-
getMoveCompletedEndsForward
public final NullableBool getMoveCompletedEndsForward()
Gets a value indicating whether MoveCompletedEndsForward is set or not.
- Returns:
- a value indicating whether MoveCompletedEndsForward is set or not.
-
setMoveCompletedEndsForward
public final void setMoveCompletedEndsForward(NullableBool value)
Sets a value indicating whether MoveCompletedEndsForward is set or not.
- Parameters:
value- a value indicating whether MoveCompletedEndsForward is set or not.
-
getMoveRemainingStartsBack
public final NullableBool getMoveRemainingStartsBack()
Gets a value indicating whether MoveRemainingStartsBack is set or not.
- Returns:
- a value indicating whether MoveRemainingStartsBack is set or not.
-
setMoveRemainingStartsBack
public final void setMoveRemainingStartsBack(NullableBool value)
Sets a value indicating whether MoveRemainingStartsBack is set or not.
- Parameters:
value- a value indicating whether MoveRemainingStartsBack is set or not.
-
getMoveRemainingStartsForward
public final NullableBool getMoveRemainingStartsForward()
Gets a value indicating whether MoveRemainingStartsForward is set or not.
- Returns:
- a value indicating whether MoveRemainingStartsForward is set or not.
-
setMoveRemainingStartsForward
public final void setMoveRemainingStartsForward(NullableBool value)
Sets a value indicating whether MoveRemainingStartsForward is set or not.
- Parameters:
value- a value indicating whether MoveRemainingStartsForward is set or not.
-
getMultipleCriticalPaths
public final NullableBool getMultipleCriticalPaths()
Gets a value indicating whether MultipleCriticalPaths is set or not.
- Returns:
- a value indicating whether MultipleCriticalPaths is set or not.
-
setMultipleCriticalPaths
public final void setMultipleCriticalPaths(NullableBool value)
Sets a value indicating whether MultipleCriticalPaths is set or not.
- Parameters:
value- a value indicating whether MultipleCriticalPaths is set or not.
-
getName
public final String getName()
Gets a value of Name.
- Returns:
- a value of Name.
-
setName
public final void setName(String value)
Sets a value of Name.
- Parameters:
value- a value of Name.
-
getNewTaskStartDate
public final int getNewTaskStartDate()
Gets a value of NewTaskStartDate.
- Returns:
- a value of NewTaskStartDate.
-
setNewTaskStartDate
public final void setNewTaskStartDate(int value)
Sets a value of NewTaskStartDate.
- Parameters:
value- a value of NewTaskStartDate.
-
getNewTasksAreManual
public final NullableBool getNewTasksAreManual()
Gets a value indicating whether NewTasksAreManual is set or not.
- Returns:
- a value indicating whether NewTasksAreManual is set or not.
-
setNewTasksAreManual
public final void setNewTasksAreManual(NullableBool value)
Sets a value indicating whether NewTasksAreManual is set or not.
- Parameters:
value- a value indicating whether NewTasksAreManual is set or not.
-
getNewTasksEffortDriven
public final NullableBool getNewTasksEffortDriven()
Gets a value indicating whether NewTasksEffortDriven is set or not.
- Returns:
- a value indicating whether NewTasksEffortDriven is set or not.
-
setNewTasksEffortDriven
public final void setNewTasksEffortDriven(NullableBool value)
Sets a value indicating whether NewTasksEffortDriven is set or not.
- Parameters:
value- a value indicating whether NewTasksEffortDriven is set or not.
-
getNewTasksEstimated
public final NullableBool getNewTasksEstimated()
Gets a value indicating whether NewTasksEstimated is set or not.
- Returns:
- a value indicating whether NewTasksEstimated is set or not.
-
setNewTasksEstimated
public final void setNewTasksEstimated(NullableBool value)
Sets a value indicating whether NewTasksEstimated is set or not.
- Parameters:
value- a value indicating whether NewTasksEstimated is set or not.
-
getOleObjects
public final OleObjectCollection getOleObjects()
Gets a collection containing the instances of the
OleObjectclass which are linked or embedded to this project file.
Available for mpp file format only. This collection is read-only except for 'Clear' operation.- Returns:
- a collection containing the instances of the
OleObjectclass which are linked or embedded to this project file.
-
getOutlineCodes
public final OutlineCodeDefinitionCollection getOutlineCodes()
Gets OutlineCodeDefinitionCollection object. The collection of outline code definitions associated with a project.
- Returns:
- OutlineCodeDefinitionCollection object.
-
getPageCount
public final int getPageCount(SaveOptions saveOptions)
Returns page count for the project to be rendered using given
SaveOptions.In this example instance of HtmlSaveOptions and the number of pages in resulting HTML is written to the console.
[C#] Project project = new Project(@"test.mpp"); HtmlSaveOptions saveOptions = new HtmlSaveOptions { IncludeProjectNameInPageHeader = false, IncludeProjectNameInTitle = false, PageSize = PageSize.A4, Timescale = Timescale.Days, StartDate = project.Get(Prj.StartDate).Date, EndDate = project.Get(Prj.FinishDate).Date }; Console.WriteLine(project.GetPageCount(saveOptions));- Parameters:
saveOptions- The save options to get page count for.- Returns:
- a page count to be rendered.
-
getPageCount
public final int getPageCount()
Returns page count for the project to be rendered using default
Timescale(Days).- Returns:
- Page count to be rendered.
-
getPageCount
public final int getPageCount(int format, int scale)Returns page count for the project to be rendered using given
TimescaleandPresentationFormat.- Parameters:
format-PresentationFormatto get page count for.scale-Timescaleto get page count for.- Returns:
- Page count to be rendered.
-
getPageCount_PageSize
public final int getPageCount_PageSize(int pageSize, int scale, Date startDate, Date endDate)Returns page count for the project to be rendered using given
Timescale,PresentationFormatand date range.
-
getPageCount_PageSize
public final int getPageCount_PageSize(int pageSize, int scale)
-
getPageCount_PresentationFormat
public final int getPageCount_PresentationFormat(int format)
Returns page count for the project to be rendered using default
Timescale(Days) and givenPresentationFormat- Parameters:
format-PresentationFormatto get page count for.- Returns:
- Page count to be rendered.
-
getPageCount_Timescale
public final int getPageCount_Timescale(int scale)
Returns page count for the project to be rendered using given
Timescale.- Parameters:
scale-Timescaleto get page count for.- Returns:
- Page count to be rendered.
-
getPredecessors
public final TaskLinkCollection getPredecessors(Task task)
Returns a collection of task links which are predecessors of the specified task.
- Parameters:
task- The task to get predecessors for.- Returns:
- List of predecessors
TaskLink.
-
getPrimaveraProperties
public final PrimaveraProjectProperties getPrimaveraProperties()
Gets an object containing Primavera-specific properties for a project read from Primavera file.
- Returns:
- an object containing Primavera-specific properties for a project read from Primavera file.
-
getProjectExternallyEdited
public final NullableBool getProjectExternallyEdited()
Gets a value indicating whether ProjectExternallyEdited is set or not.
- Returns:
- a value indicating whether ProjectExternallyEdited is set or not.
-
setProjectExternallyEdited
public final void setProjectExternallyEdited(NullableBool value)
Sets a value indicating whether ProjectExternallyEdited is set or not.
- Parameters:
value- a value indicating whether ProjectExternallyEdited is set or not.
-
getProjectFileInfo
public static ProjectFileInfo getProjectFileInfo(String filename)
Read project file info from the file.
- Parameters:
filename- The project filename.- Returns:
- The project file info
ProjectFileInfo.
-
getProjectFileInfo
public static ProjectFileInfo getProjectFileInfo(InputStream stream)
Gets project file info from the stream.
- Parameters:
stream- The data stream.- Returns:
- The project file info
ProjectFileInfo.
-
getRemoveFileProperties
public final NullableBool getRemoveFileProperties()
Gets a value indicating whether RemoveFileProperties is set or not.
- Returns:
- a value indicating whether RemoveFileProperties is set or not.
-
setRemoveFileProperties
public final void setRemoveFileProperties(NullableBool value)
Sets a value indicating whether RemoveFileProperties is set or not.
- Parameters:
value- a value indicating whether RemoveFileProperties is set or not.
-
getResourceAssignments
public final ResourceAssignmentCollection getResourceAssignments()
Gets ResourceAssignmentCollection object.
- Returns:
- ResourceAssignmentCollection object.
-
getResourceFilters
public final FilterCollection getResourceFilters()
Gets all the resource-based filter definitions. ResourceFilters is a collection of
Filterobjects.- Returns:
- all the resource-based filter definitions.
-
getResourceGroups
public final GroupCollection getResourceGroups()
Gets all of the resource-based group definitions. ResourceGroups is a collection of
Groupobjects.- Returns:
- all of the resource-based group definitions.
-
getResources
public final ResourceCollection getResources()
Gets ResourceCollection object.
- Returns:
- ResourceCollection object.
-
getRevision
public final int getRevision()
Gets a value of Revision.
- Returns:
- a value of Revision.
-
setRevision
public final void setRevision(int value)
Sets a value of Revision.
- Parameters:
value- a value of Revision.
-
getRootTask
public final Task getRootTask()
Gets the root of the tree of tasks.
- Returns:
- the root of the tree of tasks.
-
getSaveVersion
public final int getSaveVersion()
Gets a value of SaveVersion.
- Returns:
- a value of SaveVersion.
-
setSaveVersion
public final void setSaveVersion(int value)
Sets a value of SaveVersion.
- Parameters:
value- a value of SaveVersion.
-
getScheduleFromStart
public final NullableBool getScheduleFromStart()
Gets a value indicating whether ScheduleFromStart is set or not.
- Returns:
- a value indicating whether ScheduleFromStart is set or not.
-
setScheduleFromStart
public final void setScheduleFromStart(NullableBool value)
Sets a value indicating whether ScheduleFromStart is set or not.
- Parameters:
value- a value indicating whether ScheduleFromStart is set or not.
-
getShowProjectSummaryTask
public final boolean getShowProjectSummaryTask()
Gets a value indicating whether ShowProjectSummaryTask is set or not.
- Returns:
- a value indicating whether ShowProjectSummaryTask is set or not.
-
setShowProjectSummaryTask
public final void setShowProjectSummaryTask(boolean value)
Sets a value indicating whether ShowProjectSummaryTask is set or not.
- Parameters:
value- a value indicating whether ShowProjectSummaryTask is set or not.
-
getSplitsInProgressTasks
public final NullableBool getSplitsInProgressTasks()
Gets a value indicating whether SplitsInProgressTasks is set or not.
- Returns:
- a value indicating whether SplitsInProgressTasks is set or not.
-
setSplitsInProgressTasks
public final void setSplitsInProgressTasks(NullableBool value)
Sets a value indicating whether SplitsInProgressTasks is set or not.
- Parameters:
value- a value indicating whether SplitsInProgressTasks is set or not.
-
getSpreadActualCost
public final NullableBool getSpreadActualCost()
Gets a value indicating whether SpreadActualCost is set or not.
- Returns:
- a value indicating whether SpreadActualCost is set or not.
-
setSpreadActualCost
public final void setSpreadActualCost(NullableBool value)
Sets a value indicating whether SpreadActualCost is set or not.
- Parameters:
value- a value indicating whether SpreadActualCost is set or not.
-
getSpreadPercentComplete
public final NullableBool getSpreadPercentComplete()
Gets a value indicating whether SpreadPercentComplete is set or not.
- Returns:
- a value indicating whether SpreadPercentComplete is set or not.
-
setSpreadPercentComplete
public final void setSpreadPercentComplete(NullableBool value)
Sets a value indicating whether SpreadPercentComplete is set or not.
- Parameters:
value- a value indicating whether SpreadPercentComplete is set or not.
-
getStartDate
public final Date getStartDate()
Gets a value of StartDate.
- Returns:
- a value of StartDate.
-
setStartDate
public final void setStartDate(Date value)
Sets a value of StartDate.
- Parameters:
value- a value of StartDate.
-
getStatusDate
public final Date getStatusDate()
Gets a value of StatusDate.
- Returns:
- a value of StatusDate.
-
setStatusDate
public final void setStatusDate(Date value)
Sets a value of StatusDate.
- Parameters:
value- a value of StatusDate.
-
getSubject
public final String getSubject()
Gets a value of Subject.
- Returns:
- a value of Subject.
-
setSubject
public final void setSubject(String value)
Sets a value of Subject.
- Parameters:
value- a value of Subject.
-
getTables
public final TableCollection getTables()
Gets a list of
Tableobjects.- Returns:
- a list of
Tableobjects.
-
getTaskFilters
public final FilterCollection getTaskFilters()
Gets all the task-based filter definitions. TaskFilters is a collection of
Filterobjects.- Returns:
- all the task-based filter definitions.
-
getTaskGroups
public final GroupCollection getTaskGroups()
Gets all the task-based group definitions. TaskGroups is a collection of
Groupobjects.- Returns:
- all the task-based group definitions.
-
getTaskLinks
public final TaskLinkCollection getTaskLinks()
Gets
TaskLinkCollectionobject.- Returns:
TaskLinkCollectionobject.
-
getTaskUpdatesResource
public final NullableBool getTaskUpdatesResource()
Gets a value indicating whether TaskUpdatesResource is set or not.
- Returns:
- a value indicating whether TaskUpdatesResource is set or not.
-
setTaskUpdatesResource
public final void setTaskUpdatesResource(NullableBool value)
Sets a value indicating whether TaskUpdatesResource is set or not.
- Parameters:
value- a value indicating whether TaskUpdatesResource is set or not.
-
getTemplate
public final String getTemplate()
Gets a value of Template.
- Returns:
- a value of Template.
-
setTemplate
public final void setTemplate(String value)
Sets a value of Template.
- Parameters:
value- a value of Template.
-
getTimescaleFinish
public final Date getTimescaleFinish()
Gets a value of TimescaleFinish.
- Returns:
- a value of TimescaleFinish.
-
setTimescaleFinish
public final void setTimescaleFinish(Date value)
Sets a value of TimescaleFinish.
- Parameters:
value- a value of TimescaleFinish.
-
getTimescaleStart
public final Date getTimescaleStart()
Gets a value of TimescaleStart.
- Returns:
- a value of TimescaleStart.
-
setTimescaleStart
public final void setTimescaleStart(Date value)
Sets a value of TimescaleStart.
- Parameters:
value- a value of TimescaleStart.
-
getTitle
public final String getTitle()
Gets a value of Title.
- Returns:
- a value of Title.
-
setTitle
public final void setTitle(String value)
Sets a value of Title.
- Parameters:
value- a value of Title.
-
getUid
public final String getUid()
Gets a value of Uid.
- Returns:
- a value of Uid.
-
setUid
public final void setUid(String value)
Sets a value of Uid.
- Parameters:
value- a value of Uid.
-
getUpdateManuallyScheduledTasksWhenEditingLinks
public final NullableBool getUpdateManuallyScheduledTasksWhenEditingLinks()
Gets a value indicating whether UpdateManuallyScheduledTasksWhenEditingLinks is set or not.
- Returns:
- a value indicating whether UpdateManuallyScheduledTasksWhenEditingLinks is set or not.
-
setUpdateManuallyScheduledTasksWhenEditingLinks
public final void setUpdateManuallyScheduledTasksWhenEditingLinks(NullableBool value)
Sets a value indicating whether UpdateManuallyScheduledTasksWhenEditingLinks is set or not.
- Parameters:
value- a value indicating whether UpdateManuallyScheduledTasksWhenEditingLinks is set or not.
-
getVbaProject
public final VbaProject getVbaProject()
Gets an instance of
VbaProject(getVbaProject()/setVbaProject(VbaProject)) class.- Returns:
- an instance of
VbaProject(getVbaProject()/setVbaProject(VbaProject)) class.
-
getViews
public final ViewCollection getViews()
Gets a list of
Viewobjects.- Returns:
- a list of
Viewobjects.
-
getWBSCodeDefinition
public final WBSCodeDefinition getWBSCodeDefinition()
Gets WBS Code Definition for the project.
- Returns:
- WBS Code Definition for the project.
-
setWBSCodeDefinition
public final void setWBSCodeDefinition(WBSCodeDefinition value)
Sets WBS Code Definition for the project.
- Parameters:
value- WBS Code Definition for the project.
-
getWeekStartDay
public final int getWeekStartDay()
Gets a value of WeekStartDay.
- Returns:
- a value of WeekStartDay.
-
setWeekStartDay
public final void setWeekStartDay(int value)
Sets a value of WeekStartDay.
- Parameters:
value- a value of WeekStartDay.
-
getWork
public final Duration getWork(double val)
Gets
Durationobject with the specifieddoublevalue and default work format.- Parameters:
val- specified double value.
This method should be used carefully because it returns different durations depending on Project.WorkFormat setting. For example, GetWork(1.0) will return 1 hour when Project.WorkFormat is TimeUnitType.Hour or 1 day if Project.WorkFormat is TimeUnitType.Day.- Returns:
- Duration object.
-
getWorkFormat
public final byte getWorkFormat()
Gets a value of WorkFormat.
- Returns:
- a value of WorkFormat.
-
setWorkFormat
public final void setWorkFormat(byte value)
Sets a value of WorkFormat.
- Parameters:
value- a value of WorkFormat.
-
print
public final void print()
Prints project to the default printer with default printer settings using the standard (no User Interface) print controller.
-
print
public final void print(PrintOptions options)
Prints project to the default printer with default printer settings and custom save options using the standard (no User Interface) print controller.
- Parameters:
options- the specified instance of thePrintOptionsclass.
-
print
public final void print(String printerName)
Prints project to the specified printer with default printer settings using the standard (no User Interface) print controller.
- Parameters:
printerName- Specified printer name.
-
print
public final void print(PrinterSettings printerSettings)
Prints project according to the specified printer settings using the standard (no User Interface) print controller.
- Parameters:
printerSettings- the specified instance of thePrinterSettingsclass.
-
print
public final void print(PrinterSettings printerSettings, String documentName)
Prints project according to the specified printer settings using the standard (no User Interface) print controller.
- Parameters:
printerSettings- the specified instance of thePrinterSettingsclass.documentName- the document name to display (for example, in a print status dialog box or printer queue).
-
print
public final void print(PrinterSettings printerSettings, PrintOptions options)
Prints project according to the specified printer settings and custom save options using the standard (no User Interface) print controller.
- Parameters:
printerSettings- the specified instance of thePrinterSettingsclass.options- the specified instance of thePrintOptionsclass.
-
print
public final void print(PrinterSettings printerSettings, PrintOptions options, String documentName)
Prints project according to the specified printer settings, custom save options and the specified document name using the standard (no User Interface) print controller.
- Parameters:
printerSettings- the specified instance of thePrinterSettingsclass.options- the specified instance of thePrintOptionsclass.documentName- the document name to display (for example, in a print status dialog box or printer queue).
-
recalculate
public final void recalculate()
Reschedules all project tasks ids, outline levels, start/finish dates, sets early/late dates, calculates slacks, work and cost fields.
-
recalculate
public final 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.
- Parameters:
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 thenRecalculationValidationExceptionwill be thrown.
-
recalculateResourceFields
public final void recalculateResourceFields()
Recalculates Id, Start and Finish of resources.
-
recalculateResourceStartFinish
public final void recalculateResourceStartFinish()
Recalculates Start and Finish of resources.
-
removeInvalidResourceAssignments
public final 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.
-
renumberWBSCode
public final void renumberWBSCode()
Renumber WBS code of all tasks.
-
renumberWBSCode
public final void renumberWBSCode(List<Integer> taskIds)
Renumber WBS code of passed tasks.
- Parameters:
taskIds- Task identifiers to renumber WBS codes.
-
rescheduleUncompletedWorkToStartAfter
public final void rescheduleUncompletedWorkToStartAfter(Date after)
Reschedules uncompleted project work to start after a specified date.
- Parameters:
after- The date to reschedule uncompleted work after.
-
rescheduleUncompletedWorkToStartAfter
public final void rescheduleUncompletedWorkToStartAfter(Date after, List<Task> taskCollection)
Reschedules uncompleted work for a specified list of tasks to start after a specified date.
- Parameters:
after- The date to reschedule uncompleted work after.taskCollection- List<Task> of tasks to reschedule uncompleted work for.
-
save
public final void save(String filename, SimpleSaveOptions options)
Saves the document to a file using the specified save options.
- Parameters:
filename- The file name.options- The save options.
-
save
public final void save(String filename, int format)
Saves the project data to the file.
- Parameters:
filename- The file name.format- The save file format.
-
save
public final void save(String filename)
Saves the project data to the file in mpp format.
- Parameters:
filename- The file name.
-
save
public final void save(OutputStream stream, SimpleSaveOptions options)
Saves the project to a stream using the specified save options.
- Parameters:
stream- The stream.options- The save options.
-
save
public void save(OutputStream stream, int format)
Saves the project data to the stream.
- Parameters:
stream- The stream.format- the specified save file format.SaveFileFormat
-
saveAsTemplate
public void saveAsTemplate(String fileName, SaveTemplateOptions options)
Saves the project as a template.
- Parameters:
fileName- The file name.options- the specified save optionsSaveTemplateOptions.
-
saveAsTemplate
public final void saveAsTemplate(String fileName)
Saves the project as a template to the specified file path.
- Parameters:
fileName- the specified file name.
-
saveAsTemplate
public final void saveAsTemplate(OutputStream stream)
Saves the project as a template to a specified stream.
- Parameters:
stream- the specified stream to save the project to.
-
saveAsTemplate
public final void saveAsTemplate(OutputStream stream, SaveTemplateOptions options)
Saves the project as a template to a specified stream.
- Parameters:
stream- Stream to save the project template to.options- the specified save optionsSaveTemplateOptions.
-
saveReport
public final void saveReport(OutputStream stream)
Saves the project overview report to the stream.
- Parameters:
stream- The stream to save project report to.
-
saveReport
public final void saveReport(String fileName)
Saves the project overview report to PDF file.
- Parameters:
fileName- The file name.
-
saveReport
public void saveReport(OutputStream stream, int reportType)
Saves the project report of the specified type to the specified stream.
- Parameters:
stream- the specified stream to save project report to.reportType- the specified report type.ReportType
-
saveReport
public final void saveReport(String fileName, int reportType)
Saves the project report of the specified type in PDF format to the specified file path.
- Parameters:
fileName- the specified file name.reportType- the specified report type.ReportType
-
selectAllChildTasks
public final List<Task> selectAllChildTasks()
Recursively collects all child tasks of the root task.
- Returns:
- The collection of tasks.
-
set
public final <T> void set(Key<T,Byte> key, T val)
Maps the specified property to the specified value in this container.
- Parameters:
key- the specified property key.Prjfor getting the property key.val- the value.
-
set
public final void set(Key<Date,Byte> key, Date val)
Maps the specified property to the specified value in this container.
- Parameters:
key- the specified property key.Prjfor getting the property key.val- the value.
-
setBaseline
public final void setBaseline(int baselineType)
Saves baseline fields to the specified baseline for the entire project.
- Parameters:
baselineType- The baseline type to save baseline data to.
-
setBaseline
public final void setBaseline(int baselineType, Iterable<Task> taskCollection)Saves baseline fields to the specified baseline for the selected tasks.
- Parameters:
baselineType- The baseline type to save baseline data to.taskCollection- List of tasks to save baseline data for.
-
setBaselineSaveTime
public final void setBaselineSaveTime(int baselineNumber, Date value)Sets the baseline save time.
- Parameters:
baselineNumber- The baseline's numberBaselineType.value- The baseline's last save date and time.
Set value to DateTime.MinValue if the baseline was not saved.
-
updateProjectWorkAsComplete
public final void updateProjectWorkAsComplete(Date completeThrough, boolean setZeroOrHundredPercentCompleteOnly)
Updates all work as complete through a specified date for the entire project.
- Parameters:
completeThrough- The date 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.
-
updateProjectWorkAsComplete
public final void updateProjectWorkAsComplete(Date completeThrough, boolean setZeroOrHundredPercentCompleteOnly, List<Task> taskCollection)
Updates all work as complete through a specified date for the specified list of tasks.
- Parameters:
completeThrough- The date 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.taskCollection- List<Task> of tasks to update work for.
-
-