Primavera Integration API 7.0

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

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.base.ProjectRiskBase
              extended by com.primavera.integration.client.bo.object.ProjectRisk

public class ProjectRisk
extends com.primavera.integration.client.bo.base.ProjectRiskBase

Use project risks to identify, categorize, and prioritize potential risks associated with specific work breakdown structure (WBS) elements and resources. You can also create risk control plans and assign a probability of occurrence and an organizational breakdown structure (OBS) element to each risk. A risk's assigned OBS element is the person or project manager responsible for managing the risk.

This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.

See Also:   Quick reference of ProjectRisk fields


Constructor Summary
ProjectRisk(Session session)
          Class constructor specifying the Session.
ProjectRisk(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ProjectRisk(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 ProjectRisk object in the database.
static ObjectId[] create(Session session, ProjectRisk[] projectrisks)
          Creates multiple ProjectRisk objects in the database.
 void delete()
          Deletes this ProjectRisk object from the database.
static void delete(Session session, ProjectRisk[] projectrisks)
          Deletes multiple ProjectRisk objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this project risk was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this project risk.
 java.util.Date getDateIdentified()
          Gets the date the project risk was identified.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 java.lang.String getDescription()
          Gets the description of the project risk.
 double getExposureExpenses()
          Gets the net exposure of the risk on the project in terms of expenses.
 Unit getExposureLaborUnits()
          Gets the net exposure of the risk on the project in terms of labor units.
 Unit getExposureMaterialUnits()
          Gets the net exposure of the risk on the project in terms of labor units.
 Unit getExposureNonLaborUnits()
          Gets the net exposure of the risk on the project in terms of nonlabor units.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 java.util.Date getImpactDate()
          Gets the estimated impact date of the project risk.
 double getImpactExpenses()
          Gets the estimated impact of the risk on the project in terms of expenses, if the risk occurs.
 Unit getImpactLaborUnits()
          Gets the estimated impact of the risk on the project in terms of labor units, if the risk occurs.
 Unit getImpactMaterialUnits()
          Gets the estimated impact of the risk on the project in terms of labor units, if the risk occurs.
 Unit getImpactNonLaborUnits()
          Gets the estimated impact of the risk on the project in terms of nonlabor units, if the risk occurs.
 int getImpactProbability()
          Gets the probability of occurrence of the project risk, as a percent.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.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.
 java.util.Date getLastUpdateDate()
          Gets the date this project risk was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this project risk.
static java.lang.String[] getMainFields()
          Gets all fields in the main group for this business object.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the name of the project risk.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 java.lang.String getOBSName()
          Gets the name of the person/role in the organization, sometimes referred to as the "responsible manager".
 ObjectId getOBSObjectId()
          Gets the unique ID of the project manager from the project's OBS tree who is responsible for the project risk.
 RiskPriority getPriority()
          Gets the priority of the project risk: 'Top', 'High', 'Normal', 'Low', or 'Lowest'.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the project.
 java.lang.String getProjectName()
          Gets the name of the associated project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 java.lang.String getResourceId()
          Gets the short code that uniquely identifies the resource.
 java.lang.String getResourceName()
          Gets the name of the resource.
 ObjectId getResourceObjectId()
          Gets the unique ID of the associated resource for this project risk.
 java.lang.String getRiskControlPlan()
          Gets the description of the plan for managing selected risks and their effects.
 ObjectId getRiskTypeObjectId()
          Gets the unique ID of the associated risk type.
 RiskStatus getStatus()
          Gets the current status of the project risk: 'Open' or 'Closed'.
 java.lang.String getType()
          Gets the risk types used to categorize risks.
 Cost getUDFCost(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Double getUDFDouble(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 EndDate getUDFFinishDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 UDFIndicator getUDFIndicator(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Integer getUDFInteger(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 BeginDate getUDFStartDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.String getUDFText(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 ObjectId[] getUDFTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.
 java.lang.String getWBSCode()
          Gets the short code assigned to each WBS element for identification.
 java.lang.String getWBSName()
          Gets the name of the WBS element.
 ObjectId getWBSObjectId()
          Gets the unique ID of the WBS to which the risk applies.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ProjectRisk load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ProjectRisk object from the database.
static BOIterator<ProjectRisk> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ProjectRisk objects from the database.
 OBS loadOBS(java.lang.String[] fields)
          Loads an associated OBS object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 Resource loadResource(java.lang.String[] fields)
          Loads an associated Resource object from the database.
 RiskType loadRiskType(java.lang.String[] fields)
          Loads an associated RiskType object from the database.
 BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UDFValue objects from the database.
 WBS loadWBS(java.lang.String[] fields)
          Loads an associated WBS object from the database.
 void setDateIdentified(java.util.Date d)
          Sets the date the project risk was identified.
 void setDescription(java.lang.String s)
          Sets the description of the project risk.
 void setImpactDate(java.util.Date d)
          Sets the estimated impact date of the project risk.
 void setImpactExpenses(double d)
          Sets the estimated impact of the risk on the project in terms of expenses, if the risk occurs.
 void setImpactLaborUnits(Unit u)
          Sets the estimated impact of the risk on the project in terms of labor units, if the risk occurs.
 void setImpactMaterialUnits(Unit u)
          Sets the estimated impact of the risk on the project in terms of labor units, if the risk occurs.
 void setImpactNonLaborUnits(Unit u)
          Sets the estimated impact of the risk on the project in terms of nonlabor units, if the risk occurs.
 void setImpactProbability(int i)
          Sets the probability of occurrence of the project risk, as a percent.
 void setName(java.lang.String s)
          Sets the name of the project risk.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setOBSObjectId(ObjectId o)
          Sets the unique ID of the project manager from the project's OBS tree who is responsible for the project risk.
 void setPriority(RiskPriority enm)
          Sets the priority of the project risk: 'Top', 'High', 'Normal', 'Low', or 'Lowest'.
 void setProjectObjectId(ObjectId o)
          Sets the unique ID of the associated project.
 void setResourceObjectId(ObjectId o)
          Sets the unique ID of the associated resource for this project risk.
 void setRiskControlPlan(java.lang.String s)
          Sets the description of the plan for managing selected risks and their effects.
 void setRiskTypeObjectId(ObjectId o)
          Sets the unique ID of the associated risk type.
 void setStatus(RiskStatus enm)
          Sets the current status of the project risk: 'Open' or 'Closed'.
 void setUDFCost(ObjectId objId, Cost cost)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFDouble(ObjectId objId, java.lang.Double n)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFFinishDate(ObjectId objId, EndDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFIndicator(ObjectId objId, UDFIndicator ind)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFInteger(ObjectId objId, java.lang.Integer i)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFStartDate(ObjectId objId, BeginDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFText(ObjectId objId, java.lang.String s)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setWBSObjectId(ObjectId o)
          Sets the unique ID of the WBS to which the risk applies.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ProjectRisk object in the database.
static void update(Session session, ProjectRisk[] projectrisks)
          Updates multiple ProjectRisk 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

ProjectRisk

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

ProjectRisk

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

ProjectRisk

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

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this ProjectRisk object in the database.

Returns:
ObjectId the unique ID of the newly created ProjectRisk 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,
                                ProjectRisk[] projectrisks)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple ProjectRisk objects in the database.

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

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ProjectRisk object
Returns:
ProjectRisk the ProjectRisk 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<ProjectRisk> load(Session session,
                                           java.lang.String[] fields,
                                           ObjectId[] objIds)
                                    throws ServerException,
                                           NetworkException,
                                           BusinessObjectException
Loads multiple ProjectRisk objects from the database.

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

Overrides:
update in class 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,
                          ProjectRisk[] projectrisks)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ProjectRisk objects in the database.

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

Overrides:
delete in class 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,
                          ProjectRisk[] projectrisks)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple ProjectRisk objects from the database.

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

loadProject

public Project loadProject(java.lang.String[] fields)
                    throws ServerException,
                           NetworkException,
                           BusinessObjectException
Loads an associated Project object from the database.

Parameters:
fields - fields to load
Returns:
Project the Project 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

loadWBS

public WBS loadWBS(java.lang.String[] fields)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Loads an associated WBS object from the database.

Parameters:
fields - fields to load
Returns:
WBS the WBS 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

loadOBS

public OBS loadOBS(java.lang.String[] fields)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Loads an associated OBS object from the database.

Parameters:
fields - fields to load
Returns:
OBS the OBS 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

loadRiskType

public RiskType loadRiskType(java.lang.String[] fields)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads an associated RiskType object from the database.

Parameters:
fields - fields to load
Returns:
RiskType the RiskType 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

loadResource

public Resource loadResource(java.lang.String[] fields)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads an associated Resource object from the database.

Parameters:
fields - fields to load
Returns:
Resource the Resource 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

loadUDFValues

public BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields,
                                          java.lang.String sWhereClause,
                                          java.lang.String sOrderBy)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Loads multiple associated UDFValue 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

getUDFTypesAssigned

@Deprecated
public ObjectId[] getUDFTypesAssigned()
                               throws BusinessObjectException
Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.

Gets the ObjectIds of all UDFTypes for which UDFs are assigned to this project risk.

Overrides:
getUDFTypesAssigned in class com.primavera.integration.client.bo.base.ProjectRiskBase
Returns:
ObjectId array of UDFType
Throws:
BusinessObjectException

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

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.

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

getWBSObjectId

public ObjectId getWBSObjectId()
                        throws BusinessObjectException
Gets the unique ID of the WBS to which the risk applies. If a parent WBS is selected, the risk applies to all child elements as well. If the top WBS is selected, the risk applies to the entire project. 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 WBSObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setWBSObjectId

public void setWBSObjectId(ObjectId o)
                    throws BusinessObjectException
Sets the unique ID of the WBS to which the risk applies. If a parent WBS is selected, the risk applies to all child elements as well. If the top WBS is selected, the risk applies to the entire project. 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

getWBSCode

public java.lang.String getWBSCode()
                            throws BusinessObjectException
Gets the short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes.

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

getWBSName

public java.lang.String getWBSName()
                            throws BusinessObjectException
Gets the name of the WBS element.

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

getProjectName

public java.lang.String getProjectName()
                                throws BusinessObjectException
Gets the name of the associated project.

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

getResourceObjectId

public ObjectId getResourceObjectId()
                             throws BusinessObjectException
Gets the unique ID of the associated resource for this project risk. If a parent resource is selected, the risk applies to all child resources as well. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setResourceObjectId

public void setResourceObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the associated resource for this project risk. If a parent resource is selected, the risk applies to all child resources as well. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getResourceId

public java.lang.String getResourceId()
                               throws BusinessObjectException
Gets the short code that uniquely identifies the resource.

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

getResourceName

public java.lang.String getResourceName()
                                 throws BusinessObjectException
Gets the name of the resource.

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

getProjectObjectId

public ObjectId getProjectObjectId()
                            throws BusinessObjectException
Gets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setProjectObjectId

public void setProjectObjectId(ObjectId o)
                        throws BusinessObjectException
Sets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getProjectId

public java.lang.String getProjectId()
                              throws BusinessObjectException
Gets the short code that uniquely identifies the project.

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

getOBSObjectId

public ObjectId getOBSObjectId()
                        throws BusinessObjectException
Gets the unique ID of the project manager from the project's OBS tree who is responsible for the project risk. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setOBSObjectId

public void setOBSObjectId(ObjectId o)
                    throws BusinessObjectException
Sets the unique ID of the project manager from the project's OBS tree who is responsible for the project risk. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getRiskTypeObjectId

public ObjectId getRiskTypeObjectId()
                             throws BusinessObjectException
Gets the unique ID of the associated risk type. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setRiskTypeObjectId

public void setRiskTypeObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the associated risk type. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the project risk. 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(java.lang.String s)
             throws BusinessObjectException
Sets the name of the project risk. 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

getType

public java.lang.String getType()
                         throws BusinessObjectException
Gets the risk types used to categorize risks.

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

getOBSName

public java.lang.String getOBSName()
                            throws BusinessObjectException
Gets the name of the person/role in the organization, sometimes referred to as the "responsible manager".

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

getPriority

public RiskPriority getPriority()
                         throws BusinessObjectException
Gets the priority of the project risk: 'Top', 'High', 'Normal', 'Low', or 'Lowest'.

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

setPriority

public void setPriority(RiskPriority enm)
                 throws BusinessObjectException
Sets the priority of the project risk: 'Top', 'High', 'Normal', 'Low', or 'Lowest'.

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

getStatus

public RiskStatus getStatus()
                     throws BusinessObjectException
Gets the current status of the project risk: 'Open' or 'Closed'.

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

setStatus

public void setStatus(RiskStatus enm)
               throws BusinessObjectException
Sets the current status of the project risk: 'Open' or 'Closed'.

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

getDescription

public java.lang.String getDescription()
                                throws BusinessObjectException
Gets the description of the project risk. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setDescription

public void setDescription(java.lang.String s)
                    throws BusinessObjectException
Sets the description of the project risk. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getDateIdentified

public java.util.Date getDateIdentified()
                                 throws BusinessObjectException
Gets the date the project risk was identified.

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

setDateIdentified

public void setDateIdentified(java.util.Date d)
                       throws BusinessObjectException
Sets the date the project risk was identified.

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

getImpactDate

public java.util.Date getImpactDate()
                             throws BusinessObjectException
Gets the estimated impact date of the project risk. When the project risk WBS impact is computed, only activities forward of the project risk impact date are involved.

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

setImpactDate

public void setImpactDate(java.util.Date d)
                   throws BusinessObjectException
Sets the estimated impact date of the project risk. When the project risk WBS impact is computed, only activities forward of the project risk impact date are involved.

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

getImpactNonLaborUnits

public Unit getImpactNonLaborUnits()
                            throws BusinessObjectException
Gets the estimated impact of the risk on the project in terms of nonlabor units, if the risk occurs.

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

setImpactNonLaborUnits

public void setImpactNonLaborUnits(Unit u)
                            throws BusinessObjectException
Sets the estimated impact of the risk on the project in terms of nonlabor units, if the risk occurs.

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

getImpactExpenses

public double getImpactExpenses()
                         throws BusinessObjectException
Gets the estimated impact of the risk on the project in terms of expenses, if the risk occurs.

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

setImpactExpenses

public void setImpactExpenses(double d)
                       throws BusinessObjectException
Sets the estimated impact of the risk on the project in terms of expenses, if the risk occurs.

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

getImpactLaborUnits

public Unit getImpactLaborUnits()
                         throws BusinessObjectException
Gets the estimated impact of the risk on the project in terms of labor units, if the risk occurs.

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

setImpactLaborUnits

public void setImpactLaborUnits(Unit u)
                         throws BusinessObjectException
Sets the estimated impact of the risk on the project in terms of labor units, if the risk occurs.

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

getImpactMaterialUnits

public Unit getImpactMaterialUnits()
                            throws BusinessObjectException
Gets the estimated impact of the risk on the project in terms of labor units, if the risk occurs.

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

setImpactMaterialUnits

public void setImpactMaterialUnits(Unit u)
                            throws BusinessObjectException
Sets the estimated impact of the risk on the project in terms of labor units, if the risk occurs.

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

getImpactProbability

public int getImpactProbability()
                         throws BusinessObjectException
Gets the probability of occurrence of the project risk, as a percent. A probability of 50 means there is a 50% chance the project risk will occur.

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

setImpactProbability

public void setImpactProbability(int i)
                          throws BusinessObjectException
Sets the probability of occurrence of the project risk, as a percent. A probability of 50 means there is a 50% chance the project risk will occur.

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

getExposureNonLaborUnits

public Unit getExposureNonLaborUnits()
                              throws BusinessObjectException
Gets the net exposure of the risk on the project in terms of nonlabor units. The exposure nonlabor units are calculated as the impact nonlabor units times the risk probability. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getExposureExpenses

public double getExposureExpenses()
                           throws BusinessObjectException
Gets the net exposure of the risk on the project in terms of expenses. The exposure expenses are calculated as the impact expenses times the risk probability. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getExposureLaborUnits

public Unit getExposureLaborUnits()
                           throws BusinessObjectException
Gets the net exposure of the risk on the project in terms of labor units. The exposure labor units are calculated as the impact labor units times the risk probability. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getExposureMaterialUnits

public Unit getExposureMaterialUnits()
                              throws BusinessObjectException
Gets the net exposure of the risk on the project in terms of labor units. The exposure labor units are calculated as the impact labor units times the risk probability. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getRiskControlPlan

public java.lang.String getRiskControlPlan()
                                    throws BusinessObjectException
Gets the description of the plan for managing selected risks and their effects. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setRiskControlPlan

public void setRiskControlPlan(java.lang.String s)
                        throws BusinessObjectException
Sets the description of the plan for managing selected risks and their effects. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this project risk was created.

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

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this project risk was last updated.

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

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this project risk.

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

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this project risk.

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

getIsBaseline

public boolean getIsBaseline()
                      throws BusinessObjectException
Gets the boolean value indicating if this business object is related to a Project or Baseline.

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

getUDFCost

@Deprecated
public Cost getUDFCost(ObjectId objId)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Cost user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Cost the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFCost

@Deprecated
public void setUDFCost(ObjectId objId,
                                  Cost cost)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Cost user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
cost - the Cost value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFDouble

@Deprecated
public java.lang.Double getUDFDouble(ObjectId objId)
                              throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Double user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Double the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFDouble

@Deprecated
public void setUDFDouble(ObjectId objId,
                                    java.lang.Double n)
                  throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Double user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
n - the Double value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFFinishDate

@Deprecated
public EndDate getUDFFinishDate(ObjectId objId)
                         throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular FinishDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
EndDate the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFFinishDate

@Deprecated
public void setUDFFinishDate(ObjectId objId,
                                        EndDate date)
                      throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular FinishDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
date - the FinishDate value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFIndicator

@Deprecated
public UDFIndicator getUDFIndicator(ObjectId objId)
                             throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Indicator user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
com.primavera.integration.client.bo.enm.UDFIndicator the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFIndicator

@Deprecated
public void setUDFIndicator(ObjectId objId,
                                       UDFIndicator ind)
                     throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Indicator user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
ind - the Indicator value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFInteger

@Deprecated
public java.lang.Integer getUDFInteger(ObjectId objId)
                                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Integer user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Integer the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFInteger

@Deprecated
public void setUDFInteger(ObjectId objId,
                                     java.lang.Integer i)
                   throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Integer user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
i - the Integer value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFStartDate

@Deprecated
public BeginDate getUDFStartDate(ObjectId objId)
                          throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular StartDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
BeginDate the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFStartDate

@Deprecated
public void setUDFStartDate(ObjectId objId,
                                       BeginDate date)
                     throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular StartDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
date - the StartDate value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFText

@Deprecated
public java.lang.String getUDFText(ObjectId objId)
                            throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Text user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
String the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFText

@Deprecated
public void setUDFText(ObjectId objId,
                                  java.lang.String s)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Text user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
s - the Text value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static java.lang.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 java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getMainFields

public static java.lang.String[] getMainFields()
Gets all fields in the main group for this business object.

Returns:
String[] an array of fields in this group

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.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 java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

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