|
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.Risk
public class Risk
The risk object represents a probabilistic event or condition which if it occurs has an impact (e.g. schedule, cost, quality, safety) on the project. Risks with negative impacts are threats; risks with positive impacts on the project are opportunities.
This business object supports user defined fields (UDFs) and codes. Use the UDFValue business object to assign UDFs.
See Also: Quick reference of Risk fields
Constructor Summary | |
---|---|
Risk(Session session)
Class constructor specifying the Session. |
|
Risk(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
Risk(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 Risk object in the database. |
static ObjectId[] |
create(Session session,
Risk[] risks)
Creates multiple Risk objects in the database. |
void |
delete()
Deletes this Risk object from the database. |
static void |
delete(Session session,
Risk[] risks)
Deletes multiple Risk objects from the database. |
static String[] |
getAllFields()
Gets all fields for this business object. |
String |
getCause()
Gets the description of the cause of the Risk. |
Date |
getCreateDate()
Gets the date this risk was created. |
String |
getCreateUser()
Gets the name of the user that created the risk. |
static String[] |
getDefaultXMLExportFields()
Deprecated. |
String |
getDescription()
Gets the description of the Risk. |
String |
getEffect()
Gets the description of the risks effect on the project. |
static String[] |
getFilterableFields()
Gets all fields that can be filtered. |
String |
getId()
Gets the ID of the Risk. |
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 |
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 was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated the risk. |
static String[] |
getMainFields()
Gets all fields in the main group for this business object. |
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. |
String |
getNote()
Gets the comments associated with the Risk. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
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. |
static String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
String |
getResourceId()
Gets the ID of the resource who owns the Risk. |
String |
getResourceName()
Gets the name of the resource who owns the Risk. |
ObjectId |
getResourceObjectId()
Gets the unique ID of the associated resource. |
Cost |
getResponseTotalCost()
Gets the total estimated cost for the risk. |
String |
getRiskCategoryName()
Gets the name of the category to which the Risk is assigned. |
ObjectId |
getRiskCategoryObjectId()
Gets the unique ID of the category to which the Risk is assigned. |
int |
getScore()
Gets the calculated score value of the impact values assigned to the risk. |
int |
getScoreColor()
Gets the color of the tolerance threshold for the score value. |
String |
getScoreText()
Gets the calculated score text value of the impact values assigned to the risk. |
RiskStatus |
getStatus()
Gets the current status of the Risk. |
RiskType |
getType()
Gets the type of the risk. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static Risk |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single Risk object from the database. |
static BOIterator<Risk> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple Risk objects from the database. |
BOIterator<ActivityRisk> |
loadActivityRisks(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ActivityRisk objects from the database. |
Project |
loadProject(String[] fields)
Loads an associated Project object from the database. |
Resource |
loadResource(String[] fields)
Loads an associated Resource object from the database. |
RiskCategory |
loadRiskCategory(String[] fields)
Loads an associated RiskCategory object from the database. |
BOIterator<RiskImpact> |
loadRiskImpacts(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated RiskImpact objects from the database. |
BOIterator<RiskResponsePlan> |
loadRiskResponsePlans(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated RiskResponsePlan objects from the database. |
BOIterator<UDFValue> |
loadUDFValues(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated UDFValue objects from the database. |
void |
setCause(String s)
Sets the description of the cause of the Risk. |
void |
setDescription(String s)
Sets the description of the Risk. |
void |
setEffect(String s)
Sets the description of the risks effect on the project. |
void |
setId(String s)
Sets the ID of the Risk. |
void |
setName(String s)
Sets the name of the Risk. |
void |
setNote(String s)
Sets the comments associated with the Risk. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setProjectObjectId(ObjectId o)
Sets the unique ID of the associated project. |
void |
setResourceObjectId(ObjectId o)
Sets the unique ID of the associated resource. |
void |
setResponseTotalCost(Cost c)
Sets the total estimated cost for the risk. |
void |
setRiskCategoryObjectId(ObjectId o)
Sets the unique ID of the category to which the Risk is assigned. |
void |
setStatus(RiskStatus enm)
Sets the current status of the Risk. |
void |
setType(RiskType enm)
Sets the type of the risk. |
String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this Risk object in the database. |
static void |
update(Session session,
Risk[] risks)
Updates multiple Risk 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 Risk(Session session)
session
- the Sessionpublic Risk(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Risk(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 BOIterator<ActivityRisk> loadActivityRisks(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 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 Resource loadResource(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 RiskCategory loadRiskCategory(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<RiskResponsePlan> loadRiskResponsePlans(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 BOIterator<RiskImpact> loadRiskImpacts(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 BOIterator<UDFValue> loadUDFValues(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 getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
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 Cost getResponseTotalCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResponseTotalCost(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getResourceObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResourceObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getResourceName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getResourceId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getRiskCategoryObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRiskCategoryObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getRiskCategoryName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RiskType getType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setType(RiskType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RiskStatus getStatus() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setStatus(RiskStatus enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getDescription() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDescription(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getEffect() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setEffect(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getCause() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCause(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getNote() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setNote(String s) throws BusinessObjectException
s
- 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 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 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[] getMainFields()
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, Risk[] risks) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectrisks
- array of Risk 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 Risk load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the Risk 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<Risk> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the Risk 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, Risk[] risks) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectrisks
- array of Risk 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, Risk[] risks) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectrisks
- array of Risk 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 |