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

Class RiskImpact

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.RiskImpact
public class RiskImpact extends BusinessObject

The risk impact object stores the pre-response qualitative value assigned to a risk for each of the risk thresholds.

Note that this business object has a multi-part object ID; its object ID is a combination of its risk object ID and its risk threshold object ID. The risk threshold object ID is set based on the value used in risk threshold level object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.

See Also:   Quick reference of RiskImpact fields

  • Constructor Details

    • RiskImpact

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

    • RiskImpact

      public RiskImpact(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() is intended to be called on this object. For this particular object, the ObjectId is multi-part, created from the RiskObjectId and RiskThresholdObjectId field values. If you do not have the multi-part ObjectId already, it would be simpler to instead use the constructor that has multiple key parameters.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • RiskImpact

      public RiskImpact(Session session, ObjectId riskObjectId, ObjectId riskThresholdObjectId) throws BusinessObjectException
      Class constructor specifying the Session and the individual components of the multi-part key: RiskObjectId and RiskThresholdObjectId. This constructor is most commonly used when update() is intended to be called on this object.
      Parameters:
      session - the Session
      riskObjectId - the first ObjectId in the key
      riskThresholdObjectId - the second ObjectId in the key
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • RiskImpact

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

    • loadRiskThreshold

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

    • loadRiskThresholdLevel

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

    • 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. Must be unique within a project.
      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. Does not need to be unique.
      Returns:
      the value in the field RiskName
      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

    • getRiskThresholdObjectId

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

    • getRiskThresholdName

      public String getRiskThresholdName() throws BusinessObjectException
      Gets the name of the associated risk score type.
      Returns:
      the value in the field RiskThresholdName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRiskThresholdLevelObjectId

      public ObjectId getRiskThresholdLevelObjectId() throws BusinessObjectException
      Gets the unique ID of the associated Risk Threshold. 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 RiskThresholdLevelObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRiskThresholdLevelObjectId

      public void setRiskThresholdLevelObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated Risk Threshold. 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

    • getRiskThresholdLevelCode

      public String getRiskThresholdLevelCode() throws BusinessObjectException
      Gets the 10 character short name for the threshold level. Must be unique.
      Returns:
      the value in the field RiskThresholdLevelCode
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRiskThresholdLevelName

      public String getRiskThresholdLevelName() throws BusinessObjectException
      Gets the 40 character name for the threshold level. Does not need to be unique.
      Returns:
      the value in the field RiskThresholdLevelName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this risk impact 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 impact 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 impact.
      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 impact.
      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.

    • createObjectId

      public static ObjectId createObjectId(ObjectId riskObjectId, ObjectId riskThresholdObjectId) throws InvalidValueException
      Creates a multi-part ObjectId from two individual ObjectIds.
      Parameters:
      riskObjectId - the ObjectId of the associated risk object.
      riskThresholdObjectId - the ObjectId of the associated riskThreshold object.
      Returns:
      ObjectId the multi-part ObjectId
      Throws:
      InvalidValueException - if one of the input parameters was invalid.
      IllegalArgumentException - if one of the input parameters was null.

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the ObjectId for this object. The ObjectId field serves as the primary key for the associated table in the database. For this object, the ObjectId is multi-part, consisting internally of the RiskObjectId and RiskThresholdObjectId fields.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      ObjectId the multi-part ObjectId of this object
      Throws:
      BusinessObjectException - if the ObjectId fields were not loaded.

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this RiskImpact object in the database.
      Returns:
      ObjectId the unique ID of the newly created RiskImpact 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, RiskImpact[] riskimpacts) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple RiskImpact objects in the database.
      Parameters:
      session - the Session object
      riskimpacts - array of RiskImpact objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created RiskImpact 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 RiskImpact load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single RiskImpact object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the RiskImpact object
      Returns:
      RiskImpact the RiskImpact 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<RiskImpact> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple RiskImpact objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the RiskImpact 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 RiskImpact 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, RiskImpact[] riskimpacts) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple RiskImpact objects in the database.
      Parameters:
      session - the Session object
      riskimpacts - array of RiskImpact 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 RiskImpact 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, RiskImpact[] riskimpacts) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple RiskImpact objects from the database.
      Parameters:
      session - the Session object
      riskimpacts - array of RiskImpact 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