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

Class RiskMatrixScore

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.RiskMatrixScore
public class RiskMatrixScore extends BusinessObject
The risk matrix score object stores the score values from the probability and impact diagram (PID) of the risk score matrix.

See Also:   Quick reference of RiskMatrixScore fields

  • Constructor Details

    • RiskMatrixScore

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

    • RiskMatrixScore

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

    • RiskMatrixScore

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

    • loadRiskMatrix

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

    • 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

    • getRiskMatrixObjectId

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

    • setRiskMatrixObjectId

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

    • getProbabilityThresholdLevel

      public int getProbabilityThresholdLevel() throws BusinessObjectException
      Gets the level number of the probability threshold. Valid numbers are 1-9. 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 ProbabilityThresholdLevel
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setProbabilityThresholdLevel

      public void setProbabilityThresholdLevel(int i) throws BusinessObjectException
      Sets the level number of the probability threshold. Valid numbers are 1-9. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity1

      public int getSeverity1() throws BusinessObjectException
      Gets the first severity level of the Risk Matrix Score.
      Returns:
      the value in the field Severity1
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity1

      public void setSeverity1(int i) throws BusinessObjectException
      Sets the first severity level of the Risk Matrix Score.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity2

      public int getSeverity2() throws BusinessObjectException
      Gets the second severity level of the Risk Matrix Score.
      Returns:
      the value in the field Severity2
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity2

      public void setSeverity2(int i) throws BusinessObjectException
      Sets the second severity level of the Risk Matrix Score.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity3

      public int getSeverity3() throws BusinessObjectException
      Gets the third severity level of the Risk Matrix Score.
      Returns:
      the value in the field Severity3
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity3

      public void setSeverity3(int i) throws BusinessObjectException
      Sets the third severity level of the Risk Matrix Score.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity4

      public int getSeverity4() throws BusinessObjectException
      Gets the fourth severity level of the Risk Matrix Score.
      Returns:
      the value in the field Severity4
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity4

      public void setSeverity4(int i) throws BusinessObjectException
      Sets the fourth severity level of the Risk Matrix Score.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity5

      public int getSeverity5() throws BusinessObjectException
      Gets the fifth severity level of the Risk Matrix Score.
      Returns:
      the value in the field Severity5
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity5

      public void setSeverity5(int i) throws BusinessObjectException
      Sets the fifth severity level of the Risk Matrix Score.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity6

      public int getSeverity6() throws BusinessObjectException
      Gets the sixth severity level of the Risk Matrix Score.
      Returns:
      the value in the field Severity6
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity6

      public void setSeverity6(int i) throws BusinessObjectException
      Sets the sixth severity level of the Risk Matrix Score.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity7

      public int getSeverity7() throws BusinessObjectException
      Gets the seventh severity level of the Risk Matrix Score.
      Returns:
      the value in the field Severity7
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity7

      public void setSeverity7(int i) throws BusinessObjectException
      Sets the seventh severity level of the Risk Matrix Score.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity8

      public int getSeverity8() throws BusinessObjectException
      Gets the eighth severity level of the Risk Matrix Score.
      Returns:
      the value in the field Severity8
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity8

      public void setSeverity8(int i) throws BusinessObjectException
      Sets the eighth severity level of the Risk Matrix Score.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity9

      public int getSeverity9() throws BusinessObjectException
      Gets the ninth severity level of the Risk Matrix Score.
      Returns:
      the value in the field Severity9
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity9

      public void setSeverity9(int i) throws BusinessObjectException
      Sets the ninth severity level of the Risk Matrix Score.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity1Label

      public String getSeverity1Label() throws BusinessObjectException
      Gets the label for the first severity level.
      Returns:
      the value in the field Severity1Label
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity1Label

      public void setSeverity1Label(String s) throws BusinessObjectException
      Sets the label for the first severity level.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity2Label

      public String getSeverity2Label() throws BusinessObjectException
      Gets the label for the second severity level.
      Returns:
      the value in the field Severity2Label
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity2Label

      public void setSeverity2Label(String s) throws BusinessObjectException
      Sets the label for the second severity level.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity3Label

      public String getSeverity3Label() throws BusinessObjectException
      Gets the label for the third severity level.
      Returns:
      the value in the field Severity3Label
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity3Label

      public void setSeverity3Label(String s) throws BusinessObjectException
      Sets the label for the third severity level.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity4Label

      public String getSeverity4Label() throws BusinessObjectException
      Gets the label for the forth severity level.
      Returns:
      the value in the field Severity4Label
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity4Label

      public void setSeverity4Label(String s) throws BusinessObjectException
      Sets the label for the forth severity level.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity5Label

      public String getSeverity5Label() throws BusinessObjectException
      Gets the label for the fith severity level.
      Returns:
      the value in the field Severity5Label
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity5Label

      public void setSeverity5Label(String s) throws BusinessObjectException
      Sets the label for the fith severity level.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity6Label

      public String getSeverity6Label() throws BusinessObjectException
      Gets the sixth for the first severity level.
      Returns:
      the value in the field Severity6Label
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity6Label

      public void setSeverity6Label(String s) throws BusinessObjectException
      Sets the sixth for the first severity level.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity7Label

      public String getSeverity7Label() throws BusinessObjectException
      Gets the label for the seventh severity level.
      Returns:
      the value in the field Severity7Label
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity7Label

      public void setSeverity7Label(String s) throws BusinessObjectException
      Sets the label for the seventh severity level.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity8Label

      public String getSeverity8Label() throws BusinessObjectException
      Gets the label for the eighth severity level.
      Returns:
      the value in the field Severity8Label
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity8Label

      public void setSeverity8Label(String s) throws BusinessObjectException
      Sets the label for the eighth severity level.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSeverity9Label

      public String getSeverity9Label() throws BusinessObjectException
      Gets the label for the ninth severity level.
      Returns:
      the value in the field Severity9Label
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSeverity9Label

      public void setSeverity9Label(String s) throws BusinessObjectException
      Sets the label for the ninth severity level.
      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 risk matrix score 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 matrix score 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 matrix score.
      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 matrix score.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRiskMatrixName

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