com.primavera.integration.client.bo.object

Class RiskThresholdLevel

java.lang.Object

com.primavera.integration.client.BOBase

com.primavera.integration.client.bo.BusinessObject

com.primavera.integration.client.bo.object.RiskThresholdLevel

public class RiskThresholdLevel
extends BusinessObject

The risk threshold level object stores the level information (e.g. Low, Medium, High) for each risk threshold.

See Also: Quick reference of RiskThresholdLevel fields

Constructor Summary

Constructors

Constructor and Description
RiskThresholdLevel(Session session) Class constructor specifying the Session.
RiskThresholdLevel(Session session, ObjectId objId) Class constructor specifying the Session and ObjectId of the object.
RiskThresholdLevel(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) Class constructor called internally after objects are retrieved from the server.

Method Summary

Modifier and Type	Method and Description
ObjectId	create() Creates this RiskThresholdLevel object in the database.
static ObjectId[]	create(Session session, RiskThresholdLevel[] riskthresholdlevels) Creates multiple RiskThresholdLevel objects in the database.
void	delete() Deletes this RiskThresholdLevel object from the database.
static void	delete(Session session, RiskThresholdLevel[] riskthresholdlevels) Deletes multiple RiskThresholdLevel objects from the database.
static String[]	getAllFields() Gets all fields for this business object.
String	getCode() Gets the 10 character code for the threshold level.
int	getColor() Gets the Hex representation for the color e.g.
Cost	getCostRange() Gets the cost range of the threshold level.
Date	getCreateDate() Gets the date this threshold level was created.
String	getCreateUser() Gets the name of the user that created the threshold level.
static String[]	getDefaultXMLExportFields() Deprecated.
static String[]	getFilterableFields() Gets all fields that can be filtered.
static String[]	getInternalAllFields() An internal method that should not be called directly by client code.
static Set<String>	getInternalAllFieldsSet() An internal method that should not be called directly by client code.
static String[]	getInternalDefaultLoadFields() An internal method that should not be called directly by client code.
Date	getLastUpdateDate() Gets the date this threshold level was last updated.
String	getLastUpdateUser() Gets the name of the user that last updated the threshold level.
int	getLevel() Gets the valid values are between 0 and 9.
static String[]	getMinimumXMLExportFields() Gets all fields that are always exported at a minimum by the new flat XML exporter
String	getName() Gets the 40 character name for the threshold level.
ObjectId	getObjectId() Gets the unique ID generated by the system.
Percent	getProbabilityRange() Gets the probability range of the threshold level.
String	getRange() Gets the user defined range.
static String[]	getRequiredCreateFields() Gets all fields that must be set before calling create() on this business object.
String	getRiskThresholdName() Gets the name of the associated risk score type.
ObjectId	getRiskThresholdObjectId() Gets the unique ID of the associated Risk Threshold.
Duration	getScheduleRange() Gets the schedule range of the threshold level.
ThresholdType	getThresholdType() Gets the type of Risk Threshold.
int	getToleranceRange() Gets the tolerance range of the threshold level.
static String[]	getWritableFields() Gets all writable fields for this business object.
static RiskThresholdLevel	load(Session session, String[] fields, ObjectId objId) Loads a single RiskThresholdLevel object from the database.
static BOIterator<RiskThresholdLevel>	load(Session session, String[] fields, ObjectId[] objIds) Loads multiple RiskThresholdLevel objects from the database.
BOIterator<RiskImpact>	loadRiskImpacts(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated RiskImpact objects from the database.
BOIterator<RiskResponseActionImpact>	loadRiskResponseActionImpacts(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated RiskResponseActionImpact objects from the database.
RiskThreshold	loadRiskThreshold(String[] fields) Loads an associated RiskThreshold object from the database.
void	setCode(String s) Sets the 10 character code for the threshold level.
void	setColor(int i) Sets the Hex representation for the color e.g.
void	setCostRange(Cost c) Sets the cost range of the threshold level.
void	setLevel(int i) Sets the valid values are between 0 and 9.
void	setName(String s) Sets the 40 character name for the threshold level.
void	setObjectId(ObjectId o) Sets the unique ID generated by the system.
void	setProbabilityRange(Percent p) Sets the probability range of the threshold level.
void	setRange(String s) Sets the user defined range.
void	setRiskThresholdObjectId(ObjectId o) Sets the unique ID of the associated Risk Threshold.
void	setScheduleRange(Duration d) Sets the schedule range of the threshold level.
void	setToleranceRange(int i) Sets the tolerance range of the threshold level.
String	toString() Returns a string representation of the object.
void	update() Updates this RiskThresholdLevel object in the database.
static void	update(Session session, RiskThresholdLevel[] riskthresholdlevels) Updates multiple RiskThresholdLevel objects in the database.

Methods inherited from class com.primavera.integration.client.bo.BusinessObject

equals, getMaxFieldLength, getValue, getValue, hashCode, isNull, setEarlyDate, setNull

Methods inherited from class com.primavera.integration.client.BOBase

combineFields

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RiskThresholdLevel

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

RiskThresholdLevel

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

RiskThresholdLevel

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

loadRiskThreshold

public RiskThreshold loadRiskThreshold(String[] fields)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException

Loads an associated RiskThreshold object from the database.

Parameters:

fields - fields to load

Returns:

RiskThreshold the RiskThreshold 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

loadRiskResponseActionImpacts

public BOIterator<RiskResponseActionImpact> loadRiskResponseActionImpacts(String[] fields,
                                                                          String sWhereClause,
                                                                          String sOrderBy)
                                                                   throws ServerException,
                                                                          NetworkException,
                                                                          BusinessObjectException

Loads multiple associated RiskResponseActionImpact 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

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

getRiskThresholdObjectId

public ObjectId getRiskThresholdObjectId()
                                  throws BusinessObjectException

Gets the unique ID of the associated Risk Threshold. 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 RiskThresholdObjectId

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setRiskThresholdObjectId

public void setRiskThresholdObjectId(ObjectId o)
                              throws BusinessObjectException

Sets the unique ID of the associated Risk Threshold. 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

getRiskThresholdName

public String getRiskThresholdName()
                            throws BusinessObjectException

Gets the name of the associated risk score type.

Returns:

the value in the field RiskThresholdName

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getCode

public String getCode()
               throws BusinessObjectException

Gets the 10 character code for the threshold level. Must be unique. 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 Code

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setCode

public void setCode(String s)
             throws BusinessObjectException

Sets the 10 character code for the threshold level. Must be unique. 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 40 character name for the threshold level. 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 40 character name for the threshold level. 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

getColor

public int getColor()
             throws BusinessObjectException

Gets the Hex representation for the color e.g. 0xFFFFFF.

Returns:

the value in the field Color

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setColor

public void setColor(int i)
              throws BusinessObjectException

Sets the Hex representation for the color e.g. 0xFFFFFF.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getLevel

public int getLevel()
             throws BusinessObjectException

Gets the valid values are between 0 and 9. Defines a level for the Risk Threshold.

Returns:

the value in the field Level

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setLevel

public void setLevel(int i)
              throws BusinessObjectException

Sets the valid values are between 0 and 9. Defines a level for the Risk Threshold.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getRange

public String getRange()
                throws BusinessObjectException

Gets the user defined range.

Returns:

the value in the field Range

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setRange

public void setRange(String s)
              throws BusinessObjectException

Sets the user defined range.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getCostRange

public Cost getCostRange()
                  throws BusinessObjectException

Gets the cost range of the threshold level.

Returns:

the value in the field CostRange

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setCostRange

public void setCostRange(Cost c)
                  throws BusinessObjectException

Sets the cost range of the threshold level.

Parameters:

c - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getScheduleRange

public Duration getScheduleRange()
                          throws BusinessObjectException

Gets the schedule range of the threshold level.

Returns:

the value in the field ScheduleRange

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setScheduleRange

public void setScheduleRange(Duration d)
                      throws BusinessObjectException

Sets the schedule range of the threshold level.

Parameters:

d - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getToleranceRange

public int getToleranceRange()
                      throws BusinessObjectException

Gets the tolerance range of the threshold level.

Returns:

the value in the field ToleranceRange

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setToleranceRange

public void setToleranceRange(int i)
                       throws BusinessObjectException

Sets the tolerance range of the threshold level.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getProbabilityRange

public Percent getProbabilityRange()
                            throws BusinessObjectException

Gets the probability range of the threshold level.

Returns:

the value in the field ProbabilityRange

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setProbabilityRange

public void setProbabilityRange(Percent p)
                         throws BusinessObjectException

Sets the probability range of the threshold level.

Parameters:

p - 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 threshold level 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 threshold level 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 threshold level.

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

Returns:

the value in the field LastUpdateUser

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getThresholdType

public ThresholdType getThresholdType()
                               throws BusinessObjectException

Gets the type of Risk Threshold. Valid types are 'Probability', 'Tolerance', 'Schedule', 'Cost', 'Relative Schedule', 'Relative Cost' and 'User Defined'.

Returns:

the value in the field ThresholdType

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static String[] getRequiredCreateFields()

Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.

Returns:

String[] an array of required create fields

getFilterableFields

public static String[] getFilterableFields()

Gets all fields that can be filtered.

Returns:

String[] an array of filterable fields

getInternalDefaultLoadFields

public static String[] getInternalDefaultLoadFields()

An internal method that should not be called directly by client code.

Returns:

String[] an internal array

getAllFields

public static String[] getAllFields()

Gets all fields for this business object.

Returns:

String[] an array of all fields

getInternalAllFields

public static String[] getInternalAllFields()

An internal method that should not be called directly by client code.

Returns:

String[] an internal array

getInternalAllFieldsSet

public static Set<String> getInternalAllFieldsSet()

An internal method that should not be called directly by client code.

Returns:

String[] an internal array

getWritableFields

public static String[] getWritableFields()

Gets all writable fields for this business object.

Returns:

String[] an array of writable fields

getDefaultXMLExportFields

@Deprecated
public static String[] getDefaultXMLExportFields()

Deprecated.

Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.

Returns:

String[] an array of field names

getMinimumXMLExportFields

public static String[] getMinimumXMLExportFields()

Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:

String[] an array of exported fields

toString

public String toString()

Returns a string representation of the object. The output is in XML.

Overrides:

toString in class Object

Returns:

String a string representation of the object.

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException

Creates this RiskThresholdLevel object in the database.

Returns:

ObjectId the unique ID of the newly created RiskThresholdLevel 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,
                                RiskThresholdLevel[] riskthresholdlevels)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException

Creates multiple RiskThresholdLevel objects in the database.

Parameters:

session - the Session object

riskthresholdlevels - array of RiskThresholdLevel objects to create

Returns:

ObjectId[] the array of unique IDs of newly created RiskThresholdLevel 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 RiskThresholdLevel load(Session session,
                                      String[] fields,
                                      ObjectId objId)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException

Loads a single RiskThresholdLevel object from the database.

Parameters:

session - the Session object

fields - fields to load

objId - unique ID of the RiskThresholdLevel object

Returns:

RiskThresholdLevel the RiskThresholdLevel 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<RiskThresholdLevel> load(Session session,
                                                  String[] fields,
                                                  ObjectId[] objIds)
                                           throws ServerException,
                                                  NetworkException,
                                                  BusinessObjectException

Loads multiple RiskThresholdLevel objects from the database.

Parameters:

session - the Session object

fields - fields to load

objIds - object ids of the RiskThresholdLevel 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 RiskThresholdLevel 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,
                          RiskThresholdLevel[] riskthresholdlevels)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException

Updates multiple RiskThresholdLevel objects in the database.

Parameters:

session - the Session object

riskthresholdlevels - array of RiskThresholdLevel 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 RiskThresholdLevel 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,
                          RiskThresholdLevel[] riskthresholdlevels)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException

Deletes multiple RiskThresholdLevel objects from the database.

Parameters:

session - the Session object

riskthresholdlevels - array of RiskThresholdLevel 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