|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ProjectThreshold
public class ProjectThreshold
Project thresholds are used as a project management technique to monitor values within a specified tolerance range so that project issues can be identified and reported. For example, a threshold could be used to monitor Start Date variance or Total Float values.
See Also: Quick reference of ProjectThreshold fields
Constructor Summary | |
---|---|
ProjectThreshold(Session session)
Class constructor specifying the Session. |
|
ProjectThreshold(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ProjectThreshold(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 ProjectThreshold object in the database. |
static ObjectId[] |
create(Session session,
ProjectThreshold[] projectthresholds)
Creates multiple ProjectThreshold objects in the database. |
void |
delete()
Deletes this ProjectThreshold object from the database. |
static void |
delete(Session session,
ProjectThreshold[] projectthresholds)
Deletes multiple ProjectThreshold 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 threshold was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this project threshold. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
ThresholdMonitorDetail |
getDetailToMonitor()
Gets the level of detail to monitor, either Activity or WBS. |
static java.lang.String[] |
getFilterableFields()
Gets all fields that can be filtered. |
java.util.Date |
getFromDate()
Gets the starting custom date of the time window that is monitored against a project threshold. |
java.lang.String |
getFromDateExpression()
Gets the expression for the starting date of the time window that is monitored against a project threshold. |
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. |
IssuePriority |
getIssuePriority()
Gets the priority of any issues generated from the project threshold. |
java.util.Date |
getLastUpdateDate()
Gets the date this project threshold was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this project threshold. |
double |
getLowerThreshold()
Gets the lower value of a project threshold that will trigger an issue. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
ObjectId |
getOBSObjectId()
Gets the unique ID of the associated OBS for this project threshold. |
java.lang.String |
getProjectId()
Gets the Project short code that uniquely identifies the project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project for this project threshold. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
ThresholdStatus |
getStatus()
Gets the current status of the project threshold. |
ObjectId |
getThresholdParameterObjectId()
Gets the unique ID of the associated threshold parameter for this project threshold. |
java.util.Date |
getToDate()
Gets the ending custom date of the time window that is monitored against a project threshold. |
java.lang.String |
getToDateExpression()
Gets the expression for the ending date of the time window that is monitored against a project threshold. |
double |
getUpperThreshold()
Gets the upper value of a project threshold parameter which will trigger an issue. |
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 associated WBS for this project threshold. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ProjectThreshold |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ProjectThreshold object from the database. |
static BOIterator<ProjectThreshold> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ProjectThreshold 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. |
BOIterator<ProjectIssue> |
loadProjectIssues(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ProjectIssue objects from the database. |
ThresholdParameter |
loadThresholdParameter(java.lang.String[] fields)
Loads an associated ThresholdParameter object from the database. |
WBS |
loadWBS(java.lang.String[] fields)
Loads an associated WBS object from the database. |
void |
setDetailToMonitor(ThresholdMonitorDetail enm)
Sets the level of detail to monitor, either Activity or WBS. |
void |
setFromDate(java.util.Date d)
Sets the starting custom date of the time window that is monitored against a project threshold. |
void |
setFromDateExpression(java.lang.String s)
Sets the expression for the starting date of the time window that is monitored against a project threshold. |
void |
setIssuePriority(IssuePriority enm)
Sets the priority of any issues generated from the project threshold. |
void |
setLowerThreshold(double d)
Sets the lower value of a project threshold that will trigger an issue. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setOBSObjectId(ObjectId o)
Sets the unique ID of the associated OBS for this project threshold. |
void |
setProjectObjectId(ObjectId o)
Sets the unique ID of the associated project for this project threshold. |
void |
setStatus(ThresholdStatus enm)
Sets the current status of the project threshold. |
void |
setThresholdParameterObjectId(ObjectId o)
Sets the unique ID of the associated threshold parameter for this project threshold. |
void |
setToDate(java.util.Date d)
Sets the ending custom date of the time window that is monitored against a project threshold. |
void |
setToDateExpression(java.lang.String s)
Sets the expression for the ending date of the time window that is monitored against a project threshold. |
void |
setUpperThreshold(double d)
Sets the upper value of a project threshold parameter which will trigger an issue. |
void |
setWBSObjectId(ObjectId o)
Sets the unique ID of the associated WBS for this project threshold. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ProjectThreshold object in the database. |
static void |
update(Session session,
ProjectThreshold[] projectthresholds)
Updates multiple ProjectThreshold objects in the database. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ProjectThreshold(Session session)
session
- the Sessionpublic ProjectThreshold(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectThreshold(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static ObjectId[] create(Session session, ProjectThreshold[] projectthresholds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectthresholds
- array of ProjectThreshold objects to create
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static ProjectThreshold load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectThreshold object
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static BOIterator<ProjectThreshold> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectThreshold objects
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class BOBase
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static void update(Session session, ProjectThreshold[] projectthresholds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectthresholds
- array of ProjectThreshold objects to update
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static void delete(Session session, ProjectThreshold[] projectthresholds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectthresholds
- array of ProjectThreshold objects to delete
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Project loadProject(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic OBS loadOBS(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic WBS loadWBS(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ThresholdParameter loadThresholdParameter(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic BOIterator<ProjectIssue> loadProjectIssues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getOBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setOBSObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getThresholdParameterObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setThresholdParameterObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ThresholdStatus getStatus() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setStatus(ThresholdStatus enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic IssuePriority getIssuePriority() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIssuePriority(IssuePriority enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ThresholdMonitorDetail getDetailToMonitor() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDetailToMonitor(ThresholdMonitorDetail enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getWBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setWBSObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getLowerThreshold() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setLowerThreshold(double d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getUpperThreshold() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUpperThreshold(double d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getFromDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setFromDate(java.util.Date d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getToDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setToDate(java.util.Date d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getFromDateExpression() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setFromDateExpression(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getToDateExpression() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setToDateExpression(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWBSCode() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWBSName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static java.lang.String[] getRequiredCreateFields()
public static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |