|
Primavera Integration API Release 8 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.RiskResponsePlan
public class RiskResponsePlan
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 Summary | |
---|---|
RiskResponsePlan(Session session)
Class constructor specifying the Session. |
|
RiskResponsePlan(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
RiskResponsePlan(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 RiskResponsePlan object in the database. |
static ObjectId[] |
create(Session session,
RiskResponsePlan[] riskresponseplans)
Creates multiple RiskResponsePlan objects in the database. |
void |
delete()
Deletes this RiskResponsePlan object from the database. |
static void |
delete(Session session,
RiskResponsePlan[] riskresponseplans)
Deletes multiple RiskResponsePlan objects from the database. |
Cost |
getActualCost()
Gets the actual cost. |
static String[] |
getAllFields()
Gets all fields for this business object. |
Date |
getCreateDate()
Gets the date this risk response plan was created. |
String |
getCreateUser()
Gets the name of the user that created the risk response plan. |
static String[] |
getDefaultXMLExportFields()
Deprecated. |
static String[] |
getFilterableFields()
Gets all fields that can be filtered. |
EndDate |
getFinishDate()
Gets the finish date of the risk response action. |
String |
getId()
Gets the ID of the risk response plan. |
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. |
boolean |
getIsActive()
Gets the indication of whether the response plan is currently active for the associated risk. |
boolean |
getIsBaseline()
Gets the boolean value indicating if this business object is related to a Project or Baseline. |
boolean |
getIsTemplate()
Gets the boolean value indicating if this business object is related to a template Project. |
Date |
getLastUpdateDate()
Gets the date this risk response plan was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated the risk response plan. |
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 response plan. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
Cost |
getPlannedCost()
Gets the planned cost. |
EndDate |
getPlannedFinishDate()
Gets the planned finish date. |
BeginDate |
getPlannedStartDate()
Gets the planned start date. |
String |
getProjectId()
Gets the short name of the associated project. |
String |
getProjectName()
Gets the name of the associated project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
Cost |
getRemainingCost()
Gets the remaining cost associated with the risk response action. |
static String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
RiskResponseType |
getResponseType()
Gets the risk response plan type. |
String |
getRiskId()
Gets the ID of the risk. |
String |
getRiskName()
Gets the name of the risk. |
ObjectId |
getRiskObjectId()
Gets the unique ID of the associated risk. |
int |
getScore()
Gets the risk score from the numeric PID after all response actions of the response plan have been completed. |
int |
getScoreColor()
Gets the color of the tolerance threshold for the score value. |
String |
getScoreText()
Gets the risk score from the alphanumeric PID after all response actions of the response plan have been completed. |
BeginDate |
getStartDate()
Gets the start date of the risk response action. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static RiskResponsePlan |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single RiskResponsePlan object from the database. |
static BOIterator<RiskResponsePlan> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple RiskResponsePlan objects from the database. |
Project |
loadProject(String[] fields)
Loads an associated Project object from the database. |
Risk |
loadRisk(String[] fields)
Loads an associated Risk object from the database. |
BOIterator<RiskResponseAction> |
loadRiskResponseActions(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated RiskResponseAction objects from the database. |
void |
setId(String s)
Sets the ID of the risk response plan. |
void |
setIsActive(boolean b)
Sets the indication of whether the response plan is currently active for the associated risk. |
void |
setName(String s)
Sets the name of the risk response plan. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setResponseType(RiskResponseType enm)
Sets the risk response plan type. |
void |
setRiskObjectId(ObjectId o)
Sets the unique ID of the associated risk. |
String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this RiskResponsePlan object in the database. |
static void |
update(Session session,
RiskResponsePlan[] riskresponseplans)
Updates multiple RiskResponsePlan 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 |
---|
public RiskResponsePlan(Session session)
session
- the Sessionpublic RiskResponsePlan(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RiskResponsePlan(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public Risk loadRisk(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic Project loadProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic BOIterator<RiskResponseAction> loadRiskResponseActions(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getRiskObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRiskObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getRiskId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getRiskName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getRemainingCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getPlannedCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getActualCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic BeginDate getStartDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic EndDate getFinishDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic BeginDate getPlannedStartDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic EndDate getPlannedFinishDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getScore() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getScoreText() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getScoreColor() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getProjectName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setId(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsActive() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIsActive(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RiskResponseType getResponseType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResponseType(RiskResponseType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsTemplate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static String[] getRequiredCreateFields()
public static String[] getFilterableFields()
public static String[] getInternalDefaultLoadFields()
public static String[] getAllFields()
public static String[] getInternalAllFields()
public static Set<String> getInternalAllFieldsSet()
public static String[] getWritableFields()
@Deprecated public static String[] getDefaultXMLExportFields()
public static String[] getMinimumXMLExportFields()
public String toString()
toString
in class Object
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
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 objectspublic static ObjectId[] create(Session session, RiskResponsePlan[] riskresponseplans) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectriskresponseplans
- array of RiskResponsePlan objects to create
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 objectspublic static RiskResponsePlan load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the RiskResponsePlan object
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 objectspublic static BOIterator<RiskResponsePlan> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the RiskResponsePlan objects
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 objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class com.primavera.integration.client.BOBase
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 objectspublic static void update(Session session, RiskResponsePlan[] riskresponseplans) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectriskresponseplans
- array of RiskResponsePlan objects to update
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 objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class com.primavera.integration.client.BOBase
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 objectspublic static void delete(Session session, RiskResponsePlan[] riskresponseplans) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectriskresponseplans
- array of RiskResponsePlan objects to delete
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 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |