Package com.primavera.integration.client.bo.object

Class ProjectPortfolio

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.base.ProjectPortfolioBase
com.primavera.integration.client.bo.object.ProjectPortfolio
public class ProjectPortfolio extends com.primavera.integration.client.bo.base.ProjectPortfolioBase

A project portfolio consists of projects grouped together in some way that is meaningful to you. For example, one portfolio might contain projects that are the responsibility of a specific business unit, while another portfolio contains only projects budgeted for the next fiscal year.

There are two types of project portfolios: "Manual" and "Filtered". Manual portfolios contain zero or more projects that were specifically added. Filtered portfolios contain zero or more projects based on a filter that was specified in Primavera's Web application. The list of projects in a filtered portfolio is based on the results of the filter when it was first created. Only manual portfolios can be created through the Integration API, and their list of projects cannot be altered.

To add a project to a manual portfolio, use one of the addProject() or addProjects() methods. Use one of the removeProject() or removeProjects() methods to remove a project from a manual portfolio. These methods will not cause the project(s) to be deleted.

To determine if a project is in this portfolio, use one of the containsProject() methods. The getProjectIds() method will return an array of the ObjectIds of all projects in the portfolio.

To load all or some of the projects contained in this portfolio, use the loadProjects() method.

See Also:   Quick reference of ProjectPortfolio fields

  • Constructor Details

    • ProjectPortfolio

      public ProjectPortfolio(Session session)
      Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.
      Parameters:
      session - the Session

    • ProjectPortfolio

      public ProjectPortfolio(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • ProjectPortfolio

      public ProjectPortfolio(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
      Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.
      Parameters:
      session - the Session
      rowSet - the PrmRowSet retrieved from the server
      iIndex - the row index in the PrmRowSet associated with this business object
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

  • Method Details

    • loadUser

      public User loadUser(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated User object from the database.
      Parameters:
      fields - fields to load
      Returns:
      User the User object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • addProject

      public void addProject(Project project) throws BusinessObjectException
      Adds a project into the project portfolio.
      Parameters:
      project - Project object
      Throws:
      BusinessObjectException

    • addProjects

      public void addProjects(Project[] projects) throws BusinessObjectException
      Adds projects into the project portfolio.
      Parameters:
      projects - Array of Project objects
      Throws:
      BusinessObjectException

    • addProject

      public void addProject(ObjectId objId) throws BusinessObjectException
      Adds a project into the project portfolio.
      Parameters:
      objId - unique ID of a Project object
      Throws:
      BusinessObjectException

    • addProjects

      public void addProjects(ObjectId[] objIds) throws BusinessObjectException
      Adds projects into the project portfolio.
      Parameters:
      objIds - Array of Project unique IDs
      Throws:
      BusinessObjectException

    • removeProject

      public void removeProject(Project project) throws BusinessObjectException
      Removes a project from the project portfolio.
      Parameters:
      project - Project object
      Throws:
      BusinessObjectException

    • removeProjects

      public void removeProjects(Project[] projects) throws BusinessObjectException
      Removes projects from the project portfolio.
      Parameters:
      projects - Array of Project object
      Throws:
      BusinessObjectException

    • removeProject

      public void removeProject(ObjectId objId) throws BusinessObjectException
      Removes a project from the project portfolio.
      Parameters:
      objId - unique ID of a Project object
      Throws:
      BusinessObjectException

    • removeProjects

      public void removeProjects(ObjectId[] objIds) throws BusinessObjectException
      Removes projects from the project portfolio.
      Parameters:
      objIds - Array of Project unique IDs
      Throws:
      BusinessObjectException

    • containsProject

      public boolean containsProject(Project project) throws BusinessObjectException
      Find out whether the project portfolio contains the specified Project.
      Parameters:
      project - Project object
      Returns:
      boolean whether the ProjectPortfolio contains the specified Project
      Throws:
      BusinessObjectException

    • containsProject

      public boolean containsProject(ObjectId objId) throws BusinessObjectException
      Find out whether the project portfolio contains the specified Project.
      Parameters:
      objId - unique ID of a Project object
      Returns:
      boolean whether the ProjectPortfolio contains the specified Project
      Throws:
      BusinessObjectException

    • getProjectObjectIds

      public ObjectId[] getProjectObjectIds() throws BusinessObjectException
      Gets an array of project unique IDs contained in the project portfolio.
      Returns:
      ObjectId[] array of Project unique IDs contained in the project portfolio
      Throws:
      BusinessObjectException

    • loadProjects

      public BOIterator<Project> loadProjects(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Load the project objects contained in the project portfolio.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator iterator of Project objects
      Throws:
      ServerException
      NetworkException
      BusinessObjectException

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      the value in the field ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setObjectId

      public void setObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      setObjectId in class BusinessObject
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUserObjectId

      public ObjectId getUserObjectId() throws BusinessObjectException
      Gets the unique ID of a specific user who has access to the selected project portfolio. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field UserObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUserObjectId

      public void setUserObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of a specific user who has access to the selected project portfolio. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getName

      public String getName() throws BusinessObjectException
      Gets the name of the project portfolio. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field Name
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setName

      public void setName(String s) throws BusinessObjectException
      Sets the name of the project portfolio. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getType

      public PortfolioType getType() throws BusinessObjectException
      Gets the type of the project portfolio: "Manual", "Auto-Maintained", or "Filtered". This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field Type
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIncludeClosedProjects

      public boolean getIncludeClosedProjects() throws BusinessObjectException
      Gets the flag that indicates whether closed projects are included in the portfolio.
      Returns:
      the value in the field IncludeClosedProjects
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIncludeClosedProjects

      public void setIncludeClosedProjects(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether closed projects are included in the portfolio.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIncludeWhatIfProjects

      public boolean getIncludeWhatIfProjects() throws BusinessObjectException
      Gets the flag that indicates whether what-if projects are included in the portfolio.
      Returns:
      the value in the field IncludeWhatIfProjects
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIncludeWhatIfProjects

      public void setIncludeWhatIfProjects(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether what-if projects are included in the portfolio.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDescription

      public String getDescription() throws BusinessObjectException
      Gets the description of the project portfolio.
      Returns:
      the value in the field Description
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDescription

      public void setDescription(String s) throws BusinessObjectException
      Sets the description of the project portfolio.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUserName

      public String getUserName() throws BusinessObjectException
      Gets the user's login name.
      Returns:
      the value in the field UserName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPortfolioUserIdArray

      public String[] getPortfolioUserIdArray() throws BusinessObjectException
      Gets the Shared users detail. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PortfolioUserIdArray
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPortfolioUserIdArray

      public void setPortfolioUserIdArray(String[] s) throws BusinessObjectException
      Sets the Shared users detail. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPortfolioUserNameArray

      public String[] getPortfolioUserNameArray() throws BusinessObjectException
      Gets the Shared users detail. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PortfolioUserNameArray
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPortfolioUserNameArray

      public void setPortfolioUserNameArray(String[] s) throws BusinessObjectException
      Sets the Shared users detail. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this project portfolio was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this project portfolio was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateUser

      public String getCreateUser() throws BusinessObjectException
      Gets the name of the user that created this project portfolio.
      Returns:
      the value in the field CreateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateUser

      public String getLastUpdateUser() throws BusinessObjectException
      Gets the name of the user that last updated this project portfolio.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static String[] getRequiredCreateFields()
      Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.
      Returns:
      String[] an array of required create fields

    • getFilterableFields

      public static String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields

    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getWritableFields

      public static String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields

    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names

    • getMinimumXMLExportFields

      public static String[] getMinimumXMLExportFields()
      Gets all fields that are always exported at a minimum by the new flat XML exporter
      Returns:
      String[] an array of exported fields

    • toString

      public String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this ProjectPortfolio object in the database.
      Returns:
      ObjectId the unique ID of the newly created ProjectPortfolio object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • create

      public static ObjectId[] create(Session session, ProjectPortfolio[] projectportfolios) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple ProjectPortfolio objects in the database.
      Parameters:
      session - the Session object
      projectportfolios - array of ProjectPortfolio objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created ProjectPortfolio objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static ProjectPortfolio load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single ProjectPortfolio object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the ProjectPortfolio object
      Returns:
      ProjectPortfolio the ProjectPortfolio object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static BOIterator<ProjectPortfolio> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ProjectPortfolio objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the ProjectPortfolio objects
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public void update() throws ServerException, NetworkException, BusinessObjectException
      Updates this ProjectPortfolio object in the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public static void update(Session session, ProjectPortfolio[] projectportfolios) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple ProjectPortfolio objects in the database.
      Parameters:
      session - the Session object
      projectportfolios - array of ProjectPortfolio objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public void delete() throws ServerException, NetworkException, BusinessObjectException
      Deletes this ProjectPortfolio object from the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public static void delete(Session session, ProjectPortfolio[] projectportfolios) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple ProjectPortfolio objects from the database.
      Parameters:
      session - the Session object
      projectportfolios - array of ProjectPortfolio objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects