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

Class RiskResponsePlan

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.RiskResponsePlan
public class RiskResponsePlan extends BusinessObject
The risk response plan object communicates how the project team plans to address the identified risk. A risk that is categorized as a threat has four types of response plans: accept, avoid, reduce, and transfer. A risk that is an opportunity has four different types of response plans: enhance, exploit, facilitate, and reject. The response plan can be comprised of multiple detailed actions or steps.

See Also:   Quick reference of RiskResponsePlan fields

  • Constructor Details

    • RiskResponsePlan

      public RiskResponsePlan(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

    • RiskResponsePlan

      public RiskResponsePlan(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

    • RiskResponsePlan

      public RiskResponsePlan(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

    • loadRisk

      public Risk loadRisk(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Risk object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Risk the Risk 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

    • loadProject

      public Project loadProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Project object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Project the Project 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

    • loadRiskResponseActions

      public BOIterator<RiskResponseAction> loadRiskResponseActions(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated RiskResponseAction objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      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

    • 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

    • getRiskObjectId

      public ObjectId getRiskObjectId() throws BusinessObjectException
      Gets the unique ID of the associated risk. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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 RiskObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRiskObjectId

      public void setRiskObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated risk. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRiskId

      public String getRiskId() throws BusinessObjectException
      Gets the ID of the risk.
      Returns:
      the value in the field RiskId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRiskName

      public String getRiskName() throws BusinessObjectException
      Gets the name of the risk.
      Returns:
      the value in the field RiskName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingCost

      public Cost getRemainingCost() throws BusinessObjectException
      Gets the remaining cost associated with the risk response action. 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 RemainingCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedCost

      public Cost getPlannedCost() throws BusinessObjectException
      Gets the planned cost. 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 PlannedCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualCost

      public Cost getActualCost() throws BusinessObjectException
      Gets the actual cost. 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 ActualCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStartDate

      public BeginDate getStartDate() throws BusinessObjectException
      Gets the start date of the risk response action. If an activity is assigned, the risk response action uses the activity start date. 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 StartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFinishDate

      public EndDate getFinishDate() throws BusinessObjectException
      Gets the finish date of the risk response action. If an activity is assigned, the risk response action uses the activity finish date. 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 FinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedStartDate

      public BeginDate getPlannedStartDate() throws BusinessObjectException
      Gets the planned start date. 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 PlannedStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedFinishDate

      public EndDate getPlannedFinishDate() throws BusinessObjectException
      Gets the planned finish date. 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 PlannedFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getScore

      public int getScore() throws BusinessObjectException
      Gets the risk score from the numeric PID after all response actions of the response plan have been completed. The post response plan score is set from the response action with the latest finish date and the lowest score when more than one response action has the same date. 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 Score
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getScoreText

      public String getScoreText() throws BusinessObjectException
      Gets the risk score from the alphanumeric PID after all response actions of the response plan have been completed. The post response plan score is set from the response action with the latest finish date and the lowest score when more than one response action has the same date. 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 ScoreText
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getScoreColor

      public int getScoreColor() throws BusinessObjectException
      Gets the color of the tolerance threshold for the score value. 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 ScoreColor
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectObjectId

      public ObjectId getProjectObjectId() throws BusinessObjectException
      Gets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field ProjectObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectId

      public String getProjectId() throws BusinessObjectException
      Gets the short name of the associated project.
      Returns:
      the value in the field ProjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectName

      public String getProjectName() throws BusinessObjectException
      Gets the name of the associated project.
      Returns:
      the value in the field ProjectName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getId

      public String getId() throws BusinessObjectException
      Gets the ID of the risk response plan. This must be unique within the assigned risk. 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 Id
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setId

      public void setId(String s) throws BusinessObjectException
      Sets the ID of the risk response plan. This must be unique within the assigned risk. 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

    • getName

      public String getName() throws BusinessObjectException
      Gets the name of the risk response plan.
      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 risk response plan.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsActive

      public boolean getIsActive() throws BusinessObjectException
      Gets the indication of whether the response plan is currently active for the associated risk. Only one response plan can be active at a given time for a risk.
      Returns:
      the value in the field IsActive
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIsActive

      public void setIsActive(boolean b) throws BusinessObjectException
      Sets the indication of whether the response plan is currently active for the associated risk. Only one response plan can be active at a given time for a risk.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResponseType

      public RiskResponseType getResponseType() throws BusinessObjectException
      Gets the risk response plan type. If the risk is a threat, the valid types are 'Avoid', 'Transfer', 'Reduce', and 'Accept'. If the risk is a opportunity, the valid types are 'Exploit', 'Facilitate', 'Enhance', and 'Reject'.
      Returns:
      the value in the field ResponseType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResponseType

      public void setResponseType(RiskResponseType enm) throws BusinessObjectException
      Sets the risk response plan type. If the risk is a threat, the valid types are 'Avoid', 'Transfer', 'Reduce', and 'Accept'. If the risk is a opportunity, the valid types are 'Exploit', 'Facilitate', 'Enhance', and 'Reject'.
      Parameters:
      enm - 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 risk response plan 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 risk response plan 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 the risk response plan.
      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 the risk response plan.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsBaseline

      public boolean getIsBaseline() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a Project or Baseline.
      Returns:
      the value in the field IsBaseline
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsTemplate

      public boolean getIsTemplate() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a template Project.
      Returns:
      the value in the field IsTemplate
      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 RiskResponsePlan object in the database.
      Returns:
      ObjectId the unique ID of the newly created RiskResponsePlan 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, RiskResponsePlan[] riskresponseplans) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple RiskResponsePlan objects in the database.
      Parameters:
      session - the Session object
      riskresponseplans - array of RiskResponsePlan objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created RiskResponsePlan 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 RiskResponsePlan load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single RiskResponsePlan object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the RiskResponsePlan object
      Returns:
      RiskResponsePlan the RiskResponsePlan 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<RiskResponsePlan> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple RiskResponsePlan objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the RiskResponsePlan 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 RiskResponsePlan 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, RiskResponsePlan[] riskresponseplans) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple RiskResponsePlan objects in the database.
      Parameters:
      session - the Session object
      riskresponseplans - array of RiskResponsePlan 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 RiskResponsePlan 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, RiskResponsePlan[] riskresponseplans) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple RiskResponsePlan objects from the database.
      Parameters:
      session - the Session object
      riskresponseplans - array of RiskResponsePlan 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