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

Class RiskMatrixThreshold

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

The risk matrix threshold object creates a relationship between a RiskThreshold object and a RiskMatrix object. This allows a single RiskThreshold object to be associated with multiple RiskMatrix objects.

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

See Also:   Quick reference of RiskMatrixThreshold fields

  • Constructor Details

    • RiskMatrixThreshold

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

    • RiskMatrixThreshold

      public RiskMatrixThreshold(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. For this particular object, the ObjectId is multi-part, created from the RiskMatrixObjectId 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

    • RiskMatrixThreshold

      public RiskMatrixThreshold(Session session, ObjectId riskMatrixObjectId, ObjectId riskThresholdObjectId) throws BusinessObjectException
      Class constructor specifying the Session and the individual components of the multi-part key: RiskMatrixObjectId and RiskThresholdObjectId.
      Parameters:
      session - the Session
      riskMatrixObjectId - 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

    • RiskMatrixThreshold

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

    • 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

    • 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

    • getRiskThresholdObjectId

      public ObjectId getRiskThresholdObjectId() 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 RiskThresholdObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRiskThresholdObjectId

      public void setRiskThresholdObjectId(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

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this risk matrix score type 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 type 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 type.
      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 type.
      Returns:
      the value in the field LastUpdateUser
      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 Threshold.
      Returns:
      the value in the field RiskThresholdName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRiskMatrixName

      public String getRiskMatrixName() throws BusinessObjectException
      Gets the name of the associated 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.

    • createObjectId

      public static ObjectId createObjectId(ObjectId riskMatrixObjectId, ObjectId riskThresholdObjectId) throws InvalidValueException
      Creates a multi-part ObjectId from two individual ObjectIds.
      Parameters:
      riskMatrixObjectId - the ObjectId of the associated riskMatrix 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 RiskMatrixObjectId 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 RiskMatrixThreshold object in the database.
      Returns:
      ObjectId the unique ID of the newly created RiskMatrixThreshold 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, RiskMatrixThreshold[] riskmatrixthresholds) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple RiskMatrixThreshold objects in the database.
      Parameters:
      session - the Session object
      riskmatrixthresholds - array of RiskMatrixThreshold objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created RiskMatrixThreshold 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 RiskMatrixThreshold load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single RiskMatrixThreshold object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the RiskMatrixThreshold object
      Returns:
      RiskMatrixThreshold the RiskMatrixThreshold 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<RiskMatrixThreshold> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple RiskMatrixThreshold objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the RiskMatrixThreshold 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

    • delete

      public void delete() throws ServerException, NetworkException, BusinessObjectException
      Deletes this RiskMatrixThreshold 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, RiskMatrixThreshold[] riskmatrixthresholds) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple RiskMatrixThreshold objects from the database.
      Parameters:
      session - the Session object
      riskmatrixthresholds - array of RiskMatrixThreshold 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