Primavera Integration API 7.0

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

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

public class ProjectEstimate
extends BusinessObject

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

ProjectEstimate

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

ProjectEstimate

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

ProjectEstimate

public ProjectEstimate(Session session,
                       com.primavera.infr.db.PrmRowSet rowSet,
                       int iIndex)
                throws BusinessObjectException
Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:
session - the Session
rowSet - the PrmRowSet retrieved from the server
iIndex - the row index in the PrmRowSet associated with this business object
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
Method Detail

create

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

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

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

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

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

Overrides:
update in class BOBase
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

update

public static void update(Session session,
                          ProjectEstimate[] projectestimates)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ProjectEstimate objects in the database.

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

Overrides:
delete in class BOBase
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

delete

public static void delete(Session session,
                          ProjectEstimate[] projectestimates)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple ProjectEstimate objects from the database.

Parameters:
session - the Session object
projectestimates - array of ProjectEstimate objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProject

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

Parameters:
fields - fields to load
Returns:
Project the Project object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadWBS

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

Parameters:
fields - fields to load
Returns:
WBS the WBS object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadResource

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

Parameters:
fields - fields to load
Returns:
Resource the Resource object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

getObjectId

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

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system.

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

getResourceObjectId

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

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

setResourceObjectId

public void setResourceObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the associated resource for this project estimate. 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

getWBSObjectId

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

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

setWBSObjectId

public void setWBSObjectId(ObjectId o)
                    throws BusinessObjectException
Sets the unique ID of the associated WBS for this project estimate. 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

getProjectObjectId

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

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

setProjectObjectId

public void setProjectObjectId(ObjectId o)
                        throws BusinessObjectException
Sets the unique ID of the associated project for this project estimate. 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

getAdjustmentFactor

public int getAdjustmentFactor()
                        throws BusinessObjectException
Gets the adjustment, in percent, made to the estimated units before application to the activities.

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

setAdjustmentFactor

public void setAdjustmentFactor(int i)
                         throws BusinessObjectException
Sets the adjustment, in percent, made to the estimated units before application to the activities.

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

getApplied

public boolean getApplied()
                   throws BusinessObjectException
Gets the flag that indicates whether the estimate was applied to the activities. If not set, the estimate was saved to the estimation history but not actually applied.

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

setApplied

public void setApplied(boolean b)
                throws BusinessObjectException
Sets the flag that indicates whether the estimate was applied to the activities. If not set, the estimate was saved to the estimation history but not actually applied.

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

getDate

public java.util.Date getDate()
                       throws BusinessObjectException
Gets the date on which the estimation was made.

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

setDate

public void setDate(java.util.Date d)
             throws BusinessObjectException
Sets the date on which the estimation was made.

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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the project estimate.

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

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the project estimate.

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

getNotes

public java.lang.String getNotes()
                          throws BusinessObjectException
Gets the notes associated with the project estimate. 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 Notes
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setNotes

public void setNotes(java.lang.String s)
              throws BusinessObjectException
Sets the notes associated with the project estimate. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getUnits

public Unit getUnits()
              throws BusinessObjectException
Gets the estimated units, prior to any adjustment, for application to the selected activities.

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

setUnits

public void setUnits(Unit u)
              throws BusinessObjectException
Sets the estimated units, prior to any adjustment, for application to the selected activities.

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

getTotalActivities

public int getTotalActivities()
                       throws BusinessObjectException
Gets the total number of activities involved in the top-down estimation.

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

setTotalActivities

public void setTotalActivities(int i)
                        throws BusinessObjectException
Sets the total number of activities involved in the top-down estimation.

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

getMethod

public EstimateType getMethod()
                       throws BusinessObjectException
Gets the type of estimate: "TopDown" or "UserDefined".

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

setMethod

public void setMethod(EstimateType enm)
               throws BusinessObjectException
Sets the type of estimate: "TopDown" or "UserDefined".

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

getTotalDegreeOfInfluence

public int getTotalDegreeOfInfluence()
                              throws BusinessObjectException
Gets the total degree of influence (TDI), used in top-down function point estimation.

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

setTotalDegreeOfInfluence

public void setTotalDegreeOfInfluence(int i)
                               throws BusinessObjectException
Sets the total degree of influence (TDI), used in top-down function point estimation.

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

getFunctionPointCount

public int getFunctionPointCount()
                          throws BusinessObjectException
Gets the final adjusted function point count, used in top-down function point estimation.

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

setFunctionPointCount

public void setFunctionPointCount(int i)
                           throws BusinessObjectException
Sets the final adjusted function point count, used in top-down function point estimation.

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

getAverageProductivity

public double getAverageProductivity()
                              throws BusinessObjectException
Gets the average productivity in function points per person-month used in top-down function point estimation.

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

setAverageProductivity

public void setAverageProductivity(double d)
                            throws BusinessObjectException
Sets the average productivity in function points per person-month used in top-down function point estimation.

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

getUnadjustedFunctionPointCount

public int getUnadjustedFunctionPointCount()
                                    throws BusinessObjectException
Gets the unadjusted function point count (UFP), used in top-down function point estimation.

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

setUnadjustedFunctionPointCount

public void setUnadjustedFunctionPointCount(int i)
                                     throws BusinessObjectException
Sets the unadjusted function point count (UFP), used in top-down function point estimation.

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

getResourceType

public ResourceType getResourceType()
                             throws BusinessObjectException
Gets the resource type: "Labor", "Nonlabor", or "Material".

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

setResourceType

public void setResourceType(ResourceType enm)
                     throws BusinessObjectException
Sets the resource type: "Labor", "Nonlabor", or "Material".

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

getAdjustedUnits

public Unit getAdjustedUnits()
                      throws BusinessObjectException
Gets the adjusted estimated units required to complete the specified WBS, if an adjustment is applied. If estimating for a specific resource, this value represents the adjusted estimated units required for that resource within the specified WBS element. Calculated as Adjusted Units = (Estimated Units * Adjustment %) + Estimated Units. 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 AdjustedUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getProjectId

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

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

getWBSCode

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

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

getWBSName

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

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

getResourceId

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

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

getResourceName

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

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

getCreateDate

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

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

getLastUpdateDate

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

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

getCreateUser

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

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

getLastUpdateUser

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

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

getRequiredCreateFields

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

Returns:
String[] an array of required create fields

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

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

Returns:
String[] an internal array

getAllFields

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

Returns:
String[] an array of all fields

getInternalAllFields

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

Returns:
String[] an internal array

getInternalAllFieldsSet

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

Returns:
String[] an internal array

getWritableFields

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

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

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

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.String[] getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:
String[] an array of exported fields

toString

public java.lang.String toString()
Returns a string representation of the object. The output is in XML.

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

Primavera Integration API 7.0

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