Primavera Integration API Release 8

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

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

public class Risk
extends BusinessObject

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

Risk

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

Risk

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

Risk

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

loadActivityRisks

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

loadProject

public Project loadProject(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

loadResource

public Resource loadResource(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

loadRiskCategory

public RiskCategory loadRiskCategory(String[] fields)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Loads an associated RiskCategory object from the database.

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

loadRiskResponsePlans

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

loadRiskImpacts

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

loadUDFValues

public BOIterator<UDFValue> loadUDFValues(String[] fields,
                                          String sWhereClause,
                                          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

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

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

getProjectId

public String getProjectId()
                    throws BusinessObjectException
Gets the short name of the associated project.

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

getProjectName

public 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

getId

public String getId()
             throws BusinessObjectException
Gets the ID of the Risk. Must be unique within a project. 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 Id
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setId

public void setId(String s)
           throws BusinessObjectException
Sets the ID of the Risk. Must be unique within a project. 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

getName

public String getName()
               throws BusinessObjectException
Gets the name of the Risk. Does not need to be unique.

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. Does not need to be unique.

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

getResponseTotalCost

public Cost getResponseTotalCost()
                          throws BusinessObjectException
Gets the total estimated cost for the risk. If the risk has an associated response plan, the cost is calculated from the risk response actions for the response plan. Not available if user does not have View Project Costs-Financial privilege. 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 ResponseTotalCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setResponseTotalCost

public void setResponseTotalCost(Cost c)
                          throws BusinessObjectException
Sets the total estimated cost for the risk. If the risk has an associated response plan, the cost is calculated from the risk response actions for the response plan. Not available if user does not have View Project Costs-Financial privilege. This field may not be included in the where clause or order by clause specified when loading business objects.

Parameters:
c - the value to set this field to
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. 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. 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

getResourceName

public String getResourceName()
                       throws BusinessObjectException
Gets the name of the resource who owns the Risk. The owner of the Risk is responsible for resolving the Risk.

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

getResourceId

public String getResourceId()
                     throws BusinessObjectException
Gets the ID of the resource who owns the Risk. The owner of the Risk is responsible for resolving the Risk.

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

getRiskCategoryObjectId

public ObjectId getRiskCategoryObjectId()
                                 throws BusinessObjectException
Gets the unique ID of the category to which the Risk is assigned. e.g. Weather, Health, Legal etc. A Risk can only be associated with a single category. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setRiskCategoryObjectId

public void setRiskCategoryObjectId(ObjectId o)
                             throws BusinessObjectException
Sets the unique ID of the category to which the Risk is assigned. e.g. Weather, Health, Legal etc. A Risk can only be associated with a single category. 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

getRiskCategoryName

public String getRiskCategoryName()
                           throws BusinessObjectException
Gets the name of the category to which the Risk is assigned. e.g. Weather, Health, Legal etc. A Risk can only be associated with a single category.

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

getType

public RiskType getType()
                 throws BusinessObjectException
Gets the type of the risk. Valid values are 'Threat' and 'Opportunity'.

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

setType

public void setType(RiskType enm)
             throws BusinessObjectException
Sets the type of the risk. Valid values are 'Threat' and 'Opportunity'.

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 Risk. Valid values are 'Proposed', 'Open', 'Rejected', 'Managed', and 'Impacted'.

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 Risk. Valid values are 'Proposed', 'Open', 'Rejected', 'Managed', and 'Impacted'.

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

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.

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

getEffect

public String getEffect()
                 throws BusinessObjectException
Gets the description of the risks effect on the project.

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

setEffect

public void setEffect(String s)
               throws BusinessObjectException
Sets the description of the risks effect on the project.

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

getCause

public String getCause()
                throws BusinessObjectException
Gets the description of the cause of the Risk.

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

setCause

public void setCause(String s)
              throws BusinessObjectException
Sets the description of the cause of the Risk.

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

getNote

public String getNote()
               throws BusinessObjectException
Gets the comments associated with the Risk.

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

setNote

public void setNote(String s)
             throws BusinessObjectException
Sets the comments associated with the Risk.

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

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.

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

getIsTemplate

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

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

getScore

public int getScore()
             throws BusinessObjectException
Gets the calculated score value of the impact values assigned to the 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 Score
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getScoreText

public String getScoreText()
                    throws BusinessObjectException
Gets the calculated score text value of the impact values assigned to the 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 ScoreText
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getScoreColor

public int getScoreColor()
                  throws BusinessObjectException
Gets the color of the tolerance threshold for the score value. 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 ScoreColor
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

getMainFields

public static 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 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 Risk object in the database.

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

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

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

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the Risk 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 Risk 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,
                          Risk[] risks)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple Risk objects in the database.

Parameters:
session - the Session object
risks - array of Risk 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 Risk 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,
                          Risk[] risks)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple Risk objects from the database.

Parameters:
session - the Session object
risks - array of Risk 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.