Primavera Integration API Release 8

com.primavera.integration.client.bo.object
Class RiskMatrix

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.object.RiskMatrix

public class RiskMatrix
extends BusinessObject

The risk matrix object contains the name and description of each probability and impact diagram (PID). The Risk Matrix is then used to qualitatively assess each risk and assign a score.

See Also:   Quick reference of RiskMatrix fields


Constructor Summary
RiskMatrix(Session session)
          Class constructor specifying the Session.
RiskMatrix(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
RiskMatrix(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this RiskMatrix object in the database.
static ObjectId[] create(Session session, RiskMatrix[] riskmatrices)
          Creates multiple RiskMatrix objects in the database.
 ObjectId createRiskMatrixScore(RiskMatrixScore riskmatrixscore)
          Creates an associated RiskMatrixScore object in the database.
 ObjectId[] createRiskMatrixScores(RiskMatrixScore[] riskmatrixscores)
          Creates multiple associated RiskMatrixScore objects in the database.
 ObjectId createRiskMatrixThreshold(RiskMatrixThreshold riskmatrixthreshold)
          Creates an associated RiskMatrixThreshold object in the database.
 ObjectId[] createRiskMatrixThresholds(RiskMatrixThreshold[] riskmatrixthresholds)
          Creates multiple associated RiskMatrixThreshold objects in the database.
 void delete()
          Deletes this RiskMatrix object from the database.
static void delete(Session session, RiskMatrix[] riskmatrices)
          Deletes multiple RiskMatrix objects from the database.
 void deleteRiskMatrixScores(RiskMatrixScore[] riskmatrixscores)
          Deletes multiple associated RiskMatrixScore objects from the database.
 void deleteRiskMatrixThresholds(RiskMatrixThreshold[] riskmatrixthresholds)
          Deletes multiple associated RiskMatrixThreshold objects from the database.
static String[] getAllFields()
          Gets all fields for this business object.
 Date getCreateDate()
          Gets the date this risk matrix was created.
 String getCreateUser()
          Gets the name of the user that created the risk matrix.
static String[] getDefaultXMLExportFields()
          Deprecated. 
 String getDescription()
          Gets the description of the risk matrix.
static String[] getFilterableFields()
          Gets all fields that can be filtered.
 int getImpactThresholdLevel()
          Gets the number of levels for the impact thresholds assigned to the risk scoring matrix.
static String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static Set<String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 Date getLastUpdateDate()
          Gets the date this risk matrix was last updated.
 String getLastUpdateUser()
          Gets the name of the user that last updated the risk matrix.
static String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 String getName()
          Gets the name of the risk matrix.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 int getProbabilityThresholdLevel()
          Gets the number of levels for the probability threshold assigned to the risk matrix.
static String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 RiskScoreMatrixMethod getRiskScoringMethod()
          Gets the calculation method used to determine the risk score.
static String[] getWritableFields()
          Gets all writable fields for this business object.
static RiskMatrix load(Session session, String[] fields, ObjectId objId)
          Loads a single RiskMatrix object from the database.
static BOIterator<RiskMatrix> load(Session session, String[] fields, ObjectId[] objIds)
          Loads multiple RiskMatrix objects from the database.
 BOIterator<Project> loadProjects(String[] fields, String sWhereClause, String sOrderBy)
          Loads multiple associated Project objects from the database.
 BOIterator<RiskMatrixScore> loadRiskMatrixScores(String[] fields, String sWhereClause, String sOrderBy)
          Loads multiple associated RiskMatrixScore objects from the database.
 BOIterator<RiskMatrixThreshold> loadRiskMatrixThresholds(String[] fields, String sWhereClause, String sOrderBy)
          Loads multiple associated RiskMatrixThreshold objects from the database.
 void setDescription(String s)
          Sets the description of the risk matrix.
 void setName(String s)
          Sets the name of the risk matrix.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setRiskScoringMethod(RiskScoreMatrixMethod enm)
          Sets the calculation method used to determine the risk score.
 String toString()
          Returns a string representation of the object.
 void update()
          Updates this RiskMatrix object in the database.
static void update(Session session, RiskMatrix[] riskmatrices)
          Updates multiple RiskMatrix objects in the database.
 void updateRiskMatrixScores(RiskMatrixScore[] riskmatrixscores)
          Updates multiple associated RiskMatrixScore objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RiskMatrix

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

RiskMatrix

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

RiskMatrix

public RiskMatrix(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 Detail

createRiskMatrixScore

public ObjectId createRiskMatrixScore(RiskMatrixScore riskmatrixscore)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Creates an associated RiskMatrixScore object in the database.

Parameters:
riskmatrixscore - RiskMatrixScore object to create
Returns:
ObjectId 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

createRiskMatrixScores

public ObjectId[] createRiskMatrixScores(RiskMatrixScore[] riskmatrixscores)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Creates multiple associated RiskMatrixScore objects in the database.

Parameters:
riskmatrixscores - array of RiskMatrixScore objects to create
Returns:
ObjectId[] array of object 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

loadRiskMatrixScores

public BOIterator<RiskMatrixScore> loadRiskMatrixScores(String[] fields,
                                                        String sWhereClause,
                                                        String sOrderBy)
                                                 throws ServerException,
                                                        NetworkException,
                                                        BusinessObjectException
Loads multiple associated RiskMatrixScore 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

updateRiskMatrixScores

public void updateRiskMatrixScores(RiskMatrixScore[] riskmatrixscores)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Updates multiple associated RiskMatrixScore objects in the database.

Parameters:
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

deleteRiskMatrixScores

public void deleteRiskMatrixScores(RiskMatrixScore[] riskmatrixscores)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Deletes multiple associated RiskMatrixScore objects from the database.

Parameters:
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

createRiskMatrixThreshold

public ObjectId createRiskMatrixThreshold(RiskMatrixThreshold riskmatrixthreshold)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Creates an associated RiskMatrixThreshold object in the database.

Parameters:
riskmatrixthreshold - RiskMatrixThreshold object to create
Returns:
ObjectId 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

createRiskMatrixThresholds

public ObjectId[] createRiskMatrixThresholds(RiskMatrixThreshold[] riskmatrixthresholds)
                                      throws ServerException,
                                             NetworkException,
                                             BusinessObjectException
Creates multiple associated RiskMatrixThreshold objects in the database.

Parameters:
riskmatrixthresholds - array of RiskMatrixThreshold objects to create
Returns:
ObjectId[] array of object 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

loadRiskMatrixThresholds

public BOIterator<RiskMatrixThreshold> loadRiskMatrixThresholds(String[] fields,
                                                                String sWhereClause,
                                                                String sOrderBy)
                                                         throws ServerException,
                                                                NetworkException,
                                                                BusinessObjectException
Loads multiple associated RiskMatrixThreshold 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

deleteRiskMatrixThresholds

public void deleteRiskMatrixThresholds(RiskMatrixThreshold[] riskmatrixthresholds)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Deletes multiple associated RiskMatrixThreshold objects from the database.

Parameters:
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

loadProjects

public BOIterator<Project> loadProjects(String[] fields,
                                        String sWhereClause,
                                        String sOrderBy)
                                 throws ServerException,
                                        NetworkException,
                                        BusinessObjectException
Loads multiple associated Project 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

getName

public String getName()
               throws BusinessObjectException
Gets the name of the risk matrix. 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 risk matrix. 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

getDescription

public String getDescription()
                      throws BusinessObjectException
Gets the description of the risk matrix.

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 risk matrix.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRiskScoringMethod

public RiskScoreMatrixMethod getRiskScoringMethod()
                                           throws BusinessObjectException
Gets the calculation method used to determine the risk score. Valid values are 'Highest', 'Average of Impacts', 'Average of Individual Scores'.

Returns:
the value in the field RiskScoringMethod
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setRiskScoringMethod

public void setRiskScoringMethod(RiskScoreMatrixMethod enm)
                          throws BusinessObjectException
Sets the calculation method used to determine the risk score. Valid values are 'Highest', 'Average of Impacts', 'Average of Individual Scores'.

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 matrix 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 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.

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.

Returns:
the value in the field LastUpdateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getImpactThresholdLevel

public int getImpactThresholdLevel()
                            throws BusinessObjectException
Gets the number of levels for the impact thresholds assigned to the risk scoring matrix. This impact level with the probability level determines the size of the matrix.

Returns:
the value in the field ImpactThresholdLevel
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getProbabilityThresholdLevel

public int getProbabilityThresholdLevel()
                                 throws BusinessObjectException
Gets the number of levels for the probability threshold assigned to the risk matrix. This probability level with the impact level determines the size of the matrix.

Returns:
the value in the field ProbabilityThresholdLevel
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 RiskMatrix object in the database.

Returns:
ObjectId the unique ID of the newly created 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

create

public static ObjectId[] create(Session session,
                                RiskMatrix[] riskmatrices)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple RiskMatrix objects in the database.

Parameters:
session - the Session object
riskmatrices - array of RiskMatrix objects to create
Returns:
ObjectId[] the array of unique IDs of newly created RiskMatrix 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 RiskMatrix load(Session session,
                              String[] fields,
                              ObjectId objId)
                       throws ServerException,
                              NetworkException,
                              BusinessObjectException
Loads a single RiskMatrix object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the RiskMatrix object
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

load

public static BOIterator<RiskMatrix> load(Session session,
                                          String[] fields,
                                          ObjectId[] objIds)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Loads multiple RiskMatrix objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the RiskMatrix 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 RiskMatrix object in the database.

Overrides:
update in class com.primavera.integration.client.BOBase
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,
                          RiskMatrix[] riskmatrices)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple RiskMatrix objects in the database.

Parameters:
session - the Session object
riskmatrices - array of RiskMatrix 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 RiskMatrix object from the database.

Overrides:
delete in class com.primavera.integration.client.BOBase
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,
                          RiskMatrix[] riskmatrices)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple RiskMatrix objects from the database.

Parameters:
session - the Session object
riskmatrices - array of RiskMatrix 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

Primavera Integration API Release 8

Copyright © 2003, 2010, Oracle and/or its affiliates. All rights reserved.