Package com.aspose.tasks

Class Project

  • public class Project
extends Object

    Represents a project.

    <p>The <b>Project</b> is a central class in the Aspose.Tasks library.</p> One can use <b>Project</b> to read one of supported project management formats: MPP, MPT, MPX, XML. <p>To load an existing document in any of the supported formats, pass a file name or a stream into one of the <b>Project</b> constructors. To create a blank project, call the parameterless constructor.</p> <p>Use one of the Save method overloads to save the project in any of the {@link SaveFileFormat} formats: Primavera: P6 XML, PM XER; Microsoft Excel: XLSX, XML; Fixed Layout: PDF; Images: JPEG, PNG, BMP, TIFF, SVG; Text: TXT; Others: HTML.</p> <p>To print the project, use one of the {@link Project#print} method overloads.</p> <p>The <b>Project</b> stores project-wide information such as {@code Aspose.Tasks.Project.Views}({@link Project#getViews}/{@link Project#setViews(ViewCollection)}), {@code Aspose.Tasks.Project.BuiltInProps}({@link Project#getBuiltInProps}/{@link Project#setBuiltInProps(BuiltInProjectPropertyCollection)}), {@code Aspose.Tasks.Project.CustomProps}({@link Project#getCustomProps}/{@link Project#setCustomProps(CustomProjectPropertyCollection)}), and {@code Aspose.Tasks.Project.ExtendedAttributes}({@link Project#getExtendedAttributes}/{@link Project#setExtendedAttributes(ExtendedAttributeDefinitionCollection)}). Most of these objects are accessible via the corresponding properties of the <b>Project</b> class.</p> <p>The <b>Project</b> is a root entity that contains entry points to manipulate other project entities, such as {@link Task}, {@link Resource}, {@link ResourceAssignment}, {@link ExtendedAttribute} and {@link Calendar}.</p> The <b>Project</b> entities can be accessed via typed collections, for example 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 Detail

      • Project

        public Project()

        Initializes a new instance of the Project class.

      • Project

        public Project​(String projectTemplate,
               String protectionPassword)

        Initializes a new instance of the Project class 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 Project class from a template (existent mpp or mpt file).

        Parameters:
        projectTemplate - Path to template to create project from.

      • Project

        public Project​(String projectTemplate,
               ParseErrorCallback parseErrorHandler)

        Initializes a new instance of the Project class 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 Project class from a stream.

        Parameters:
        stream - InputStream to load a template from.

      • Project

        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.

        Parameters:
        settings - the specified instance of the DbSettings class.

      • Project

        public Project​(InputStream stream,
               ParseErrorCallback parseErrorHandler)

        Initializes a new instance of the Project class from a template(existent mpp or mpt file).

        Parameters:
        stream - InputStream to 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 Project class from a template(existent mpp or mpt file).

        Parameters:
        stream - InputStream to 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 Project class from a template (existent mpp or mpt file) with the specified instance of the LoadOptions class.

        Parameters:
        projectTemplate - Path to template to create project from
        options - the specified instance of the LoadOptions class.

    • 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.

      • get

        public final <T> T get​(Key<T,​Integer> key)

        Returns the value to which the property is mapped in this container.

        Parameters:
        key - the specified property key. Prj for getting the property key.

        T: the type of the mapped value.

        Returns:
        the value to which the property is mapped in this container.

      • 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 number BaselineType.
        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.

      • 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.

      • getCustomProps

        public final CustomProjectPropertyCollection getCustomProps()

        Gets project's custom properties collection.

        Returns:
        project's custom properties collection.

      • 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 WeekDayCollection class which represents a collection of project default week working days and working times.

        Returns:
        The instance of WeekDayCollection class which contains a list of WeekDay objects.

        The data contains only in mpp files (not in xml).

      • getDuration

        public final Duration getDuration​(double val)

        Gets Duration object with the specified number of units and default duration format which is defined in project's settings Prj.DURATION_FORMAT.

        Parameters:
        val - specified number of units.
        Returns:
        Duration object.

      • getDuration

        public final Duration getDuration​(double val,
                                  int timeUnit)

        Gets Duration object with the specified number of TimeUnitType units.

        Parameters:
        val - specified number of units.
        timeUnit - specified TimeUnitType value.
        Returns:
        Duration object.

      • getExtendedAttributes

        public final ExtendedAttributeDefinitionCollection getExtendedAttributes()

        Gets ExtendedAttributeDefinitionCollection object. The collection of extended attribute (custom fields) definitions associated with a project.

        Returns:
        ExtendedAttributeDefinitionCollection object.

      • getOleObjects

        public final OleObjectCollection getOleObjects()

        Gets a collection containing the instances of the OleObject class 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 OleObject class 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_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, PresentationFormat and date range.

        Parameters:
        pageSize - PageSize to get page count for.
        scale - Timescale to get page count for.
        startDate - The start date to get page count for.
        endDate - The end date to get page count for.
        Returns:
        Page count to be rendered.

      • getPageCount_PageSize

        public final int getPageCount_PageSize​(int pageSize,
                                       int scale)

        Returns page count for the project to be rendered using given Timescale and PageSize.

        Parameters:
        pageSize - PageSize to get page count for.
        scale - Timescale to get page count for.
        Returns:
        Page count to be rendered.

      • getPageCount_PresentationFormat

        public final int getPageCount_PresentationFormat​(int format)

        Returns page count for the project to be rendered using default Timescale(Days) and given PresentationFormat

        Parameters:
        format - PresentationFormat to 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 - Timescale to get page count for.
        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 Timescale and PresentationFormat.

        Parameters:
        format - PresentationFormat to get page count for.
        scale - Timescale to 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.

      • 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.

      • 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 Filter objects.

        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 Group objects.

        Returns:
        all of the resource-based group definitions.

      • getResources

        public final ResourceCollection getResources()

        Gets ResourceCollection object.

        Returns:
        ResourceCollection object.

      • getRootTask

        public final Task getRootTask()

        Gets the root of the tree of tasks.

        Returns:
        the root of the tree of tasks.

      • getTaskFilters

        public final FilterCollection getTaskFilters()

        Gets all the task-based filter definitions. TaskFilters is a collection of Filter objects.

        Returns:
        all the task-based filter definitions.

      • getTaskGroups

        public final GroupCollection getTaskGroups()

        Gets all the task-based group definitions. TaskGroups is a collection of Group objects.

        Returns:
        all the task-based group definitions.

      • getViews

        public final ViewCollection getViews()

        Gets a list of View objects.

        Returns:
        a list of View objects.

      • 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.

      • getWork

        public final Duration getWork​(double val)

        Gets Duration object with the specified double value and default work format.

        Parameters:
        val - specified double value.
        Returns:
        Duration object.

      • 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 the PrintOptions class.

      • 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 the PrinterSettings class.

      • 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 the PrinterSettings class.
        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 the PrinterSettings class.
        options - the specified instance of the PrintOptions class.

      • 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 the PrinterSettings class.
        options - the specified instance of the PrintOptions class.
        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 then RecalculationValidationException will 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.

        Ensure that Project.CanSplitsInProgressTasks flag is set to true before using this method.

      • 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.

        Ensure that Project.CanSplitsInProgressTasks flag is set to true before using this method.

      • save

        public final void save​(String filename,
                       MPPSaveOptions options)
                throws IOException

        Saves the document to mpp file format using the specified save options.

        Parameters:
        filename - The file name.
        options - The save options.
        Throws:
        IOException

      • save

        public final void save​(String filename,
                       SaveOptions options)
                throws IOException

        Saves the document to a file using the specified save options.

        Parameters:
        filename - The file name.
        options - The save options.
        Throws:
        IOException

      • save

        public final void save​(String filename,
                       int format)
                throws IOException

        Saves the project data to the file.

        Parameters:
        filename - The file name.
        format - The save file format.
        Throws:
        IOException

      • save

        public final void save​(String filename)
                throws IOException

        Saves the project data to the file in mpp format.

        Parameters:
        filename - The file name.
        Throws:
        IOException

      • save

        public final void save​(OutputStream stream,
                       SaveOptions options)
                throws IOException

        Saves the project to a stream using the specified save options.

        Parameters:
        stream - The stream.
        options - The save options.
        Throws:
        IOException

      • saveAsTemplate

        public final void saveAsTemplate​(String fileName)
                          throws IOException

        Saves the project as a template to the specified file path.

        Parameters:
        fileName - the specified file name.
        Throws:
        IOException

      • saveAsTemplate

        public final void saveAsTemplate​(OutputStream stream)
                          throws IOException

        Saves the project as a template to a specified stream.

        Parameters:
        stream - the specified stream to save the project to.
        Throws:
        IOException

      • saveReport

        public final void saveReport​(OutputStream stream)
                      throws IOException

        Saves the project overview report to the stream.

        Parameters:
        stream - The stream to save project report to.
        Throws:
        IOException

      • saveReport

        public final void saveReport​(String fileName)
                      throws IOException

        Saves the project overview report to PDF file.

        Parameters:
        fileName - The file name.
        Throws:
        IOException

      • saveReport

        public void saveReport​(OutputStream stream,
                       int reportType)
                throws IOException

        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
        Throws:
        IOException

      • saveReport

        public final void saveReport​(String fileName,
                             int reportType)
                      throws IOException

        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
        Throws:
        IOException

      • 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,​Integer> key,
                          T val)

        Maps the specified property to the specified value in this container.

        Parameters:
        key - the specified property key. Prj for getting the property key.
        val - the value.

        T: the type of the mapped value.

      • set

        public final void set​(Key<Date,​Integer> key,
                      Date val)

        Maps the specified property to the specified value in this container.

        Parameters:
        key - the specified property key. Prj for 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 number BaselineType.
        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.