|
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.ProjectEstimate
public class ProjectEstimate
Project estimates represent the top-down estimate generated for a project. Estimates may only be applied to a project using the Project Management application.
See Also: Quick reference of ProjectEstimate fields
Constructor Summary | |
---|---|
ProjectEstimate(Session session)
Class constructor specifying the Session. |
|
ProjectEstimate(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ProjectEstimate(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 ProjectEstimate object in the database. |
static ObjectId[] |
create(Session session,
ProjectEstimate[] projectestimates)
Creates multiple ProjectEstimate objects in the database. |
void |
delete()
Deletes this ProjectEstimate object from the database. |
static void |
delete(Session session,
ProjectEstimate[] projectestimates)
Deletes multiple ProjectEstimate objects from the database. |
Unit |
getAdjustedUnits()
Gets the adjusted estimated units required to complete the specified WBS, if an adjustment is applied. |
int |
getAdjustmentFactor()
Gets the adjustment, in percent, made to the estimated units before application to the activities. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
boolean |
getApplied()
Gets the flag that indicates whether the estimate was applied to the activities. |
double |
getAverageProductivity()
Gets the average productivity in function points per person-month used in top-down function point estimation. |
java.util.Date |
getCreateDate()
Gets the date this project estimate was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this project estimate. |
java.util.Date |
getDate()
Gets the date on which the estimation was made. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
static java.lang.String[] |
getFilterableFields()
Gets all fields that can be filtered. |
int |
getFunctionPointCount()
Gets the final adjusted function point count, used in top-down function point estimation. |
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 estimate was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this project estimate. |
EstimateType |
getMethod()
Gets the type of estimate: "TopDown" or "UserDefined". |
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 estimate. |
java.lang.String |
getNotes()
Gets the notes associated with the project estimate. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
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 estimate. |
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 estimate. |
ResourceType |
getResourceType()
Gets the resource type: "Labor", "Nonlabor", or "Material". |
int |
getTotalActivities()
Gets the total number of activities involved in the top-down estimation. |
int |
getTotalDegreeOfInfluence()
Gets the total degree of influence (TDI), used in top-down function point estimation. |
int |
getUnadjustedFunctionPointCount()
Gets the unadjusted function point count (UFP), used in top-down function point estimation. |
Unit |
getUnits()
Gets the estimated units, prior to any adjustment, for application to the selected activities. |
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 estimate. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ProjectEstimate |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ProjectEstimate object from the database. |
static BOIterator<ProjectEstimate> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ProjectEstimate objects 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. |
WBS |
loadWBS(java.lang.String[] fields)
Loads an associated WBS object from the database. |
void |
setAdjustmentFactor(int i)
Sets the adjustment, in percent, made to the estimated units before application to the activities. |
void |
setApplied(boolean b)
Sets the flag that indicates whether the estimate was applied to the activities. |
void |
setAverageProductivity(double d)
Sets the average productivity in function points per person-month used in top-down function point estimation. |
void |
setDate(java.util.Date d)
Sets the date on which the estimation was made. |
void |
setFunctionPointCount(int i)
Sets the final adjusted function point count, used in top-down function point estimation. |
void |
setMethod(EstimateType enm)
Sets the type of estimate: "TopDown" or "UserDefined". |
void |
setName(java.lang.String s)
Sets the name of the project estimate. |
void |
setNotes(java.lang.String s)
Sets the notes associated with the project estimate. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setProjectObjectId(ObjectId o)
Sets the unique ID of the associated project for this project estimate. |
void |
setResourceObjectId(ObjectId o)
Sets the unique ID of the associated resource for this project estimate. |
void |
setResourceType(ResourceType enm)
Sets the resource type: "Labor", "Nonlabor", or "Material". |
void |
setTotalActivities(int i)
Sets the total number of activities involved in the top-down estimation. |
void |
setTotalDegreeOfInfluence(int i)
Sets the total degree of influence (TDI), used in top-down function point estimation. |
void |
setUnadjustedFunctionPointCount(int i)
Sets the unadjusted function point count (UFP), used in top-down function point estimation. |
void |
setUnits(Unit u)
Sets the estimated units, prior to any adjustment, for application to the selected activities. |
void |
setWBSObjectId(ObjectId o)
Sets the unique ID of the associated WBS for this project estimate. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ProjectEstimate object in the database. |
static void |
update(Session session,
ProjectEstimate[] projectestimates)
Updates multiple ProjectEstimate 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 ProjectEstimate(Session session)
session
- the Sessionpublic ProjectEstimate(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectEstimate(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, ProjectEstimate[] projectestimates) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectestimates
- array of ProjectEstimate 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 ProjectEstimate load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectEstimate 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<ProjectEstimate> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectEstimate 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, ProjectEstimate[] projectestimates) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectestimates
- array of ProjectEstimate 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, ProjectEstimate[] projectestimates) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectestimates
- array of ProjectEstimate 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 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 Resource loadResource(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 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 getResourceObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResourceObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic 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 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 int getAdjustmentFactor() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setAdjustmentFactor(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getApplied() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setApplied(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDate(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 getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(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 getNotes() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setNotes(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 Unit getUnits() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUnits(Unit u) throws BusinessObjectException
u
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getTotalActivities() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setTotalActivities(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic EstimateType getMethod() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setMethod(EstimateType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getTotalDegreeOfInfluence() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setTotalDegreeOfInfluence(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getFunctionPointCount() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setFunctionPointCount(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getAverageProductivity() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setAverageProductivity(double d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getUnadjustedFunctionPointCount() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUnadjustedFunctionPointCount(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ResourceType getResourceType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResourceType(ResourceType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Unit getAdjustedUnits() 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.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 getResourceId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getResourceName() 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 |