Primavera Integration API 7.0

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

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.base.ActivityBase
              extended by com.primavera.integration.client.bo.object.Activity

public class Activity
extends com.primavera.integration.client.bo.base.ActivityBase

An activity is a unit of work performed during the course of a project. It often has activity expenses and resource assignments associated with it. An activity can be subdivided into activity steps.

An activity has a parent WBS object, but WBS objects are not required to have activity children. If an activity is assigned to the root WBS (the project-level), it can be loaded directly from the project using Project.loadProjectLevelActivities().

To obtain an array of all fields exported by the XMLExporter by default, use Activity.getDefaultXMLExportFields(). The default fields for most business objects normally include all fields that are not summary, code, or UDF fields. For Activity business objects, however, the following fields are also not included in the default XML export fields: AtCompletionDuration, IsCritical, RemainingFloat, and DurationVariance. See the XMLExporter documentation for information on how to customize the export process if these fields are needed in the generated XML output.

Activities may be loaded with live spreads using the loadWithLiveSpreads() methods. It is not necessary to have run the Summarizer job service in order to use live activity spreads. After loading, call getActivitySpread() to access the spread data.

This business object supports user defined fields (UDFs) and codes. Use the UDFValue business object to assign UDFs, and the ActivityCodeAssignment business object to assign ActivityCodes.

See Also:   Quick reference of Activity fields


Constructor Summary
Activity(Session session)
          Class constructor specifying the Session.
Activity(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
Activity(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 Activity object in the database.
static ObjectId[] create(Session session, Activity[] activities)
          Creates multiple Activity objects in the database.
 ObjectId createActivityExpense(ActivityExpense activityexpense)
          Creates an associated ActivityExpense object in the database.
 ObjectId[] createActivityExpenses(ActivityExpense[] activityexpenses)
          Creates multiple associated ActivityExpense objects in the database.
 ObjectId createActivityNote(ActivityNote activitynote)
          Creates an associated ActivityNote object in the database.
 ObjectId[] createActivityNotes(ActivityNote[] activitynotes)
          Creates multiple associated ActivityNote objects in the database.
 ObjectId createActivityStep(ActivityStep activitystep)
          Creates an associated ActivityStep object in the database.
 ObjectId[] createActivitySteps(ActivityStep[] activitysteps)
          Creates multiple associated ActivityStep objects in the database.
 ObjectId createCopy(ObjectId projectObjectId, ObjectId wbsObjectId, java.lang.String newId, CopyActivityOptions copyOptions)
          Copies the activity to a project node or a WBS node.
 ObjectId createPredecessorRelationship(Relationship predecessorrelationship)
          Creates an associated Relationship object in the database.
 ObjectId[] createPredecessorRelationships(Relationship[] predecessorrelationships)
          Creates multiple associated Relationship objects in the database.
 ObjectId createProjectDocument(ProjectDocument projectdocument)
          Creates an associated ProjectDocument object in the database.
 ObjectId[] createProjectDocuments(ProjectDocument[] projectdocuments)
          Creates multiple associated ProjectDocument objects in the database.
 ObjectId createProjectIssue(ProjectIssue projectissue)
          Creates an associated ProjectIssue object in the database.
 ObjectId[] createProjectIssues(ProjectIssue[] projectissues)
          Creates multiple associated ProjectIssue objects in the database.
 ObjectId createResourceAssignment(ResourceAssignment resourceassignment)
          Creates an associated ResourceAssignment object in the database.
 ObjectId[] createResourceAssignments(ResourceAssignment[] resourceassignments)
          Creates multiple associated ResourceAssignment objects in the database.
 ObjectId createSuccessorRelationship(Relationship successorrelationship)
          Creates an associated Relationship object in the database.
 ObjectId[] createSuccessorRelationships(Relationship[] successorrelationships)
          Creates multiple associated Relationship objects in the database.
 void delete()
          Deletes this Activity object from the database.
static void delete(Session session, Activity[] activities)
          Deletes multiple Activity objects from the database.
 void deleteActivityExpenses(ActivityExpense[] activityexpenses)
          Deletes multiple associated ActivityExpense objects from the database.
 void deleteActivityNotes(ActivityNote[] activitynotes)
          Deletes multiple associated ActivityNote objects from the database.
 void deleteActivitySteps(ActivityStep[] activitysteps)
          Deletes multiple associated ActivityStep objects from the database.
 void deletePredecessorRelationships(Relationship[] predecessorrelationships)
          Deletes multiple associated Relationship objects from the database.
 void deleteProjectDocuments(ProjectDocument[] projectdocuments)
          Deletes multiple associated ProjectDocument objects from the database.
 void deleteResourceAssignments(ResourceAssignment[] resourceassignments)
          Deletes multiple associated ResourceAssignment objects from the database.
 void deleteSuccessorRelationships(Relationship[] successorrelationships)
          Deletes multiple associated Relationship objects from the database.
 Cost getAccountingVariance()
          Gets the difference between the planned value of work scheduled and the actual cost of work performed.
 Unit getAccountingVarianceLaborUnits()
          Gets the difference between the planned value of work scheduled and the actual work performed.
 ObjectId[] getActivityCodeTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the activity code assignments using the ActivityCodeAssignment object.
 ActivitySpread getActivitySpread()
          Gets the live activity spread data.
 Duration getActualDuration()
          Gets the total working time from the activity actual start date to the actual finish date (for completed activities), or to the current data date (for in-progress activities).
 Cost getActualExpenseCost()
          Gets the actual costs for all project expenses associated with the activity.
 EndDate getActualFinishDate()
          Gets the date on which the activity is actually finished.
 Cost getActualLaborCost()
          Gets the actual costs for all labor resources assigned to the activity.
 Unit getActualLaborUnits()
          Gets the actual units for all labor resources assigned to the activity.
 Cost getActualMaterialCost()
          Gets the sum of all regular and overtime costs for material resources.
 Cost getActualNonLaborCost()
          Gets the actual costs for all nonlabor resources assigned to the activity.
 Unit getActualNonLaborUnits()
          Gets the actual units for all nonlabor resources assigned to the activity.
 BeginDate getActualStartDate()
          Gets the date on which the activity is actually started.
 Cost getActualThisPeriodLaborCost()
          Gets the actual this period labor cost for all labor resources assigned to the activity.
 Unit getActualThisPeriodLaborUnits()
          Gets the actual this period labor units (hours) for all labor resources assigned to the activity.
 Cost getActualThisPeriodMaterialCost()
          Gets the sum of all material resource costs for the current period.
 Cost getActualThisPeriodNonLaborCost()
          Gets the actual this period nonlabor cost for all nonlabor resources assigned to the activity.
 Unit getActualThisPeriodNonLaborUnits()
          Gets the actual this period nonlabor units (hours) for all nonlabor resources assigned to the activity.
 Cost getActualTotalCost()
          Gets the actual total cost for the activity, including labor resources, nonlabor resources, and project expenses.
 Unit getActualTotalUnits()
          Gets the sum of Actual Labor Units and Actual Nonlabor Units.
static java.lang.String[] getAllFields()
          Gets all non-code fields for this business object.
 Duration getAtCompletionDuration()
          Gets the total working time from the activity's current start date to the current finish date.
 Cost getAtCompletionExpenseCost()
          Gets the sum of the actual plus remaining costs for all expenses associated with the activity.
 Cost getAtCompletionLaborCost()
          Gets the sum of the actual plus remaining costs for all labor resources assigned to the activity.
 Unit getAtCompletionLaborUnits()
          Gets the sum of the actual plus remaining units for all labor resources assigned to the activity.
 Unit getAtCompletionLaborUnitsVariance()
          Gets the project baseline planned total labor units minus the estimate at completion labor units.
 Cost getAtCompletionMaterialCost()
          Gets the sum of all actual and remaining costs for material resources.
 Cost getAtCompletionNonLaborCost()
          Gets the sum of the actual plus remaining costs for all nonlabor resources assigned to the activity.
 Unit getAtCompletionNonLaborUnits()
          Gets the sum of the actual plus remaining units for all nonlabor resources assigned to the activity.
 Cost getAtCompletionTotalCost()
          Gets the total cost at completion for the activity, including labor resources, nonlabor resources, and project expenses.
 Unit getAtCompletionTotalUnits()
          Gets the sum of the actual plus remaining units for the resource assignment on the activity.
 Cost getAtCompletionVariance()
          Gets the difference between the project baseline total cost and the current estimate of total cost.
 boolean getAutoComputeActuals()
          Gets the option that determines whether the activity's actual and remaining units, start date, finish date, and percent complete are computed automatically using the planned dates, planned units and the schedule percent complete.
 Duration getBaseline1Duration()
          Gets the duration for the activity in the primary baseline.
 EndDate getBaseline1FinishDate()
          Gets the current finish date of the activity in the primary baseline.
 Duration getBaseline1PlannedDuration()
          Gets the planned duration for the activity in the primary baseline.
 Cost getBaseline1PlannedExpenseCost()
          Gets the planned costs for all project expenses associated with the activity.
 Cost getBaseline1PlannedLaborCost()
          Gets the cost at completion for all labor resources assigned to the activity in the primary baseline.
 Unit getBaseline1PlannedLaborUnits()
          Gets the planned units for all labor resources assigned to the activity.
 Cost getBaseline1PlannedMaterialCost()
          Gets the Planned Material Cost for a primary baseline activity.
 Cost getBaseline1PlannedNonLaborCost()
          Gets the planned costs for all nonlabor resources assigned to the activity.
 Unit getBaseline1PlannedNonLaborUnits()
          Gets the planned units for all nonlabor resources assigned to the activity.
 Cost getBaseline1PlannedTotalCost()
          Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses.
 BeginDate getBaseline1StartDate()
          Gets the current start date of the activity in the primary baseline.
 Duration getBaselineDuration()
          Gets the duration for the activity in the project baseline.
static java.lang.String[] getBaselineFields()
          Gets all fields in the baseline group for this business object.
 EndDate getBaselineFinishDate()
          Gets the current finish date of the activity in the project baseline.
 Duration getBaselinePlannedDuration()
          Gets the planned duration for the activity in the project baseline.
 Cost getBaselinePlannedExpenseCost()
          Gets the planned costs for all project expenses associated with the activity.
 Cost getBaselinePlannedLaborCost()
          Gets the cost at completion for all labor resources assigned to the activity in the project baseline.
 Unit getBaselinePlannedLaborUnits()
          Gets the planned units for all labor resources assigned to the activity.
 Cost getBaselinePlannedMaterialCost()
          Gets the Planned Material Cost for a project baseline activity.
 Cost getBaselinePlannedNonLaborCost()
          Gets the planned costs for all nonlabor resources assigned to the activity.
 Unit getBaselinePlannedNonLaborUnits()
          Gets the planned units for all nonlabor resources assigned to the activity.
 Cost getBaselinePlannedTotalCost()
          Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses.
 BeginDate getBaselineStartDate()
          Gets the current start date of the activity in the project baseline.
 Cost getBudgetAtCompletion()
          Gets the planned total cost through activity completion.
 java.lang.String getCalendarName()
          Gets the name of the calendar.
 ObjectId getCalendarObjectId()
          Gets the unique ID of the calendar assigned to the activity.
 java.lang.String getCodeValue(ObjectId codeTypeObjectId)
          Deprecated. As of release 5.0 SP3, load activity code assignments using the ActivityCodeAssignment business object.
 ObjectId getCodeValueObjectId(ObjectId codeTypeObjectId)
          Deprecated. As of release 5.0 SP3, load activity code assignments using the ActivityCodeAssignment business object.
 Percent getCostPercentComplete()
          Gets the percent complete of costs for all labor resources, nonlabor resources, and expenses for the activity.
 Percent getCostPercentOfPlanned()
          Gets the percent complete of planned costs for all labor resources, nonlabor resources, and expenses for the activity.
 double getCostPerformanceIndex()
          Gets the earned value divided by the actual cost.
 double getCostPerformanceIndexLaborUnits()
          Gets the ratio of the earned value labor units and the actual work performed.
 Cost getCostVariance()
          Gets the difference between the earned value and the actual cost of work performed.
 double getCostVarianceIndex()
          Gets the ratio of the cost variance and the earned value of work performed.
 double getCostVarianceIndexLaborUnits()
          Gets the ratio of the cost variance labor units and the earned value of work performed.
 Unit getCostVarianceLaborUnits()
          Gets the difference between the earned value of labor units and the actual cost of labor units.
 java.util.Date getCreateDate()
          Gets the date this activity was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this activity.
 BeginDate getDataDate()
          Gets the current data date for the project.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 Duration getDuration1Variance()
          Gets the duration between the activity's primary baseline duration and the at complete duration.
 Percent getDurationPercentComplete()
          Gets the percent complete of the activity duration.
 Percent getDurationPercentOfPlanned()
          Gets the activity actual duration percent of planned.
 DurationType getDurationType()
          Gets the duration type of the activity.
 Duration getDurationVariance()
          Gets the duration between the activity's project baseline duration and the at complete duration.
 EndDate getEarlyFinishDate()
          Gets the earliest possible date the activity can finish.
 BeginDate getEarlyStartDate()
          Gets the earliest possible date the remaining work for the activity can begin.
 Cost getEarnedValueCost()
          Gets the portion of the project baseline total cost of the activity that is actually completed as of the project data date.
 Unit getEarnedValueLaborUnits()
          Gets the portion of the project baseline labor units that is actually completed as of the project data date.
 Cost getEstimateAtCompletionCost()
          Gets the estimated cost at completion for the activity.
 Unit getEstimateAtCompletionLaborUnits()
          Gets the estimated labor units at completion of the activity.
 double getEstimatedWeight()
          Gets the estimation weight for the activity, used for top-down estimation.
 Cost getEstimateToComplete()
          Gets the estimated cost to complete the activity.
 Unit getEstimateToCompleteLaborUnits()
          Gets the estimated quantity to complete the activity.
 EndDate getExpectedFinishDate()
          Gets the date the activity is expected to be finished according to the progress made on the activity's work products.
 Cost getExpenseCost1Variance()
          Gets the difference between primary baseline expense cost and at completion expense cost.
 Percent getExpenseCostPercentComplete()
          Gets the percent complete of costs for all expenses associated with the activity.
 Cost getExpenseCostVariance()
          Gets the difference between project baseline expense cost and at completion expense cost.
 BeginDate getExternalEarlyStartDate()
          Gets the date value that determines the early start date for imported activities with external constraints lost (relations from/to external projects that do not exist in the database).
 EndDate getExternalLateFinishDate()
          Gets the date value that determines the Late Finish Date for imported activities with external constraints lost (from/to external projects that do not exist in the database).
 java.lang.String getFeedback()
          Gets the feedback from the resource.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 EndDate getFinishDate()
          Gets the current finish date of the activity.
 Duration getFinishDate1Variance()
          Gets the duration between the finish date in the current project and the primary baseline finish date.
 Duration getFinishDateVariance()
          Gets the duration between the finish date in the current project and the project baseline finish date.
 int getFloatPath()
          Gets the integer representing the critical path this activity is on.
 int getFloatPathOrder()
          Gets the integer representing the order in which this object was found on one of the critical paths.
 Duration getFreeFloat()
          Gets the amount of time the activity can be delayed before delaying the start date of any successor activity.
 java.lang.String getGUID()
          Gets the globally unique ID generated by the system.
 boolean getHasFutureBucketData()
          Gets the flag that indicates whether a resource assignment on the activity has future bucket data.
 java.lang.String getId()
          Gets the short ID that uniquely identifies the activity within the project.
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.
 boolean getIsCritical()
          Gets the flag that indicates whether the activity is critical.
 boolean getIsLongestPath()
          Gets the flag that indicates whether an activity is on the longest path.
 boolean getIsNewFeedback()
          Gets the flag that indicates that a resource has sent feedback notes about this activity which have not been reviewed yet.
 Cost getLaborCost1Variance()
          Gets the difference between primary baseline labor cost and at completion labor cost.
 Percent getLaborCostPercentComplete()
          Gets the percent complete of costs for all labor resources assigned to the activity.
 Cost getLaborCostVariance()
          Gets the difference between project baseline labor cost and at completion labor cost.
 Unit getLaborUnits1Variance()
          Gets the difference between primary baseline labor units and at completion labor units.
 Percent getLaborUnitsPercentComplete()
          Gets the percent complete of units for all labor resources for the activity.
 Unit getLaborUnitsVariance()
          Gets the difference between project baseline labor units and at completion labor units.
 java.util.Date getLastUpdateDate()
          Gets the date this activity was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this activity.
 EndDate getLateFinishDate()
          Gets the latest possible date the activity must finish without delaying the project finish date.
 BeginDate getLateStartDate()
          Gets the latest possible date the remaining work for the activity must begin without delaying the project finish date.
 LevelingPriority getLevelingPriority()
          Gets the activity priority used to prioritize activities in a project when performing resource leveling.
static java.lang.String[] getMainFields()
          Gets all fields in the main group for this business object.
 Cost getMaterialCost1Variance()
          Gets the primary Baseline Planned Material Cost minus the At Completion Material Cost.
 Percent getMaterialCostPercentComplete()
          Gets the percent complete of costs for all material resources assigned to the activity.
 Cost getMaterialCostVariance()
          Gets the project BaselinePlannedMaterialCost minus the AtCompletionMaterialCost.
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 activity.
 Cost getNonLaborCost1Variance()
          Gets the difference between the primary baseline nonlabor cost and at completion nonlabor cost.
 Percent getNonLaborCostPercentComplete()
          Gets the percent complete of costs for all nonlabor resources assigned to the activity.
 Cost getNonLaborCostVariance()
          Gets the difference between the project baseline labor cost and at completion labor cost.
 Unit getNonLaborUnits1Variance()
          Gets the difference between the primary baseline nonlabor units and at completion nonlabor units.
 Percent getNonLaborUnitsPercentComplete()
          Gets the percent complete of units for all nonlabor resources for the activity.
 Unit getNonLaborUnitsVariance()
          Gets the difference between the project baseline labor units and at completion labor units.
 java.lang.String getNotesToResources()
          Gets the notes from the project manager to the timesheet resources.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 Percent getPercentComplete()
          Gets the activity percent complete.
 PercentCompleteType getPercentCompleteType()
          Gets the activity percent complete type: 'Physical', 'Duration', or 'Units'.
 Percent getPerformancePercentComplete()
          Gets the activity performance percent complete.
 Percent getPhysicalPercentComplete()
          Gets the physical percent complete, which can either be user entered or calculated from the activity's weighted steps.
 Duration getPlannedDuration()
          Gets the total working time from the activity planned start date to the planned finish date.
 Cost getPlannedExpenseCost()
          Gets the planned costs for all project expenses associated with the activity.
 EndDate getPlannedFinishDate()
          Gets the date the activity is scheduled to finish.
 Cost getPlannedLaborCost()
          Gets the planned costs for all labor resources assigned to the activity.
 Unit getPlannedLaborUnits()
          Gets the planned units for all labor resources assigned to the activity.
 Cost getPlannedMaterialCost()
          Gets the sum of all material resource costs.
 Cost getPlannedNonLaborCost()
          Gets the planned costs for all nonlabor resources assigned to the activity.
 Unit getPlannedNonLaborUnits()
          Gets the planned units for all nonlabor resources assigned to the activity.
 BeginDate getPlannedStartDate()
          Gets the date the activity is scheduled to begin.
 Cost getPlannedTotalCost()
          Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses.
 Unit getPlannedTotalUnits()
          Gets the sum of Planned Labor Units and Planned Nonlabor Units.
 Cost getPlannedValueCost()
          Gets the portion of the project baseline total cost of the activity that is scheduled to be completed as of the project data date.
 Unit getPlannedValueLaborUnits()
          Gets the portion of the project baseline labor units that is scheduled to be completed as of the project data date.
 java.util.Date getPrimaryConstraintDate()
          Gets the constraint date for the activity, if the activity has a constraint.
 ConstraintType getPrimaryConstraintType()
          Gets the type of constraint applied to the activity start or finish date.
 java.lang.String getPrimaryResourceId()
          Gets the name of the resource.
 java.lang.String getPrimaryResourceName()
          Gets the name of the resource.
 ObjectId getPrimaryResourceObjectId()
          Gets the unique ID of the primary resource for the activity.
 java.lang.String getProjectId()
          Gets the short code of the associated project.
 java.lang.String getProjectName()
          Gets the name of the associated project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
 Duration getRemainingDuration()
          Gets the remaining duration of the activity.
 EndDate getRemainingEarlyFinishDate()
          Gets the remaining late end date, which is calculated by the scheduler.
 BeginDate getRemainingEarlyStartDate()
          Gets the date the remaining work for the activity is scheduled to begin.
 Cost getRemainingExpenseCost()
          Gets the remaining costs for all project expenses associated with the activity.
 Duration getRemainingFloat()
          Gets the amount of time remaining by which the activity can be delayed before delaying the project finish date.
 Cost getRemainingLaborCost()
          Gets the remaining costs for all labor resources assigned to the activity.
 Unit getRemainingLaborUnits()
          Gets the remaining units for all labor resources assigned to the activity.
 EndDate getRemainingLateFinishDate()
          Gets the remaining late finish date calculated by the scheduler.
 BeginDate getRemainingLateStartDate()
          Gets the remaining late start date calculated by the scheduler.
 Cost getRemainingMaterialCost()
          Gets the sum of all material resource remaining costs.
 Cost getRemainingNonLaborCost()
          Gets the remaining costs for all nonlabor resources assigned to the activity.
 Unit getRemainingNonLaborUnits()
          Gets the remaining units for all nonlabor resources assigned to the activity.
 Cost getRemainingTotalCost()
          Gets the remaining total cost for the activity, including labor resources, nonlabor resources, and project expenses.
 Unit getRemainingTotalUnits()
          Gets the sum of Remaining Labor Units and Remaining Nonlabor Units.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 EndDate getResumeDate()
          Gets the date when a suspended task or resource dependent activity should be resumed.
 EndDate getReviewFinishDate()
          Gets the finish date of the activity as proposed by the primary resource using Timesheets, while the activity is in "For Review" state.
 ReviewStatus getReviewStatus()
          Gets the activity review status.
 Percent getSchedulePercentComplete()
          Gets the activity schedule percent complete, which specifies how much of the activity's project baseline duration has been completed so far.
 double getSchedulePerformanceIndex()
          Gets the ratio of the earned value of work performed and the work scheduled to be performed.
 double getSchedulePerformanceIndexLaborUnits()
          Gets the ratio of the earned value of labor units and the planned value of labor units.
 Cost getScheduleVariance()
          Gets the difference between the earned value of work performed and the work scheduled to be performed.
 double getScheduleVarianceIndex()
          Gets the ratio of the schedule variance and the work scheduled to be performed.
 double getScheduleVarianceIndexLaborUnits()
          Gets the ratio of the schedule variance and the work scheduled to be performed.
 Unit getScheduleVarianceLaborUnits()
          Gets the difference between the earned value of work performed and the work scheduled to be performed.
 java.util.Date getSecondaryConstraintDate()
          Gets the date to be used for the cstr_type2 assignment, if the activity has a cstr_type2 value.
 ConstraintType getSecondaryConstraintType()
          Gets the additional constraint to be used by the scheduler.
static java.lang.String[] getSpreadFields()
          Gets all spread fields that can be specified in the spreadFields parameter of loadWithLiveSpread methods for this business object.
 BeginDate getStartDate()
          Gets the start date of the activity.
 Duration getStartDate1Variance()
          Gets the duration between the start date in the current project and the primary baseline start date.
 Duration getStartDateVariance()
          Gets the duration between the start date in the current project and the project baseline start date.
 ActivityStatus getStatus()
          Gets the current status of the activity, either 'Not Started', 'In Progress', or 'Completed'.
 BeginDate getSuspendDate()
          Gets the start date when the progress of a task or resource dependent activity is delayed from.
 double getToCompletePerformanceIndex()
          Gets the TCPI, which is calculated as (budget at completion - earned value) / (estimate at completion - ACWP).
 Cost getTotalCost1Variance()
          Gets the difference between the primary baseline total cost and the at completion total cost.
 Cost getTotalCostVariance()
          Gets the difference between the project baseline total cost and the at completion total cost.
 Duration getTotalFloat()
          Gets the amount of time the activity can be delayed before delaying the project finish date.
 ActivityType getType()
          Gets the type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'.
 Cost getUDFCost(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Double getUDFDouble(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 EndDate getUDFFinishDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 UDFIndicator getUDFIndicator(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Integer getUDFInteger(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 BeginDate getUDFStartDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.String getUDFText(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 ObjectId[] getUDFTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.
 Percent getUnitsPercentComplete()
          Gets the percent complete of units for all labor and nonlabor resources assigned to the activity.
 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 WBS for the activity.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static Activity load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single Activity object from the database.
static BOIterator<Activity> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple Activity objects from the database.
 BOIterator<ActivityCodeAssignment> loadActivityCodeAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityCodeAssignment objects from the database.
 BOIterator<ActivityExpense> loadActivityExpenses(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityExpense objects from the database.
 BOIterator<ActivityNote> loadActivityNotes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityNote objects from the database.
 ActivityOwner loadActivityOwner(java.lang.String[] fields)
          Loads an associated ActivityOwner object from the database.
 BOIterator<ActivityPeriodActual> loadActivityPeriodActuals(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityPeriodActual objects from the database.
 BOIterator<ActivityStep> loadActivitySteps(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityStep objects from the database.
 Calendar loadCalendar(java.lang.String[] fields)
          Loads an associated Calendar object from the database.
 BOIterator<Relationship> loadPredecessorRelationships(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Relationship objects from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 BOIterator<ProjectDocument> loadProjectDocuments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectDocument objects 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.
 BOIterator<ResourceAssignment> loadResourceAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceAssignment objects from the database.
 BOIterator<Relationship> loadSuccessorRelationships(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Relationship objects from the database.
 BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UDFValue objects from the database.
 WBS loadWBS(java.lang.String[] fields)
          Loads an associated WBS object from the database.
static BOIterator<Activity> loadWithLiveSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId[] objIds, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative)
          Loads multiple Activity objects with live spreads from the database.
static Activity loadWithLiveSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId objId, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative)
          Loads a Activity object with live spreads from the database.
 void setActualDuration(Duration d)
          Sets the total working time from the activity actual start date to the actual finish date (for completed activities), or to the current data date (for in-progress activities).
 void setActualFinishDate(EndDate d)
          Sets the date on which the activity is actually finished.
 void setActualLaborCost(Cost c)
          Sets the actual costs for all labor resources assigned to the activity.
 void setActualLaborUnits(Unit u)
          Sets the actual units for all labor resources assigned to the activity.
 void setActualNonLaborCost(Cost c)
          Sets the actual costs for all nonlabor resources assigned to the activity.
 void setActualNonLaborUnits(Unit u)
          Sets the actual units for all nonlabor resources assigned to the activity.
 void setActualStartDate(BeginDate d)
          Sets the date on which the activity is actually started.
 void setActualThisPeriodLaborCost(Cost c)
          Sets the actual this period labor cost for all labor resources assigned to the activity.
 void setActualThisPeriodLaborUnits(Unit u)
          Sets the actual this period labor units (hours) for all labor resources assigned to the activity.
 void setActualThisPeriodNonLaborCost(Cost c)
          Sets the actual this period nonlabor cost for all nonlabor resources assigned to the activity.
 void setActualThisPeriodNonLaborUnits(Unit u)
          Sets the actual this period nonlabor units (hours) for all nonlabor resources assigned to the activity.
 void setAtCompletionDuration(Duration d)
          Sets the total working time from the activity's current start date to the current finish date.
 void setAtCompletionLaborCost(Cost c)
          Sets the sum of the actual plus remaining costs for all labor resources assigned to the activity.
 void setAtCompletionLaborUnits(Unit u)
          Sets the sum of the actual plus remaining units for all labor resources assigned to the activity.
 void setAtCompletionNonLaborCost(Cost c)
          Sets the sum of the actual plus remaining costs for all nonlabor resources assigned to the activity.
 void setAtCompletionNonLaborUnits(Unit u)
          Sets the sum of the actual plus remaining units for all nonlabor resources assigned to the activity.
 void setAutoComputeActuals(boolean b)
          Sets the option that determines whether the activity's actual and remaining units, start date, finish date, and percent complete are computed automatically using the planned dates, planned units and the schedule percent complete.
 void setCalendarObjectId(ObjectId o)
          Sets the unique ID of the calendar assigned to the activity.
 void setCodeValueObjectId(ObjectId codeTypeObjectId, ObjectId codeValueObjectId)
          Deprecated. As of release 5.0 SP3, create or update activity code assignments using the ActivityCodeAssignment business object.
 void setDurationPercentComplete(Percent p)
          Sets the percent complete of the activity duration.
 void setDurationType(DurationType enm)
          Sets the duration type of the activity.
 void setEstimatedWeight(double d)
          Sets the estimation weight for the activity, used for top-down estimation.
 void setExpectedFinishDate(EndDate d)
          Sets the date the activity is expected to be finished according to the progress made on the activity's work products.
 void setExternalEarlyStartDate(BeginDate d)
          Sets the date value that determines the early start date for imported activities with external constraints lost (relations from/to external projects that do not exist in the database).
 void setExternalLateFinishDate(EndDate d)
          Sets the date value that determines the Late Finish Date for imported activities with external constraints lost (from/to external projects that do not exist in the database).
 void setFeedback(java.lang.String s)
          Sets the feedback from the resource.
 void setFinishDate(EndDate d)
          Sets the current finish date of the activity.
 void setGUID(java.lang.String s)
          Sets the globally unique ID generated by the system.
 void setId(java.lang.String s)
          Sets the short ID that uniquely identifies the activity within the project.
 void setIsNewFeedback(boolean b)
          Sets the flag that indicates that a resource has sent feedback notes about this activity which have not been reviewed yet.
 void setLevelingPriority(LevelingPriority enm)
          Sets the activity priority used to prioritize activities in a project when performing resource leveling.
 void setName(java.lang.String s)
          Sets the name of the activity.
 void setNonLaborUnitsPercentComplete(Percent p)
          Sets the percent complete of units for all nonlabor resources for the activity.
 void setNotesToResources(java.lang.String s)
          Sets the notes from the project manager to the timesheet resources.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setPercentComplete(Percent p)
          Sets the activity percent complete.
 void setPercentCompleteType(PercentCompleteType enm)
          Sets the activity percent complete type: 'Physical', 'Duration', or 'Units'.
 void setPhysicalPercentComplete(Percent p)
          Sets the physical percent complete, which can either be user entered or calculated from the activity's weighted steps.
 void setPlannedDuration(Duration d)
          Sets the total working time from the activity planned start date to the planned finish date.
 void setPlannedFinishDate(EndDate d)
          Sets the date the activity is scheduled to finish.
 void setPlannedLaborCost(Cost c)
          Sets the planned costs for all labor resources assigned to the activity.
 void setPlannedLaborUnits(Unit u)
          Sets the planned units for all labor resources assigned to the activity.
 void setPlannedNonLaborCost(Cost c)
          Sets the planned costs for all nonlabor resources assigned to the activity.
 void setPlannedNonLaborUnits(Unit u)
          Sets the planned units for all nonlabor resources assigned to the activity.
 void setPlannedStartDate(BeginDate d)
          Sets the date the activity is scheduled to begin.
 void setPrimaryConstraintDate(java.util.Date d)
          Sets the constraint date for the activity, if the activity has a constraint.
 void setPrimaryConstraintType(ConstraintType enm)
          Sets the type of constraint applied to the activity start or finish date.
 void setPrimaryResourceObjectId(ObjectId o)
          Sets the unique ID of the primary resource for the activity.
 void setProjectObjectId(ObjectId o)
          Sets the unique ID of the associated project.
 void setRemainingDuration(Duration d)
          Sets the remaining duration of the activity.
 void setRemainingEarlyFinishDate(EndDate d)
          Sets the remaining late end date, which is calculated by the scheduler.
 void setRemainingEarlyStartDate(BeginDate d)
          Sets the date the remaining work for the activity is scheduled to begin.
 void setRemainingLaborCost(Cost c)
          Sets the remaining costs for all labor resources assigned to the activity.
 void setRemainingLaborUnits(Unit u)
          Sets the remaining units for all labor resources assigned to the activity.
 void setRemainingLateFinishDate(EndDate d)
          Sets the remaining late finish date calculated by the scheduler.
 void setRemainingLateStartDate(BeginDate d)
          Sets the remaining late start date calculated by the scheduler.
 void setRemainingNonLaborCost(Cost c)
          Sets the remaining costs for all nonlabor resources assigned to the activity.
 void setRemainingNonLaborUnits(Unit u)
          Sets the remaining units for all nonlabor resources assigned to the activity.
 void setResumeDate(EndDate d)
          Sets the date when a suspended task or resource dependent activity should be resumed.
 void setSecondaryConstraintDate(java.util.Date d)
          Sets the date to be used for the cstr_type2 assignment, if the activity has a cstr_type2 value.
 void setSecondaryConstraintType(ConstraintType enm)
          Sets the additional constraint to be used by the scheduler.
 void setStartDate(BeginDate d)
          Sets the start date of the activity.
 void setStatus(ActivityStatus enm)
          Sets the current status of the activity, either 'Not Started', 'In Progress', or 'Completed'.
 void setSuspendDate(BeginDate d)
          Sets the start date when the progress of a task or resource dependent activity is delayed from.
 void setType(ActivityType enm)
          Sets the type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'.
 void setUDFCost(ObjectId objId, Cost cost)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFDouble(ObjectId objId, java.lang.Double n)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFFinishDate(ObjectId objId, EndDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFIndicator(ObjectId objId, UDFIndicator ind)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFInteger(ObjectId objId, java.lang.Integer i)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFStartDate(ObjectId objId, BeginDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFText(ObjectId objId, java.lang.String s)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUnitsPercentComplete(Percent p)
          Sets the percent complete of units for all labor and nonlabor resources assigned to the activity.
 void setWBSObjectId(ObjectId o)
          Sets the unique ID of the WBS for the activity.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this Activity object in the database.
static void update(Session session, Activity[] activities)
          Updates multiple Activity objects in the database.
 void updateActivityExpenses(ActivityExpense[] activityexpenses)
          Updates multiple associated ActivityExpense objects in the database.
 void updateActivityNotes(ActivityNote[] activitynotes)
          Updates multiple associated ActivityNote objects in the database.
 void updateActivitySteps(ActivityStep[] activitysteps)
          Updates multiple associated ActivityStep objects in the database.
 void updatePredecessorRelationships(Relationship[] predecessorrelationships)
          Updates multiple associated Relationship objects in the database.
 void updateProjectDocuments(ProjectDocument[] projectdocuments)
          Updates multiple associated ProjectDocument objects in the database.
 void updateResourceAssignments(ResourceAssignment[] resourceassignments)
          Updates multiple associated ResourceAssignment objects in the database.
 void updateSuccessorRelationships(Relationship[] successorrelationships)
          Updates multiple associated Relationship 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

Activity

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

Activity

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

Activity

public Activity(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 Activity object in the database.

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

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

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the Activity object
Returns:
Activity the Activity 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

loadWithLiveSpread

public static Activity loadWithLiveSpread(Session session,
                                          java.lang.String[] nonSpreadFields,
                                          ObjectId objId,
                                          java.lang.String[] spreadFields,
                                          SpreadPeriodType periodType,
                                          java.util.Date startDate,
                                          java.util.Date endDate,
                                          boolean bIncludeCumulative)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Loads a Activity object with live spreads from the database.

Parameters:
nonSpreadFields - fields to load
objId - unique ID of the Activity object
spreadFields - the fields to include in the spread object
periodType - the period of the spread data (hour, day, etc.)
startDate - the start date of the spread
endDate - the end date of the spread
bIncludeCumulative - indicates whether to include cumulative spread data
Returns:
Activity the Activity 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<Activity> load(Session session,
                                        java.lang.String[] fields,
                                        ObjectId[] objIds)
                                 throws ServerException,
                                        NetworkException,
                                        BusinessObjectException
Loads multiple Activity objects from the database.

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

loadWithLiveSpread

public static BOIterator<Activity> loadWithLiveSpread(Session session,
                                                      java.lang.String[] nonSpreadFields,
                                                      ObjectId[] objIds,
                                                      java.lang.String[] spreadFields,
                                                      SpreadPeriodType periodType,
                                                      java.util.Date startDate,
                                                      java.util.Date endDate,
                                                      boolean bIncludeCumulative)
                                               throws ServerException,
                                                      NetworkException,
                                                      BusinessObjectException
Loads multiple Activity objects with live spreads from the database.

Parameters:
nonSpreadFields - fields to load
objIds - object ids of the Activity objects
spreadFields - the fields to include in the spread object
periodType - the period of the spread data (hour, day, etc.)
startDate - the start date of the spread
endDate - the end date of the spread
bIncludeCumulative - indicates whether to include cumulative spread data
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 Activity 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,
                          Activity[] activities)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple Activity objects in the database.

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

Parameters:
session - the Session object
activities - array of Activity 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

createResourceAssignment

public ObjectId createResourceAssignment(ResourceAssignment resourceassignment)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Creates an associated ResourceAssignment object in the database.

Parameters:
resourceassignment - ResourceAssignment object to create
Returns:
ObjectId unique ID of the newly created ResourceAssignment 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

createResourceAssignments

public ObjectId[] createResourceAssignments(ResourceAssignment[] resourceassignments)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Creates multiple associated ResourceAssignment objects in the database.

Parameters:
resourceassignments - array of ResourceAssignment objects to create
Returns:
ObjectId[] array of object ids of newly created ResourceAssignment 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

loadResourceAssignments

public BOIterator<ResourceAssignment> loadResourceAssignments(java.lang.String[] fields,
                                                              java.lang.String sWhereClause,
                                                              java.lang.String sOrderBy)
                                                       throws ServerException,
                                                              NetworkException,
                                                              BusinessObjectException
Loads multiple associated ResourceAssignment 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

updateResourceAssignments

public void updateResourceAssignments(ResourceAssignment[] resourceassignments)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Updates multiple associated ResourceAssignment objects in the database.

Parameters:
resourceassignments - array of ResourceAssignment 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

deleteResourceAssignments

public void deleteResourceAssignments(ResourceAssignment[] resourceassignments)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Deletes multiple associated ResourceAssignment objects from the database.

Parameters:
resourceassignments - array of ResourceAssignment 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

createActivityExpense

public ObjectId createActivityExpense(ActivityExpense activityexpense)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Creates an associated ActivityExpense object in the database.

Parameters:
activityexpense - ActivityExpense object to create
Returns:
ObjectId unique ID of the newly created ActivityExpense 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

createActivityExpenses

public ObjectId[] createActivityExpenses(ActivityExpense[] activityexpenses)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Creates multiple associated ActivityExpense objects in the database.

Parameters:
activityexpenses - array of ActivityExpense objects to create
Returns:
ObjectId[] array of object ids of newly created ActivityExpense 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

loadActivityExpenses

public BOIterator<ActivityExpense> loadActivityExpenses(java.lang.String[] fields,
                                                        java.lang.String sWhereClause,
                                                        java.lang.String sOrderBy)
                                                 throws ServerException,
                                                        NetworkException,
                                                        BusinessObjectException
Loads multiple associated ActivityExpense 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

updateActivityExpenses

public void updateActivityExpenses(ActivityExpense[] activityexpenses)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Updates multiple associated ActivityExpense objects in the database.

Parameters:
activityexpenses - array of ActivityExpense 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

deleteActivityExpenses

public void deleteActivityExpenses(ActivityExpense[] activityexpenses)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Deletes multiple associated ActivityExpense objects from the database.

Parameters:
activityexpenses - array of ActivityExpense 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

createActivityNote

public ObjectId createActivityNote(ActivityNote activitynote)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Creates an associated ActivityNote object in the database.

Parameters:
activitynote - ActivityNote object to create
Returns:
ObjectId unique ID of the newly created ActivityNote 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

createActivityNotes

public ObjectId[] createActivityNotes(ActivityNote[] activitynotes)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Creates multiple associated ActivityNote objects in the database.

Parameters:
activitynotes - array of ActivityNote objects to create
Returns:
ObjectId[] array of object ids of newly created ActivityNote 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

loadActivityNotes

public BOIterator<ActivityNote> loadActivityNotes(java.lang.String[] fields,
                                                  java.lang.String sWhereClause,
                                                  java.lang.String sOrderBy)
                                           throws ServerException,
                                                  NetworkException,
                                                  BusinessObjectException
Loads multiple associated ActivityNote 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

updateActivityNotes

public void updateActivityNotes(ActivityNote[] activitynotes)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Updates multiple associated ActivityNote objects in the database.

Parameters:
activitynotes - array of ActivityNote 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

deleteActivityNotes

public void deleteActivityNotes(ActivityNote[] activitynotes)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Deletes multiple associated ActivityNote objects from the database.

Parameters:
activitynotes - array of ActivityNote 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

createActivityStep

public ObjectId createActivityStep(ActivityStep activitystep)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Creates an associated ActivityStep object in the database.

Parameters:
activitystep - ActivityStep object to create
Returns:
ObjectId unique ID of the newly created ActivityStep 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

createActivitySteps

public ObjectId[] createActivitySteps(ActivityStep[] activitysteps)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Creates multiple associated ActivityStep objects in the database.

Parameters:
activitysteps - array of ActivityStep objects to create
Returns:
ObjectId[] array of object ids of newly created ActivityStep 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

loadActivitySteps

public BOIterator<ActivityStep> loadActivitySteps(java.lang.String[] fields,
                                                  java.lang.String sWhereClause,
                                                  java.lang.String sOrderBy)
                                           throws ServerException,
                                                  NetworkException,
                                                  BusinessObjectException
Loads multiple associated ActivityStep 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

updateActivitySteps

public void updateActivitySteps(ActivityStep[] activitysteps)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Updates multiple associated ActivityStep objects in the database.

Parameters:
activitysteps - array of ActivityStep 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

deleteActivitySteps

public void deleteActivitySteps(ActivityStep[] activitysteps)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Deletes multiple associated ActivityStep objects from the database.

Parameters:
activitysteps - array of ActivityStep 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

loadActivityPeriodActuals

public BOIterator<ActivityPeriodActual> loadActivityPeriodActuals(java.lang.String[] fields,
                                                                  java.lang.String sWhereClause,
                                                                  java.lang.String sOrderBy)
                                                           throws ServerException,
                                                                  NetworkException,
                                                                  BusinessObjectException
Loads multiple associated ActivityPeriodActual 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

createProjectDocument

public ObjectId createProjectDocument(ProjectDocument projectdocument)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Creates an associated ProjectDocument object in the database.

Parameters:
projectdocument - ProjectDocument object to create
Returns:
ObjectId unique ID of the newly created ProjectDocument 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

createProjectDocuments

public ObjectId[] createProjectDocuments(ProjectDocument[] projectdocuments)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Creates multiple associated ProjectDocument objects in the database.

Parameters:
projectdocuments - array of ProjectDocument objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectDocument 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

loadProjectDocuments

public BOIterator<ProjectDocument> loadProjectDocuments(java.lang.String[] fields,
                                                        java.lang.String sWhereClause,
                                                        java.lang.String sOrderBy)
                                                 throws ServerException,
                                                        NetworkException,
                                                        BusinessObjectException
Loads multiple associated ProjectDocument 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

updateProjectDocuments

public void updateProjectDocuments(ProjectDocument[] projectdocuments)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Updates multiple associated ProjectDocument objects in the database.

Parameters:
projectdocuments - array of ProjectDocument 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

deleteProjectDocuments

public void deleteProjectDocuments(ProjectDocument[] projectdocuments)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Deletes multiple associated ProjectDocument objects from the database.

Parameters:
projectdocuments - array of ProjectDocument 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

createPredecessorRelationship

public ObjectId createPredecessorRelationship(Relationship predecessorrelationship)
                                       throws ServerException,
                                              NetworkException,
                                              BusinessObjectException
Creates an associated Relationship object in the database.

Parameters:
predecessorrelationship - PredecessorRelationship object to create
Returns:
ObjectId unique ID of the newly created Relationship 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

createPredecessorRelationships

public ObjectId[] createPredecessorRelationships(Relationship[] predecessorrelationships)
                                          throws ServerException,
                                                 NetworkException,
                                                 BusinessObjectException
Creates multiple associated Relationship objects in the database.

Parameters:
predecessorrelationships - array of PredecessorRelationship objects to create
Returns:
ObjectId[] array of object ids of newly created Relationship 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

loadPredecessorRelationships

public BOIterator<Relationship> loadPredecessorRelationships(java.lang.String[] fields,
                                                             java.lang.String sWhereClause,
                                                             java.lang.String sOrderBy)
                                                      throws ServerException,
                                                             NetworkException,
                                                             BusinessObjectException
Loads multiple associated Relationship 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

updatePredecessorRelationships

public void updatePredecessorRelationships(Relationship[] predecessorrelationships)
                                    throws ServerException,
                                           NetworkException,
                                           BusinessObjectException
Updates multiple associated Relationship objects in the database.

Parameters:
predecessorrelationships - array of Relationship 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

deletePredecessorRelationships

public void deletePredecessorRelationships(Relationship[] predecessorrelationships)
                                    throws ServerException,
                                           NetworkException,
                                           BusinessObjectException
Deletes multiple associated Relationship objects from the database.

Parameters:
predecessorrelationships - array of Relationship 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

createSuccessorRelationship

public ObjectId createSuccessorRelationship(Relationship successorrelationship)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Creates an associated Relationship object in the database.

Parameters:
successorrelationship - SuccessorRelationship object to create
Returns:
ObjectId unique ID of the newly created Relationship 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

createSuccessorRelationships

public ObjectId[] createSuccessorRelationships(Relationship[] successorrelationships)
                                        throws ServerException,
                                               NetworkException,
                                               BusinessObjectException
Creates multiple associated Relationship objects in the database.

Parameters:
successorrelationships - array of SuccessorRelationship objects to create
Returns:
ObjectId[] array of object ids of newly created Relationship 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

loadSuccessorRelationships

public BOIterator<Relationship> loadSuccessorRelationships(java.lang.String[] fields,
                                                           java.lang.String sWhereClause,
                                                           java.lang.String sOrderBy)
                                                    throws ServerException,
                                                           NetworkException,
                                                           BusinessObjectException
Loads multiple associated Relationship 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

updateSuccessorRelationships

public void updateSuccessorRelationships(Relationship[] successorrelationships)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Updates multiple associated Relationship objects in the database.

Parameters:
successorrelationships - array of Relationship 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

deleteSuccessorRelationships

public void deleteSuccessorRelationships(Relationship[] successorrelationships)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Deletes multiple associated Relationship objects from the database.

Parameters:
successorrelationships - array of Relationship 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

loadCalendar

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

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

loadActivityOwner

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

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

createProjectIssue

public ObjectId createProjectIssue(ProjectIssue projectissue)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Creates an associated ProjectIssue object in the database.

Parameters:
projectissue - ProjectIssue object to create
Returns:
ObjectId unique ID of the newly created ProjectIssue 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

createProjectIssues

public ObjectId[] createProjectIssues(ProjectIssue[] projectissues)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Creates multiple associated ProjectIssue objects in the database.

Parameters:
projectissues - array of ProjectIssue objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectIssue 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

loadProjectIssues

public BOIterator<ProjectIssue> loadProjectIssues(java.lang.String[] fields,
                                                  java.lang.String sWhereClause,
                                                  java.lang.String sOrderBy)
                                           throws ServerException,
                                                  NetworkException,
                                                  BusinessObjectException
Loads multiple associated ProjectIssue 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

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

loadActivityCodeAssignments

public BOIterator<ActivityCodeAssignment> loadActivityCodeAssignments(java.lang.String[] fields,
                                                                      java.lang.String sWhereClause,
                                                                      java.lang.String sOrderBy)
                                                               throws ServerException,
                                                                      NetworkException,
                                                                      BusinessObjectException
Loads multiple associated ActivityCodeAssignment objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadUDFValues

public BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields,
                                          java.lang.String sWhereClause,
                                          java.lang.String sOrderBy)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Loads multiple associated UDFValue objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

setCodeValueObjectId

@Deprecated
public void setCodeValueObjectId(ObjectId codeTypeObjectId,
                                            ObjectId codeValueObjectId)
                          throws BusinessObjectException
Deprecated. As of release 5.0 SP3, create or update activity code assignments using the ActivityCodeAssignment business object.

Assigns or changes the assignment of an ActivityCode to this Activity.

Parameters:
codeTypeObjectId - unique ID of the ActivityCodeType
codeValueObjectId - unique ID of the ActivityCode
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCodeValueObjectId

@Deprecated
public ObjectId getCodeValueObjectId(ObjectId codeTypeObjectId)
                              throws BusinessObjectException
Deprecated. As of release 5.0 SP3, load activity code assignments using the ActivityCodeAssignment business object.

Gets the unique ID of an ActivityCode that is assigned to this Activity.

Parameters:
codeTypeObjectId - unique ID of an ActivityCodeType
Returns:
unique ID of the ActivityCode
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCodeValue

@Deprecated
public java.lang.String getCodeValue(ObjectId codeTypeObjectId)
                              throws BusinessObjectException
Deprecated. As of release 5.0 SP3, load activity code assignments using the ActivityCodeAssignment business object.

Gets the name of an ActivityCode that is assigned to this Activity.

Parameters:
codeTypeObjectId - unique ID of an ActivityCodeType
Returns:
name of ActivityCode
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActivityCodeTypesAssigned

@Deprecated
public ObjectId[] getActivityCodeTypesAssigned()
                                        throws BusinessObjectException
Deprecated. As of release 5.0 SP3, determine the activity code assignments using the ActivityCodeAssignment object.

Gets the ObjectIds of all ActivityCodeTypes for which ActivityCodes are assigned to this Activity.

Overrides:
getActivityCodeTypesAssigned in class com.primavera.integration.client.bo.base.ActivityBase
Returns:
ObjectId array of ActivityCodeType
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFTypesAssigned

@Deprecated
public ObjectId[] getUDFTypesAssigned()
                               throws BusinessObjectException
Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.

Gets the ObjectIds of all UDFTypes for which UDFs are assigned to this Activity.

Overrides:
getUDFTypesAssigned in class com.primavera.integration.client.bo.base.ActivityBase
Returns:
ObjectId array of UDFType
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

createCopy

public ObjectId createCopy(ObjectId projectObjectId,
                           ObjectId wbsObjectId,
                           java.lang.String newId,
                           CopyActivityOptions copyOptions)
                    throws BusinessObjectException,
                           ServerException,
                           NetworkException
Copies the activity to a project node or a WBS node. The WBS node can be in the current project or in a different project. If both project ObjectId and WBS ObjectId are specified, WBS ObjectId will take precedence.

Overrides:
createCopy in class com.primavera.integration.client.bo.base.ActivityBase
Parameters:
projectObjectId - the ObjectId of the project where the activity will be copied to.
wbsObjectId - the ObjectId of the WBS where the activity will be copied to.
newId - the Id for the newly copied activity. If null a default Id will be assigned.
copyOptions - the copy activity options. If null, the default options will be used
Returns:
ObjectId unique identifier for the activity that was created.
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer

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

getWBSObjectId

public ObjectId getWBSObjectId()
                        throws BusinessObjectException
Gets the unique ID of the WBS for the activity. 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 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 WBS for the activity. 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

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

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

getProjectObjectId

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

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

setProjectObjectId

public void setProjectObjectId(ObjectId o)
                        throws BusinessObjectException
Sets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getProjectId

public java.lang.String getProjectId()
                              throws BusinessObjectException
Gets the short code of the associated project.

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

getProjectName

public java.lang.String getProjectName()
                                throws BusinessObjectException
Gets the name of the associated project.

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

getCalendarObjectId

public ObjectId getCalendarObjectId()
                             throws BusinessObjectException
Gets the unique ID of the calendar assigned to the activity. Activity calendars can be assigned from the global calendar pool or the project calendar pool. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setCalendarObjectId

public void setCalendarObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the calendar assigned to the activity. Activity calendars can be assigned from the global calendar pool or the project calendar pool. 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

getCalendarName

public java.lang.String getCalendarName()
                                 throws BusinessObjectException
Gets the name of the calendar.

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

getPrimaryResourceObjectId

public ObjectId getPrimaryResourceObjectId()
                                    throws BusinessObjectException
Gets the unique ID of the primary resource for the activity. The primary resource is responsible for the overall work on the activity and updates the activity status using Timesheets.

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

setPrimaryResourceObjectId

public void setPrimaryResourceObjectId(ObjectId o)
                                throws BusinessObjectException
Sets the unique ID of the primary resource for the activity. The primary resource is responsible for the overall work on the activity and updates the activity status using Timesheets.

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

getPrimaryResourceName

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

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

getPrimaryResourceId

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

Returns:
the value in the field PrimaryResourceId
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 activity. The activity name does not have 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(java.lang.String s)
             throws BusinessObjectException
Sets the name of the activity. The activity name does not have to be unique.

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

getType

public ActivityType getType()
                     throws BusinessObjectException
Gets the type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. A 'Task Dependent' activity is scheduled using the activity's calendar rather than the calendars of the assigned resources. A 'Resource Dependent' activity is scheduled using the calendars of the assigned resources. This type is used when several resources are assigned to the activity, but they may work separately. A 'Milestone' is a zero-duration activity without resources, marking a significant project event. A 'Level of Effort' activity has a duration that is determined by its dependent activities. Administration-type activities are typically 'Level of Effort'.

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

setType

public void setType(ActivityType enm)
             throws BusinessObjectException
Sets the type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. A 'Task Dependent' activity is scheduled using the activity's calendar rather than the calendars of the assigned resources. A 'Resource Dependent' activity is scheduled using the calendars of the assigned resources. This type is used when several resources are assigned to the activity, but they may work separately. A 'Milestone' is a zero-duration activity without resources, marking a significant project event. A 'Level of Effort' activity has a duration that is determined by its dependent activities. Administration-type activities are typically 'Level of Effort'.

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

getId

public java.lang.String getId()
                       throws BusinessObjectException
Gets the short ID that uniquely identifies the activity within the project.

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

setId

public void setId(java.lang.String s)
           throws BusinessObjectException
Sets the short ID that uniquely identifies the activity within the project.

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

getEstimatedWeight

public double getEstimatedWeight()
                          throws BusinessObjectException
Gets the estimation weight for the activity, used for top-down estimation. Top-down estimation weights are used to calculate the proportion of units that each activity receives in relation to the other activities within the same WBS. Top-down estimation distributes estimated units in a top-down manner to activities using the WBS hierarchy.

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

setEstimatedWeight

public void setEstimatedWeight(double d)
                        throws BusinessObjectException
Sets the estimation weight for the activity, used for top-down estimation. Top-down estimation weights are used to calculate the proportion of units that each activity receives in relation to the other activities within the same WBS. Top-down estimation distributes estimated units in a top-down manner to activities using the WBS hierarchy.

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

getAutoComputeActuals

public boolean getAutoComputeActuals()
                              throws BusinessObjectException
Gets the option that determines whether the activity's actual and remaining units, start date, finish date, and percent complete are computed automatically using the planned dates, planned units and the schedule percent complete. If this option is selected, the actual/remaining units and actual dates are automatically updated when project actuals are applied. Use this option to assume that all work for the activity proceeds according to plan.

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

setAutoComputeActuals

public void setAutoComputeActuals(boolean b)
                           throws BusinessObjectException
Sets the option that determines whether the activity's actual and remaining units, start date, finish date, and percent complete are computed automatically using the planned dates, planned units and the schedule percent complete. If this option is selected, the actual/remaining units and actual dates are automatically updated when project actuals are applied. Use this option to assume that all work for the activity proceeds according to plan.

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

getLevelingPriority

public LevelingPriority getLevelingPriority()
                                     throws BusinessObjectException
Gets the activity priority used to prioritize activities in a project when performing resource leveling. Valid values are 'Top', 'High', 'Normal', 'Low', and 'Lowest'.

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

setLevelingPriority

public void setLevelingPriority(LevelingPriority enm)
                         throws BusinessObjectException
Sets the activity priority used to prioritize activities in a project when performing resource leveling. Valid values are 'Top', 'High', 'Normal', 'Low', and 'Lowest'.

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

getReviewStatus

public ReviewStatus getReviewStatus()
                             throws BusinessObjectException
Gets the activity review status. Valid values are 'OK', 'For Review', and 'Rejected'. Primary resources set the status to 'For Review' when they believe the activity is completed but are not allowed to mark activities as completed.

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

getReviewFinishDate

public EndDate getReviewFinishDate()
                            throws BusinessObjectException
Gets the finish date of the activity as proposed by the primary resource using Timesheets, while the activity is in "For Review" state. If the project manager approves the activity completion, the review finish is copied to the actual finish.

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

getIsNewFeedback

public boolean getIsNewFeedback()
                         throws BusinessObjectException
Gets the flag that indicates that a resource has sent feedback notes about this activity which have not been reviewed yet.

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

setIsNewFeedback

public void setIsNewFeedback(boolean b)
                      throws BusinessObjectException
Sets the flag that indicates that a resource has sent feedback notes about this activity which have not been reviewed yet.

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

getDataDate

public BeginDate getDataDate()
                      throws BusinessObjectException
Gets the current data date for the project. The project status is up to date as of the data date. The data date is modified when project actuals are applied. 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 DataDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getHasFutureBucketData

public boolean getHasFutureBucketData()
                               throws BusinessObjectException
Gets the flag that indicates whether a resource assignment on the activity has future bucket data. 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 HasFutureBucketData
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getPlannedStartDate

public BeginDate getPlannedStartDate()
                              throws BusinessObjectException
Gets the date the activity is scheduled to begin. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started.

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

setPlannedStartDate

public void setPlannedStartDate(BeginDate d)
                         throws BusinessObjectException
Sets the date the activity is scheduled to begin. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started.

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

getPlannedFinishDate

public EndDate getPlannedFinishDate()
                             throws BusinessObjectException
Gets the date the activity is scheduled to finish. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started.

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

setPlannedFinishDate

public void setPlannedFinishDate(EndDate d)
                          throws BusinessObjectException
Sets the date the activity is scheduled to finish. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started.

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

getPlannedDuration

public Duration getPlannedDuration()
                            throws BusinessObjectException
Gets the total working time from the activity planned start date to the planned finish date. The planned working time is computed using the activity's calendar. This field is named OriginalDuration in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

setPlannedDuration

public void setPlannedDuration(Duration d)
                        throws BusinessObjectException
Sets the total working time from the activity planned start date to the planned finish date. The planned working time is computed using the activity's calendar. This field is named OriginalDuration in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

getPlannedLaborUnits

public Unit getPlannedLaborUnits()
                          throws BusinessObjectException
Gets the planned units for all labor resources assigned to the activity. This field is named BudgetedLaborUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

setPlannedLaborUnits

public void setPlannedLaborUnits(Unit u)
                          throws BusinessObjectException
Sets the planned units for all labor resources assigned to the activity. This field is named BudgetedLaborUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

getPlannedNonLaborUnits

public Unit getPlannedNonLaborUnits()
                             throws BusinessObjectException
Gets the planned units for all nonlabor resources assigned to the activity. This field is named BudgetedNonLaborUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

setPlannedNonLaborUnits

public void setPlannedNonLaborUnits(Unit u)
                             throws BusinessObjectException
Sets the planned units for all nonlabor resources assigned to the activity. This field is named BudgetedNonLaborUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

getPlannedTotalUnits

public Unit getPlannedTotalUnits()
                          throws BusinessObjectException
Gets the sum of Planned Labor Units and Planned Nonlabor Units. This field is named BudgetedTotalUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 PlannedTotalUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getPlannedLaborCost

public Cost getPlannedLaborCost()
                         throws BusinessObjectException
Gets the planned costs for all labor resources assigned to the activity. If no resources are assigned, computed as the activity planned labor units * project default price / time. This field is named BudgetedLaborCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 PlannedLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setPlannedLaborCost

public void setPlannedLaborCost(Cost c)
                         throws BusinessObjectException
Sets the planned costs for all labor resources assigned to the activity. If no resources are assigned, computed as the activity planned labor units * project default price / time. This field is named BudgetedLaborCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getPlannedNonLaborCost

public Cost getPlannedNonLaborCost()
                            throws BusinessObjectException
Gets the planned costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity planned nonlabor units * project default price / time. This field is named BudgetedNonLaborCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 PlannedNonLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setPlannedNonLaborCost

public void setPlannedNonLaborCost(Cost c)
                            throws BusinessObjectException
Sets the planned costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity planned nonlabor units * project default price / time. This field is named BudgetedNonLaborCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getPlannedMaterialCost

public Cost getPlannedMaterialCost()
                            throws BusinessObjectException
Gets the sum of all material resource costs. 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 PlannedMaterialCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getPlannedTotalCost

public Cost getPlannedTotalCost()
                         throws BusinessObjectException
Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses. Planned total cost = planned labor cost + planned nonlabor cost + planned expense cost. This field is named BudgetedTotalCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 PlannedTotalCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActualStartDate

public BeginDate getActualStartDate()
                             throws BusinessObjectException
Gets the date on which the activity is actually started.

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

setActualStartDate

public void setActualStartDate(BeginDate d)
                        throws BusinessObjectException
Sets the date on which the activity is actually started.

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

getActualFinishDate

public EndDate getActualFinishDate()
                            throws BusinessObjectException
Gets the date on which the activity is actually finished.

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

setActualFinishDate

public void setActualFinishDate(EndDate d)
                         throws BusinessObjectException
Sets the date on which the activity is actually finished.

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

getActualDuration

public Duration getActualDuration()
                           throws BusinessObjectException
Gets the total working time from the activity actual start date to the actual finish date (for completed activities), or to the current data date (for in-progress activities). The actual working time is computed using the activity's calendar. 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 ActualDuration
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setActualDuration

public void setActualDuration(Duration d)
                       throws BusinessObjectException
Sets the total working time from the activity actual start date to the actual finish date (for completed activities), or to the current data date (for in-progress activities). The actual working time is computed using the activity's calendar. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getActualLaborUnits

public Unit getActualLaborUnits()
                         throws BusinessObjectException
Gets the actual units for all labor resources assigned to the activity.

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

setActualLaborUnits

public void setActualLaborUnits(Unit u)
                         throws BusinessObjectException
Sets the actual units for all labor resources assigned to the activity.

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

getActualNonLaborUnits

public Unit getActualNonLaborUnits()
                            throws BusinessObjectException
Gets the actual units for all nonlabor resources assigned to the activity.

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

setActualNonLaborUnits

public void setActualNonLaborUnits(Unit u)
                            throws BusinessObjectException
Sets the actual units for all nonlabor resources assigned to the activity.

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

getActualTotalUnits

public Unit getActualTotalUnits()
                         throws BusinessObjectException
Gets the sum of Actual Labor Units and Actual Nonlabor 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 ActualTotalUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActualLaborCost

public Cost getActualLaborCost()
                        throws BusinessObjectException
Gets the actual costs for all labor resources assigned to the activity. If no resources are assigned, computed as the activity actual labor units * project default price / time. 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 ActualLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setActualLaborCost

public void setActualLaborCost(Cost c)
                        throws BusinessObjectException
Sets the actual costs for all labor resources assigned to the activity. If no resources are assigned, computed as the activity actual labor units * project default price / time. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getActualNonLaborCost

public Cost getActualNonLaborCost()
                           throws BusinessObjectException
Gets the actual costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity actual nonlabor units * project default price / time. 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 ActualNonLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setActualNonLaborCost

public void setActualNonLaborCost(Cost c)
                           throws BusinessObjectException
Sets the actual costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity actual nonlabor units * project default price / time. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getActualMaterialCost

public Cost getActualMaterialCost()
                           throws BusinessObjectException
Gets the sum of all regular and overtime costs for material resources. 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 ActualMaterialCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActualTotalCost

public Cost getActualTotalCost()
                        throws BusinessObjectException
Gets the actual total cost for the activity, including labor resources, nonlabor resources, and project expenses. Actual total cost = actual labor costs + actual nonlabor costs + actual expense costs. 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 ActualTotalCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActualThisPeriodLaborCost

public Cost getActualThisPeriodLaborCost()
                                  throws BusinessObjectException
Gets the actual this period labor cost for all labor resources assigned to the activity. 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 ActualThisPeriodLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setActualThisPeriodLaborCost

public void setActualThisPeriodLaborCost(Cost c)
                                  throws BusinessObjectException
Sets the actual this period labor cost for all labor resources assigned to the activity. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getActualThisPeriodNonLaborCost

public Cost getActualThisPeriodNonLaborCost()
                                     throws BusinessObjectException
Gets the actual this period nonlabor cost for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity actual nonlabor units * project default price / time. 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 ActualThisPeriodNonLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setActualThisPeriodNonLaborCost

public void setActualThisPeriodNonLaborCost(Cost c)
                                     throws BusinessObjectException
Sets the actual this period nonlabor cost for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity actual nonlabor units * project default price / time. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getActualThisPeriodMaterialCost

public Cost getActualThisPeriodMaterialCost()
                                     throws BusinessObjectException
Gets the sum of all material resource costs for the current period. 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 ActualThisPeriodMaterialCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRemainingEarlyStartDate

public BeginDate getRemainingEarlyStartDate()
                                     throws BusinessObjectException
Gets the date the remaining work for the activity is scheduled to begin. This date is computed by the project scheduler but can be updated manually by the project manager. Before the activity is started, the remaining start date is the same as the planned start date. This is the start date that Timesheets users follow.

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

setRemainingEarlyStartDate

public void setRemainingEarlyStartDate(BeginDate d)
                                throws BusinessObjectException
Sets the date the remaining work for the activity is scheduled to begin. This date is computed by the project scheduler but can be updated manually by the project manager. Before the activity is started, the remaining start date is the same as the planned start date. This is the start date that Timesheets users follow.

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

getRemainingEarlyFinishDate

public EndDate getRemainingEarlyFinishDate()
                                    throws BusinessObjectException
Gets the remaining late end date, which is calculated by the scheduler.

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

setRemainingEarlyFinishDate

public void setRemainingEarlyFinishDate(EndDate d)
                                 throws BusinessObjectException
Sets the remaining late end date, which is calculated by the scheduler.

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

getRemainingLateStartDate

public BeginDate getRemainingLateStartDate()
                                    throws BusinessObjectException
Gets the remaining late start date calculated by the scheduler.

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

setRemainingLateStartDate

public void setRemainingLateStartDate(BeginDate d)
                               throws BusinessObjectException
Sets the remaining late start date calculated by the scheduler.

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

getRemainingLateFinishDate

public EndDate getRemainingLateFinishDate()
                                   throws BusinessObjectException
Gets the remaining late finish date calculated by the scheduler.

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

setRemainingLateFinishDate

public void setRemainingLateFinishDate(EndDate d)
                                throws BusinessObjectException
Sets the remaining late finish date calculated by the scheduler.

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

getRemainingDuration

public Duration getRemainingDuration()
                              throws BusinessObjectException
Gets the remaining duration of the activity. Remaining duration is the total working time from the activity remaining start date to the remaining finish date. The remaining working time is computed using the activity's calendar. Before the activity is started, the remaining duration is the same as the planned duration. After the activity is completed the remaining duration is zero.

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

setRemainingDuration

public void setRemainingDuration(Duration d)
                          throws BusinessObjectException
Sets the remaining duration of the activity. Remaining duration is the total working time from the activity remaining start date to the remaining finish date. The remaining working time is computed using the activity's calendar. Before the activity is started, the remaining duration is the same as the planned duration. After the activity is completed the remaining duration is zero.

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

getRemainingLaborUnits

public Unit getRemainingLaborUnits()
                            throws BusinessObjectException
Gets the remaining units for all labor resources assigned to the activity. The remaining units reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.

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

setRemainingLaborUnits

public void setRemainingLaborUnits(Unit u)
                            throws BusinessObjectException
Sets the remaining units for all labor resources assigned to the activity. The remaining units reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.

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

getRemainingNonLaborUnits

public Unit getRemainingNonLaborUnits()
                               throws BusinessObjectException
Gets the remaining units for all nonlabor resources assigned to the activity. The remaining units reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.

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

setRemainingNonLaborUnits

public void setRemainingNonLaborUnits(Unit u)
                               throws BusinessObjectException
Sets the remaining units for all nonlabor resources assigned to the activity. The remaining units reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.

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

getRemainingTotalUnits

public Unit getRemainingTotalUnits()
                            throws BusinessObjectException
Gets the sum of Remaining Labor Units and Remaining Nonlabor Units.

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

getRemainingLaborCost

public Cost getRemainingLaborCost()
                           throws BusinessObjectException
Gets the remaining costs for all labor resources assigned to the activity. If no resources are assigned, computed as the activity remaining labor units * project default price / time. 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 RemainingLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setRemainingLaborCost

public void setRemainingLaborCost(Cost c)
                           throws BusinessObjectException
Sets the remaining costs for all labor resources assigned to the activity. If no resources are assigned, computed as the activity remaining labor units * project default price / time. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getRemainingNonLaborCost

public Cost getRemainingNonLaborCost()
                              throws BusinessObjectException
Gets the remaining costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity remaining nonlabor units * project default price / time. 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 RemainingNonLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setRemainingNonLaborCost

public void setRemainingNonLaborCost(Cost c)
                              throws BusinessObjectException
Sets the remaining costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity remaining nonlabor units * project default price / time. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getRemainingMaterialCost

public Cost getRemainingMaterialCost()
                              throws BusinessObjectException
Gets the sum of all material resource remaining costs. 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 RemainingMaterialCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRemainingTotalCost

public Cost getRemainingTotalCost()
                           throws BusinessObjectException
Gets the remaining total cost for the activity, including labor resources, nonlabor resources, and project expenses. Remaining total cost = remaining labor costs + remaining nonlabor costs + remaining expense costs. 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 RemainingTotalCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getPlannedExpenseCost

public Cost getPlannedExpenseCost()
                           throws BusinessObjectException
Gets the planned costs for all project expenses associated with the activity. This field is named BudgetedExpenseCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 PlannedExpenseCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActualExpenseCost

public Cost getActualExpenseCost()
                          throws BusinessObjectException
Gets the actual costs for all project expenses associated with the activity. 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 ActualExpenseCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRemainingExpenseCost

public Cost getRemainingExpenseCost()
                             throws BusinessObjectException
Gets the remaining costs for all project expenses associated with the activity. 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 RemainingExpenseCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLaborUnitsPercentComplete

public Percent getLaborUnitsPercentComplete()
                                     throws BusinessObjectException
Gets the percent complete of units for all labor resources for the activity. Computed as actual labor units / at completion labor units * 100. Always in the range 0 to 100. 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 LaborUnitsPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNonLaborUnitsPercentComplete

public Percent getNonLaborUnitsPercentComplete()
                                        throws BusinessObjectException
Gets the percent complete of units for all nonlabor resources for the activity. Computed as actual nonlabor units / at completion nonlabor units * 100. Always in the range 0 to 100. 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 NonLaborUnitsPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setNonLaborUnitsPercentComplete

public void setNonLaborUnitsPercentComplete(Percent p)
                                     throws BusinessObjectException
Sets the percent complete of units for all nonlabor resources for the activity. Computed as actual nonlabor units / at completion nonlabor units * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getLateStartDate

public BeginDate getLateStartDate()
                           throws BusinessObjectException
Gets the latest possible date the remaining work for the activity must begin without delaying the project finish date. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability.

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

getLateFinishDate

public EndDate getLateFinishDate()
                          throws BusinessObjectException
Gets the latest possible date the activity must finish without delaying the project finish date. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability.

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

getEarlyStartDate

public BeginDate getEarlyStartDate()
                            throws BusinessObjectException
Gets the earliest possible date the remaining work for the activity can begin. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability.

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

getEarlyFinishDate

public EndDate getEarlyFinishDate()
                           throws BusinessObjectException
Gets the earliest possible date the activity can finish. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability.

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

getStartDate

public BeginDate getStartDate()
                       throws BusinessObjectException
Gets the start date of the activity. Set to the remaining start date until the activity is started, then set to the actual start date. 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 StartDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setStartDate

public void setStartDate(BeginDate d)
                  throws BusinessObjectException
Sets the start date of the activity. Set to the remaining start date until the activity is started, then set to the actual start date. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getFinishDate

public EndDate getFinishDate()
                      throws BusinessObjectException
Gets the current finish date of the activity. Set to the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. 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 FinishDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setFinishDate

public void setFinishDate(EndDate d)
                   throws BusinessObjectException
Sets the current finish date of the activity. Set to the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getExpectedFinishDate

public EndDate getExpectedFinishDate()
                              throws BusinessObjectException
Gets the date the activity is expected to be finished according to the progress made on the activity's work products. The expected finish date is entered manually by people familiar with progress of the activity's work products.

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

setExpectedFinishDate

public void setExpectedFinishDate(EndDate d)
                           throws BusinessObjectException
Sets the date the activity is expected to be finished according to the progress made on the activity's work products. The expected finish date is entered manually by people familiar with progress of the activity's work products.

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

getSuspendDate

public BeginDate getSuspendDate()
                         throws BusinessObjectException
Gets the start date when the progress of a task or resource dependent activity is delayed from. The suspend date must be later than the actual start date, which the activity must have. The progress of the activity can be resumed by setting the resume date. The Suspend/Resume period behaves like a nonworktime on the activity calendar or resource calendar for task and resource dependent activities.

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

setSuspendDate

public void setSuspendDate(BeginDate d)
                    throws BusinessObjectException
Sets the start date when the progress of a task or resource dependent activity is delayed from. The suspend date must be later than the actual start date, which the activity must have. The progress of the activity can be resumed by setting the resume date. The Suspend/Resume period behaves like a nonworktime on the activity calendar or resource calendar for task and resource dependent activities.

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

getResumeDate

public EndDate getResumeDate()
                      throws BusinessObjectException
Gets the date when a suspended task or resource dependent activity should be resumed. The resume date must be later than the suspend date and earlier than the actual finish date. The Suspend/Resume period behaves like a nonworktime on the activity calendar or resource calendar for task and resource dependent activities.

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

setResumeDate

public void setResumeDate(EndDate d)
                   throws BusinessObjectException
Sets the date when a suspended task or resource dependent activity should be resumed. The resume date must be later than the suspend date and earlier than the actual finish date. The Suspend/Resume period behaves like a nonworktime on the activity calendar or resource calendar for task and resource dependent activities.

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

getAtCompletionDuration

public Duration getAtCompletionDuration()
                                 throws BusinessObjectException
Gets the total working time from the activity's current start date to the current finish date. The current start date is the planned start date until the activity is started, then it is the actual start date. The current finish date is the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. The total working time is computed using the activity's calendar. 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 AtCompletionDuration
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setAtCompletionDuration

public void setAtCompletionDuration(Duration d)
                             throws BusinessObjectException
Sets the total working time from the activity's current start date to the current finish date. The current start date is the planned start date until the activity is started, then it is the actual start date. The current finish date is the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. The total working time is computed using the activity's calendar. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getAtCompletionLaborUnits

public Unit getAtCompletionLaborUnits()
                               throws BusinessObjectException
Gets the sum of the actual plus remaining units for all labor resources assigned to the activity. Computed as actual labor units + remaining labor units. Same as the planned labor units if the activity is not started and the actual labor units once the activity is completed.

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

setAtCompletionLaborUnits

public void setAtCompletionLaborUnits(Unit u)
                               throws BusinessObjectException
Sets the sum of the actual plus remaining units for all labor resources assigned to the activity. Computed as actual labor units + remaining labor units. Same as the planned labor units if the activity is not started and the actual labor units once the activity is completed.

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

getAtCompletionNonLaborUnits

public Unit getAtCompletionNonLaborUnits()
                                  throws BusinessObjectException
Gets the sum of the actual plus remaining units for all nonlabor resources assigned to the activity. Computed as actual nonlabor units + remaining nonlabor units. Same as the planned nonlabor units if the activity is not started and the actual nonlabor units once the activity is completed.

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

setAtCompletionNonLaborUnits

public void setAtCompletionNonLaborUnits(Unit u)
                                  throws BusinessObjectException
Sets the sum of the actual plus remaining units for all nonlabor resources assigned to the activity. Computed as actual nonlabor units + remaining nonlabor units. Same as the planned nonlabor units if the activity is not started and the actual nonlabor units once the activity is completed.

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

getAtCompletionTotalUnits

public Unit getAtCompletionTotalUnits()
                               throws BusinessObjectException
Gets the sum of the actual plus remaining units for the resource assignment on the activity. 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 AtCompletionTotalUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAtCompletionLaborCost

public Cost getAtCompletionLaborCost()
                              throws BusinessObjectException
Gets the sum of the actual plus remaining costs for all labor resources assigned to the activity. Computed as actual labor cost + remaining labor cost. Same as the planned labor costs if the activity is not started and the actual labor costs once the activity is completed. 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 AtCompletionLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setAtCompletionLaborCost

public void setAtCompletionLaborCost(Cost c)
                              throws BusinessObjectException
Sets the sum of the actual plus remaining costs for all labor resources assigned to the activity. Computed as actual labor cost + remaining labor cost. Same as the planned labor costs if the activity is not started and the actual labor costs once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getAtCompletionNonLaborCost

public Cost getAtCompletionNonLaborCost()
                                 throws BusinessObjectException
Gets the sum of the actual plus remaining costs for all nonlabor resources assigned to the activity. Computed as actual nonlabor cost + remaining nonlabor cost. Same as the planned nonlabor costs if the activity is not started and the actual nonlabor costs once the activity is completed. 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 AtCompletionNonLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setAtCompletionNonLaborCost

public void setAtCompletionNonLaborCost(Cost c)
                                 throws BusinessObjectException
Sets the sum of the actual plus remaining costs for all nonlabor resources assigned to the activity. Computed as actual nonlabor cost + remaining nonlabor cost. Same as the planned nonlabor costs if the activity is not started and the actual nonlabor costs once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getAtCompletionMaterialCost

public Cost getAtCompletionMaterialCost()
                                 throws BusinessObjectException
Gets the sum of all actual and remaining costs for material resources. 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 AtCompletionMaterialCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAtCompletionTotalCost

public Cost getAtCompletionTotalCost()
                              throws BusinessObjectException
Gets the total cost at completion for the activity, including labor resources, nonlabor resources, and project expenses. At completion total cost = at completion labor cost + at completion nonlabor cost + at completion expense cost. 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 AtCompletionTotalCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAtCompletionExpenseCost

public Cost getAtCompletionExpenseCost()
                                throws BusinessObjectException
Gets the sum of the actual plus remaining costs for all expenses associated with the activity. Computed as actual expense cost + remaining expense cost. 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 AtCompletionExpenseCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getStatus

public ActivityStatus getStatus()
                         throws BusinessObjectException
Gets the current status of the activity, either 'Not Started', 'In Progress', or 'Completed'.

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

setStatus

public void setStatus(ActivityStatus enm)
               throws BusinessObjectException
Sets the current status of the activity, either 'Not Started', 'In Progress', or 'Completed'.

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

getDurationType

public DurationType getDurationType()
                             throws BusinessObjectException
Gets the duration type of the activity. One of 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'. For 'Fixed Units/Time' activities, the resource units per time are constant when the activity duration or units are changed. This type is used when an activity has fixed resources with fixed productivity output per time period. For 'Fixed Duration and Units/Time' activities, the activity duration is constant as the units or resource units per time are changed. This type is used when the activity is to be completed within a fixed time period regardless of the resources assigned. For 'Fixed Units' activities, the activity units are constant when the duration or resource units per time are changed. This type is used when the total amount of work is fixed, and increasing the resources can decrease the activity duration.

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

setDurationType

public void setDurationType(DurationType enm)
                     throws BusinessObjectException
Sets the duration type of the activity. One of 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'. For 'Fixed Units/Time' activities, the resource units per time are constant when the activity duration or units are changed. This type is used when an activity has fixed resources with fixed productivity output per time period. For 'Fixed Duration and Units/Time' activities, the activity duration is constant as the units or resource units per time are changed. This type is used when the activity is to be completed within a fixed time period regardless of the resources assigned. For 'Fixed Units' activities, the activity units are constant when the duration or resource units per time are changed. This type is used when the total amount of work is fixed, and increasing the resources can decrease the activity duration.

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

getPrimaryConstraintType

public ConstraintType getPrimaryConstraintType()
                                        throws BusinessObjectException
Gets the type of constraint applied to the activity start or finish date. Activity constraints are used by the project scheduler. Start date constraints are 'Start On', 'Start On or Before', and 'Start On or After'. Finish date constraints are 'Finish On', 'Finish On or Before', and 'Finish On or After'. Another type of constraint, 'As Late As Possible', schedules the activity as late as possible based on the available free float.

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

setPrimaryConstraintType

public void setPrimaryConstraintType(ConstraintType enm)
                              throws BusinessObjectException
Sets the type of constraint applied to the activity start or finish date. Activity constraints are used by the project scheduler. Start date constraints are 'Start On', 'Start On or Before', and 'Start On or After'. Finish date constraints are 'Finish On', 'Finish On or Before', and 'Finish On or After'. Another type of constraint, 'As Late As Possible', schedules the activity as late as possible based on the available free float.

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

getPrimaryConstraintDate

public java.util.Date getPrimaryConstraintDate()
                                        throws BusinessObjectException
Gets the constraint date for the activity, if the activity has a constraint. The activity's constraint type determines whether this is a start date or finish date. Activity constraints are used by the project scheduler.

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

setPrimaryConstraintDate

public void setPrimaryConstraintDate(java.util.Date d)
                              throws BusinessObjectException
Sets the constraint date for the activity, if the activity has a constraint. The activity's constraint type determines whether this is a start date or finish date. Activity constraints are used by the project scheduler.

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

getExternalEarlyStartDate

public BeginDate getExternalEarlyStartDate()
                                    throws BusinessObjectException
Gets the date value that determines the early start date for imported activities with external constraints lost (relations from/to external projects that do not exist in the database). This field is the relationship early finish date (REF) when the lost relationship type is FS or SS. When the relationship type is SF or FF, this field is calculated as REF - RD of the successor.

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

setExternalEarlyStartDate

public void setExternalEarlyStartDate(BeginDate d)
                               throws BusinessObjectException
Sets the date value that determines the early start date for imported activities with external constraints lost (relations from/to external projects that do not exist in the database). This field is the relationship early finish date (REF) when the lost relationship type is FS or SS. When the relationship type is SF or FF, this field is calculated as REF - RD of the successor.

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

getExternalLateFinishDate

public EndDate getExternalLateFinishDate()
                                  throws BusinessObjectException
Gets the date value that determines the Late Finish Date for imported activities with external constraints lost (from/to external projects that do not exist in the database). This field is the relationship late finish date (RLF) when the lost relationship type is FS or FF. When the relationship type is SS or SF, this field is calculated as RLS + RD of the predecessor.

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

setExternalLateFinishDate

public void setExternalLateFinishDate(EndDate d)
                               throws BusinessObjectException
Sets the date value that determines the Late Finish Date for imported activities with external constraints lost (from/to external projects that do not exist in the database). This field is the relationship late finish date (RLF) when the lost relationship type is FS or FF. When the relationship type is SS or SF, this field is calculated as RLS + RD of the predecessor.

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

getPercentCompleteType

public PercentCompleteType getPercentCompleteType()
                                           throws BusinessObjectException
Gets the activity percent complete type: 'Physical', 'Duration', or 'Units'.

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

setPercentCompleteType

public void setPercentCompleteType(PercentCompleteType enm)
                            throws BusinessObjectException
Sets the activity percent complete type: 'Physical', 'Duration', or 'Units'.

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

getPhysicalPercentComplete

public Percent getPhysicalPercentComplete()
                                   throws BusinessObjectException
Gets the physical percent complete, which can either be user entered or calculated from the activity's weighted steps. 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 PhysicalPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setPhysicalPercentComplete

public void setPhysicalPercentComplete(Percent p)
                                throws BusinessObjectException
Sets the physical percent complete, which can either be user entered or calculated from the activity's weighted steps. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getDurationPercentComplete

public Percent getDurationPercentComplete()
                                   throws BusinessObjectException
Gets the percent complete of the activity duration. Computed as (planned duration - remaining duration) / planned duration * 100. Always in the range 0 to 100. The planned duration is taken from the current plan, not from the baseline. 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 DurationPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setDurationPercentComplete

public void setDurationPercentComplete(Percent p)
                                throws BusinessObjectException
Sets the percent complete of the activity duration. Computed as (planned duration - remaining duration) / planned duration * 100. Always in the range 0 to 100. The planned duration is taken from the current plan, not from the baseline. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getUnitsPercentComplete

public Percent getUnitsPercentComplete()
                                throws BusinessObjectException
Gets the percent complete of units for all labor and nonlabor resources assigned to the activity. Computed as actual units / at completion units * 100. Always in the range 0 to 100. 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 UnitsPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUnitsPercentComplete

public void setUnitsPercentComplete(Percent p)
                             throws BusinessObjectException
Sets the percent complete of units for all labor and nonlabor resources assigned to the activity. Computed as actual units / at completion units * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getPercentComplete

public Percent getPercentComplete()
                           throws BusinessObjectException
Gets the activity percent complete. This value is tied to the activity duration % complete, units % complete, or physical % complete, depending on the setting for the activity's percent complete type, which is one of Duration, Units, or Physical. Always in the range 0 to 100. 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 PercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setPercentComplete

public void setPercentComplete(Percent p)
                        throws BusinessObjectException
Sets the activity percent complete. This value is tied to the activity duration % complete, units % complete, or physical % complete, depending on the setting for the activity's percent complete type, which is one of Duration, Units, or Physical. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getGUID

public java.lang.String getGUID()
                         throws BusinessObjectException
Gets the globally unique ID generated by the system.

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

setGUID

public void setGUID(java.lang.String s)
             throws BusinessObjectException
Sets the globally unique ID generated by the system.

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

getTotalFloat

public Duration getTotalFloat()
                       throws BusinessObjectException
Gets the amount of time the activity can be delayed before delaying the project finish date. Total float can be computed as late start - early start or as late finish - early finish; this option can be set when running the project scheduler.

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

getFreeFloat

public Duration getFreeFloat()
                      throws BusinessObjectException
Gets the amount of time the activity can be delayed before delaying the start date of any successor activity.

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

getIsLongestPath

public boolean getIsLongestPath()
                         throws BusinessObjectException
Gets the flag that indicates whether an activity is on the longest path. Default = 'N'.

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

getIsCritical

public boolean getIsCritical()
                      throws BusinessObjectException
Gets the flag that indicates whether the activity is critical. An activity is critical when its total Float is below the critical duration specified for the project. Delaying critical activities will delay the finish date of the project. 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 IsCritical
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActualThisPeriodLaborUnits

public Unit getActualThisPeriodLaborUnits()
                                   throws BusinessObjectException
Gets the actual this period labor units (hours) for all labor resources assigned to the activity.

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

setActualThisPeriodLaborUnits

public void setActualThisPeriodLaborUnits(Unit u)
                                   throws BusinessObjectException
Sets the actual this period labor units (hours) for all labor resources assigned to the activity.

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

getActualThisPeriodNonLaborUnits

public Unit getActualThisPeriodNonLaborUnits()
                                      throws BusinessObjectException
Gets the actual this period nonlabor units (hours) for all nonlabor resources assigned to the activity.

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

setActualThisPeriodNonLaborUnits

public void setActualThisPeriodNonLaborUnits(Unit u)
                                      throws BusinessObjectException
Sets the actual this period nonlabor units (hours) for all nonlabor resources assigned to the activity.

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

getBaselineStartDate

public BeginDate getBaselineStartDate()
                               throws BusinessObjectException
Gets the current start date of the activity in the project baseline. Set to the planned start date until the activity is started, then set to the actual start date. 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 BaselineStartDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselineFinishDate

public EndDate getBaselineFinishDate()
                              throws BusinessObjectException
Gets the current finish date of the activity in the project baseline. Set to the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. 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 BaselineFinishDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselineDuration

public Duration getBaselineDuration()
                             throws BusinessObjectException
Gets the duration for the activity in the project baseline. The duration is the total working time from the activity current start date to the current finish date. Same as the actual duration plus the remaining duration. The total working time is computed using the activity's calendar. 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 BaselineDuration
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselinePlannedExpenseCost

public Cost getBaselinePlannedExpenseCost()
                                   throws BusinessObjectException
Gets the planned costs for all project expenses associated with the activity. This field is named Baseline Budgeted Expense Cost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 BaselinePlannedExpenseCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselinePlannedLaborCost

public Cost getBaselinePlannedLaborCost()
                                 throws BusinessObjectException
Gets the cost at completion for all labor resources assigned to the activity in the project baseline. Computed from the baseline at completion labor units. If no resources are assigned, computed as the activity BL labor units * project default price / time. This field is named Baseline Budgeted Labor Cost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 BaselinePlannedLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselinePlannedNonLaborCost

public Cost getBaselinePlannedNonLaborCost()
                                    throws BusinessObjectException
Gets the planned costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity planned nonlabor units * project default price / time. This field is named Baseline Budgeted Non Labor Cost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 BaselinePlannedNonLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselinePlannedMaterialCost

public Cost getBaselinePlannedMaterialCost()
                                    throws BusinessObjectException
Gets the Planned Material Cost for a project baseline activity. 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 BaselinePlannedMaterialCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselinePlannedTotalCost

public Cost getBaselinePlannedTotalCost()
                                 throws BusinessObjectException
Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses. Planned total cost = planned labor cost + planned nonlabor cost + planned expense cost. This field is named Baseline Budgeted Total Cost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 BaselinePlannedTotalCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselinePlannedLaborUnits

public Unit getBaselinePlannedLaborUnits()
                                  throws BusinessObjectException
Gets the planned units for all labor resources assigned to the activity. This field is named Baseline Budgeted Labor Units in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 BaselinePlannedLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselinePlannedNonLaborUnits

public Unit getBaselinePlannedNonLaborUnits()
                                     throws BusinessObjectException
Gets the planned units for all nonlabor resources assigned to the activity. This field is named Baseline Budgeted Non Labor Units in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 BaselinePlannedNonLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaselinePlannedDuration

public Duration getBaselinePlannedDuration()
                                    throws BusinessObjectException
Gets the planned duration for the activity in the project baseline. Planned duration is the total working time from the activity current start date to the current finish date. Same as the actual duration plus the remaining duration. The total working time is computed using the activity's calendar. This field is named Baseline Budgeted Duration in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 BaselinePlannedDuration
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getExpenseCostVariance

public Cost getExpenseCostVariance()
                            throws BusinessObjectException
Gets the difference between project baseline expense cost and at completion expense cost. Calculated as project baseline expense cost - at completion expense cost (at completion expense cost = actual expense cost + remaining expense cost). 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 ExpenseCostVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLaborCostVariance

public Cost getLaborCostVariance()
                          throws BusinessObjectException
Gets the difference between project baseline labor cost and at completion labor cost. Calculated as BL labor cost - at completion labor cost. 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 LaborCostVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNonLaborCostVariance

public Cost getNonLaborCostVariance()
                             throws BusinessObjectException
Gets the difference between the project baseline labor cost and at completion labor cost. Calculated as BL nonlabor cost - at completion nonlabor cost. 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 NonLaborCostVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getMaterialCostVariance

public Cost getMaterialCostVariance()
                             throws BusinessObjectException
Gets the project BaselinePlannedMaterialCost minus the AtCompletionMaterialCost. 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 MaterialCostVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getTotalCostVariance

public Cost getTotalCostVariance()
                          throws BusinessObjectException
Gets the difference between the project baseline total cost and the at completion total cost. Calculated as BL total cost - at completion total cost. 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 TotalCostVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLaborUnitsVariance

public Unit getLaborUnitsVariance()
                           throws BusinessObjectException
Gets the difference between project baseline labor units and at completion labor units. Calculated as BL labor units - at completion labor 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 LaborUnitsVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNonLaborUnitsVariance

public Unit getNonLaborUnitsVariance()
                              throws BusinessObjectException
Gets the difference between the project baseline labor units and at completion labor units. Calculated as BL nonlabor units - at completion nonlabor 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 NonLaborUnitsVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDurationVariance

public Duration getDurationVariance()
                             throws BusinessObjectException
Gets the duration between the activity's project baseline duration and the at complete duration. Computed as project baseline duration - at completion duration. 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 DurationVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getStartDateVariance

public Duration getStartDateVariance()
                              throws BusinessObjectException
Gets the duration between the start date in the current project and the project baseline start date. Calculated as start date - project baseline start date. 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 StartDateVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getFinishDateVariance

public Duration getFinishDateVariance()
                               throws BusinessObjectException
Gets the duration between the finish date in the current project and the project baseline finish date. Calculated as finish date - project baseline finish date. 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 FinishDateVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRemainingFloat

public Duration getRemainingFloat()
                           throws BusinessObjectException
Gets the amount of time remaining by which the activity can be delayed before delaying the project finish date. Computed as late finish - remaining finish. If the remaining finish is the same as the early finish (in general, when the activity is not started), then the remaining float is the same as the total float. 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 RemainingFloat
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getPlannedValueLaborUnits

public Unit getPlannedValueLaborUnits()
                               throws BusinessObjectException
Gets the portion of the project baseline labor units that is scheduled to be completed as of the project data date. Computed as BL labor units * schedule % complete. The schedule % complete specifies how much of the activity's project baseline duration has been completed so far. BL labor units is taken from the project baseline. 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 PlannedValueLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getPlannedValueCost

public Cost getPlannedValueCost()
                         throws BusinessObjectException
Gets the portion of the project baseline total cost of the activity that is scheduled to be completed as of the project data date. Computed as BAC * schedule % complete. Also known as the work scheduled to be performed for the activity. The schedule % complete specifies how much of the activity's project baseline duration has been completed so far. BAC is computed from the project baseline. 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 PlannedValueCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getPerformancePercentComplete

public Percent getPerformancePercentComplete()
                                      throws BusinessObjectException
Gets the activity performance percent complete. The performance percent complete is used to compute earned value and may be based on the activity % complete, on the 0/100 rule, on the 50/50 rule, etc., depending on the technique for computing earned-value percent complete for the activity's WBS. The performance % complete specifies what percentage of the activity's planned worth has been earned so far. 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 PerformancePercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAccountingVariance

public Cost getAccountingVariance()
                           throws BusinessObjectException
Gets the difference between the planned value of work scheduled and the actual cost of work performed. Computed as accounting variance = planned value - actual cost . A negative value indicates that actual costs have exceeded the scheduled costs. 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 AccountingVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAccountingVarianceLaborUnits

public Unit getAccountingVarianceLaborUnits()
                                     throws BusinessObjectException
Gets the difference between the planned value of work scheduled and the actual work performed. Computed as accounting variance labor units = planned value labor units - actual units. A negative value indicates that actual costs have exceeded the scheduled costs. 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 AccountingVarianceLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBudgetAtCompletion

public Cost getBudgetAtCompletion()
                           throws BusinessObjectException
Gets the planned total cost through activity completion. Computed as planned labor cost + planned nonlabor cost + planned expense cost, same as the planned total cost. 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 BudgetAtCompletion
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCostPercentComplete

public Percent getCostPercentComplete()
                               throws BusinessObjectException
Gets the percent complete of costs for all labor resources, nonlabor resources, and expenses for the activity. Computed as actual total cost / at completion total cost * 100. Always in the range 0 to 100. 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 CostPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLaborCostPercentComplete

public Percent getLaborCostPercentComplete()
                                    throws BusinessObjectException
Gets the percent complete of costs for all labor resources assigned to the activity. Computed as actual labor cost / at completion labor cost * 100. Always in the range 0 to 100. 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 LaborCostPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNonLaborCostPercentComplete

public Percent getNonLaborCostPercentComplete()
                                       throws BusinessObjectException
Gets the percent complete of costs for all nonlabor resources assigned to the activity. Computed as actual nonlabor cost / at completion nonlabor cost * 100. Always in the range 0 to 100. 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 NonLaborCostPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getMaterialCostPercentComplete

public Percent getMaterialCostPercentComplete()
                                       throws BusinessObjectException
Gets the percent complete of costs for all material resources assigned to the activity. Computed as actual nonlabor cost / at completion nonlabor cost * 100. Always in the range 0 to 100. 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 MaterialCostPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getExpenseCostPercentComplete

public Percent getExpenseCostPercentComplete()
                                      throws BusinessObjectException
Gets the percent complete of costs for all expenses associated with the activity. Computed as actual expense cost / at completion expense cost * 100. Always in the range 0 to 100. 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 ExpenseCostPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCostPerformanceIndex

public double getCostPerformanceIndex()
                               throws BusinessObjectException
Gets the earned value divided by the actual cost. A value less than 1 indicates that actual cost have exceeded the planned value. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getCostPerformanceIndexLaborUnits

public double getCostPerformanceIndexLaborUnits()
                                         throws BusinessObjectException
Gets the ratio of the earned value labor units and the actual work performed. Computed as CPI labor units = earned value labor units / actual labor 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 CostPerformanceIndexLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCostVariance

public Cost getCostVariance()
                     throws BusinessObjectException
Gets the difference between the earned value and the actual cost of work performed. Computed as CV = earned value - actual costs. A negative value indicates that actual costs have exceeded the value of work performed. 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 CostVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCostVarianceLaborUnits

public Unit getCostVarianceLaborUnits()
                               throws BusinessObjectException
Gets the difference between the earned value of labor units and the actual cost of labor units. Calculated as CV labor units = earned value planned units - actual units. A negative value indicates that actual costs have exceeded the value of work performed. 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 CostVarianceLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCostVarianceIndex

public double getCostVarianceIndex()
                            throws BusinessObjectException
Gets the ratio of the cost variance and the earned value of work performed. Computed as CVI = cost variance / earned value. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getCostVarianceIndexLaborUnits

public double getCostVarianceIndexLaborUnits()
                                      throws BusinessObjectException
Gets the ratio of the cost variance labor units and the earned value of work performed. Computed as CVI labor units = CV labor units / earned value labor 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 CostVarianceIndexLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCostPercentOfPlanned

public Percent getCostPercentOfPlanned()
                                throws BusinessObjectException
Gets the percent complete of planned costs for all labor resources, nonlabor resources, and expenses for the activity. Computed as actual total cost / BL planned total cost * 100. The value can exceed 100. 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 CostPercentOfPlanned
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDurationPercentOfPlanned

public Percent getDurationPercentOfPlanned()
                                    throws BusinessObjectException
Gets the activity actual duration percent of planned. Computed as actual duration / BL duration * 100. The value can exceed 100. The BL duration is the activity's at completion duration from the project baseline. 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 DurationPercentOfPlanned
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getEarnedValueCost

public Cost getEarnedValueCost()
                        throws BusinessObjectException
Gets the portion of the project baseline total cost of the activity that is actually completed as of the project data date. Computed as earned value = BAC * performance % complete. The method for computing performance % complete depends on the earned-value technique selected for the activity's WBS. BAC is computed from the project baseline. 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 EarnedValueCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getEarnedValueLaborUnits

public Unit getEarnedValueLaborUnits()
                              throws BusinessObjectException
Gets the portion of the project baseline labor units that is actually completed as of the project data date. Computed as labor units earned value = project baseline labor units * performance % complete. The method for computing performance % complete depends on the earned-value technique selected for the activity's WBS. The BL labor units is taken from the project baseline. 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 EarnedValueLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getEstimateAtCompletionCost

public Cost getEstimateAtCompletionCost()
                                 throws BusinessObjectException
Gets the estimated cost at completion for the activity. Computed as the actual total cost plus the estimate-to-complete cost; EAC = ACWP + ETC. Note that the method for computing ETC depends on the earned-value technique selected for the activity's WBS. 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 EstimateAtCompletionCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getEstimateAtCompletionLaborUnits

public Unit getEstimateAtCompletionLaborUnits()
                                       throws BusinessObjectException
Gets the estimated labor units at completion of the activity. Calculated as actual labor units + estimate to complete labor units. estimate to complete labor units is calculated based off of the earned value setting on the WBS. 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 EstimateAtCompletionLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getEstimateToComplete

public Cost getEstimateToComplete()
                           throws BusinessObjectException
Gets the estimated cost to complete the activity. Computed as either the remaining total cost for the activity (remaining total cost), or as PF * (BAC - earned value), depending on the earned-value technique selected for the activity's WBS. BAC is computed from the project baseline. 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 EstimateToComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getEstimateToCompleteLaborUnits

public Unit getEstimateToCompleteLaborUnits()
                                     throws BusinessObjectException
Gets the estimated quantity to complete the activity. Computed as either the remaining total units for the activity (remaining total units), or as PF * (BL labor units - earned value), depending on the earned-value technique selected for the activity's WBS. 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 EstimateToCompleteLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSchedulePercentComplete

public Percent getSchedulePercentComplete()
                                   throws BusinessObjectException
Gets the activity schedule percent complete, which specifies how much of the activity's project baseline duration has been completed so far. Computed based on where the current data date falls relative to the activity's project baseline start and finish dates. If the data date is earlier than the BL start, the schedule % complete is 0. If the data date is later than the BL finish, the schedule % complete is 100. The schedule % complete indicates how much of the activity duration should be currently completed, relative to the selected project baseline. 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 SchedulePercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getScheduleVariance

public Cost getScheduleVariance()
                         throws BusinessObjectException
Gets the difference between the earned value of work performed and the work scheduled to be performed. Computed as SV = earned value - planned value. A negative value indicates that less work was actually performed than was scheduled. 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 ScheduleVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getScheduleVarianceLaborUnits

public Unit getScheduleVarianceLaborUnits()
                                   throws BusinessObjectException
Gets the difference between the earned value of work performed and the work scheduled to be performed. Computed as SV labor units = earned value labor units - planned value labor 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 ScheduleVarianceLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getScheduleVarianceIndex

public double getScheduleVarianceIndex()
                                throws BusinessObjectException
Gets the ratio of the schedule variance and the work scheduled to be performed. Computed as SVI = SV / planned value. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getScheduleVarianceIndexLaborUnits

public double getScheduleVarianceIndexLaborUnits()
                                          throws BusinessObjectException
Gets the ratio of the schedule variance and the work scheduled to be performed. Computed as SVI labor units = SV labor units / planned value labor 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 ScheduleVarianceIndexLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSchedulePerformanceIndex

public double getSchedulePerformanceIndex()
                                   throws BusinessObjectException
Gets the ratio of the earned value of work performed and the work scheduled to be performed. Computed as SPI = earned value/ planned value. A value less than 1 indicates that less work was actually performed than was scheduled. 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 SchedulePerformanceIndex
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSchedulePerformanceIndexLaborUnits

public double getSchedulePerformanceIndexLaborUnits()
                                             throws BusinessObjectException
Gets the ratio of the earned value of labor units and the planned value of labor units. Computed as SPI labor units = earned value labor units / planned value labor 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 SchedulePerformanceIndexLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getToCompletePerformanceIndex

public double getToCompletePerformanceIndex()
                                     throws BusinessObjectException
Gets the TCPI, which is calculated as (budget at completion - earned value) / (estimate at completion - ACWP). 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 ToCompletePerformanceIndex
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAtCompletionVariance

public Cost getAtCompletionVariance()
                             throws BusinessObjectException
Gets the difference between the project baseline total cost and the current estimate of total cost. Computed as VAC = BAC - EAC. A negative value indicates an estimated cost overrun. BAC is computed from the current project baseline. 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 AtCompletionVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAtCompletionLaborUnitsVariance

public Unit getAtCompletionLaborUnitsVariance()
                                       throws BusinessObjectException
Gets the project baseline planned total labor units minus the estimate at completion labor 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 AtCompletionLaborUnitsVariance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSecondaryConstraintDate

public java.util.Date getSecondaryConstraintDate()
                                          throws BusinessObjectException
Gets the date to be used for the cstr_type2 assignment, if the activity has a cstr_type2 value. The activity's constraint type determines whether this is a start date or finish date. Activity constraints are used by the project scheduler.

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

setSecondaryConstraintDate

public void setSecondaryConstraintDate(java.util.Date d)
                                throws BusinessObjectException
Sets the date to be used for the cstr_type2 assignment, if the activity has a cstr_type2 value. The activity's constraint type determines whether this is a start date or finish date. Activity constraints are used by the project scheduler.

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

getSecondaryConstraintType

public ConstraintType getSecondaryConstraintType()
                                          throws BusinessObjectException
Gets the additional constraint to be used by the scheduler. If more than one constraint is assigned, this value should be restricted to one of the following: "Start On or Before", "Start On or After", "Finish On or Before", or "Finish On or After".

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

setSecondaryConstraintType

public void setSecondaryConstraintType(ConstraintType enm)
                                throws BusinessObjectException
Sets the additional constraint to be used by the scheduler. If more than one constraint is assigned, this value should be restricted to one of the following: "Start On or Before", "Start On or After", "Finish On or Before", or "Finish On or After".

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

getNotesToResources

public java.lang.String getNotesToResources()
                                     throws BusinessObjectException
Gets the notes from the project manager to the timesheet resources. 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 NotesToResources
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setNotesToResources

public void setNotesToResources(java.lang.String s)
                         throws BusinessObjectException
Sets the notes from the project manager to the timesheet resources. 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

getFeedback

public java.lang.String getFeedback()
                             throws BusinessObjectException
Gets the feedback from the resource. 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 Feedback
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setFeedback

public void setFeedback(java.lang.String s)
                 throws BusinessObjectException
Sets the feedback from the resource. 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

getFloatPath

public int getFloatPath()
                 throws BusinessObjectException
Gets the integer representing the critical path this activity is on. The value 1 is the most critical path, value 2 is the second most critical path, etc.

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

getFloatPathOrder

public int getFloatPathOrder()
                      throws BusinessObjectException
Gets the integer representing the order in which this object was found on one of the critical paths.

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

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this activity 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 activity 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 activity.

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

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

getBaseline1StartDate

public BeginDate getBaseline1StartDate()
                                throws BusinessObjectException
Gets the current start date of the activity in the primary baseline. Set to the planned start date until the activity is started, then set to the actual start date. 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 Baseline1StartDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1FinishDate

public EndDate getBaseline1FinishDate()
                               throws BusinessObjectException
Gets the current finish date of the activity in the primary baseline. Set to the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. 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 Baseline1FinishDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1Duration

public Duration getBaseline1Duration()
                              throws BusinessObjectException
Gets the duration for the activity in the primary baseline. The duration is the total working time from the activity current start date to the current finish date. Same as the actual duration plus the remaining duration. The total working time is computed using the activity's calendar. 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 Baseline1Duration
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getExpenseCost1Variance

public Cost getExpenseCost1Variance()
                             throws BusinessObjectException
Gets the difference between primary baseline expense cost and at completion expense cost. Calculated as primary baseline expense cost - at completion expense cost (at completion expense cost = actual expense cost + remaining expense cost). 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 ExpenseCost1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLaborCost1Variance

public Cost getLaborCost1Variance()
                           throws BusinessObjectException
Gets the difference between primary baseline labor cost and at completion labor cost. Calculated as BL labor cost - at completion labor cost. 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 LaborCost1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNonLaborCost1Variance

public Cost getNonLaborCost1Variance()
                              throws BusinessObjectException
Gets the difference between the primary baseline nonlabor cost and at completion nonlabor cost. Calculated as BL nonlabor cost - at completion nonlabor cost. 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 NonLaborCost1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getMaterialCost1Variance

public Cost getMaterialCost1Variance()
                              throws BusinessObjectException
Gets the primary Baseline Planned Material Cost minus the At Completion Material Cost. 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 MaterialCost1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getTotalCost1Variance

public Cost getTotalCost1Variance()
                           throws BusinessObjectException
Gets the difference between the primary baseline total cost and the at completion total cost. Calculated as BL total cost - at completion total cost. 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 TotalCost1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLaborUnits1Variance

public Unit getLaborUnits1Variance()
                            throws BusinessObjectException
Gets the difference between primary baseline labor units and at completion labor units. Calculated as BL labor units - at completion labor 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 LaborUnits1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNonLaborUnits1Variance

public Unit getNonLaborUnits1Variance()
                               throws BusinessObjectException
Gets the difference between the primary baseline nonlabor units and at completion nonlabor units. Calculated as BL nonlabor units - at completion nonlabor 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 NonLaborUnits1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDuration1Variance

public Duration getDuration1Variance()
                              throws BusinessObjectException
Gets the duration between the activity's primary baseline duration and the at complete duration. Computed as primary baseline duration - at completion duration. 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 Duration1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getStartDate1Variance

public Duration getStartDate1Variance()
                               throws BusinessObjectException
Gets the duration between the start date in the current project and the primary baseline start date. Calculated as start date - primary baseline start date. 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 StartDate1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getFinishDate1Variance

public Duration getFinishDate1Variance()
                                throws BusinessObjectException
Gets the duration between the finish date in the current project and the primary baseline finish date. Calculated as finish date - primary baseline finish date. 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 FinishDate1Variance
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1PlannedExpenseCost

public Cost getBaseline1PlannedExpenseCost()
                                    throws BusinessObjectException
Gets the planned costs for all project expenses associated with the activity. This field is named Baseline 1 Budgeted Expense Cost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 Baseline1PlannedExpenseCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1PlannedLaborCost

public Cost getBaseline1PlannedLaborCost()
                                  throws BusinessObjectException
Gets the cost at completion for all labor resources assigned to the activity in the primary baseline. Computed from the primary baseline at completion labor units. If no resources are assigned, computed as the activity BL labor units * project default price / time. This field is named Baseline 1 Budgeted Labor Cost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 Baseline1PlannedLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1PlannedNonLaborCost

public Cost getBaseline1PlannedNonLaborCost()
                                     throws BusinessObjectException
Gets the planned costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity planned nonlabor units * project default price / time. This field is named Baseline 1 Budgeted Non Labor Cost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 Baseline1PlannedNonLaborCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1PlannedMaterialCost

public Cost getBaseline1PlannedMaterialCost()
                                     throws BusinessObjectException
Gets the Planned Material Cost for a primary baseline activity. 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 Baseline1PlannedMaterialCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1PlannedTotalCost

public Cost getBaseline1PlannedTotalCost()
                                  throws BusinessObjectException
Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses. Planned total cost = planned labor cost + planned nonlabor cost + planned expense cost. This field is named Baseline 1 Budgeted Total Cost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 Baseline1PlannedTotalCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1PlannedLaborUnits

public Unit getBaseline1PlannedLaborUnits()
                                   throws BusinessObjectException
Gets the planned units for all labor resources assigned to the activity. This field is named Baseline 1 Budgeted Labor Units in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 Baseline1PlannedLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1PlannedNonLaborUnits

public Unit getBaseline1PlannedNonLaborUnits()
                                      throws BusinessObjectException
Gets the planned units for all nonlabor resources assigned to the activity. This field is named Baseline 1 Budgeted Non Labor Units in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 Baseline1PlannedNonLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getBaseline1PlannedDuration

public Duration getBaseline1PlannedDuration()
                                     throws BusinessObjectException
Gets the planned duration for the activity in the primary baseline. Planned duration is the total working time from the activity current start date to the current finish date. Same as the actual duration plus the remaining duration. The total working time is computed using the activity's calendar. This field is named Baseline 1 Budgeted Duration in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. 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 Baseline1PlannedDuration
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

getActivitySpread

public ActivitySpread getActivitySpread()
                                 throws BusinessObjectException
Gets the live activity spread data. 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 ActivitySpread
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFCost

@Deprecated
public Cost getUDFCost(ObjectId objId)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Cost user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Cost the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFCost

@Deprecated
public void setUDFCost(ObjectId objId,
                                  Cost cost)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Cost user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
cost - the Cost value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFDouble

@Deprecated
public java.lang.Double getUDFDouble(ObjectId objId)
                              throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Double user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Double the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFDouble

@Deprecated
public void setUDFDouble(ObjectId objId,
                                    java.lang.Double n)
                  throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Double user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
n - the Double value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFFinishDate

@Deprecated
public EndDate getUDFFinishDate(ObjectId objId)
                         throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular FinishDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
EndDate the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFFinishDate

@Deprecated
public void setUDFFinishDate(ObjectId objId,
                                        EndDate date)
                      throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular FinishDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
date - the FinishDate value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFIndicator

@Deprecated
public UDFIndicator getUDFIndicator(ObjectId objId)
                             throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Indicator user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
com.primavera.integration.client.bo.enm.UDFIndicator the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFIndicator

@Deprecated
public void setUDFIndicator(ObjectId objId,
                                       UDFIndicator ind)
                     throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Indicator user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
ind - the Indicator value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFInteger

@Deprecated
public java.lang.Integer getUDFInteger(ObjectId objId)
                                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Integer user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Integer the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFInteger

@Deprecated
public void setUDFInteger(ObjectId objId,
                                     java.lang.Integer i)
                   throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Integer user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
i - the Integer value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFStartDate

@Deprecated
public BeginDate getUDFStartDate(ObjectId objId)
                          throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular StartDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
BeginDate the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFStartDate

@Deprecated
public void setUDFStartDate(ObjectId objId,
                                       BeginDate date)
                     throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular StartDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
date - the StartDate value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFText

@Deprecated
public java.lang.String getUDFText(ObjectId objId)
                            throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Text user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
String the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFText

@Deprecated
public void setUDFText(ObjectId objId,
                                  java.lang.String s)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Text user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
s - the Text value to set
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 non-code 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

getMainFields

public static java.lang.String[] getMainFields()
Gets all fields in the main group for this business object.

Returns:
String[] an array of fields in this group

getBaselineFields

public static java.lang.String[] getBaselineFields()
Gets all fields in the baseline group for this business object.

Returns:
String[] an array of fields in this group

getSpreadFields

public static java.lang.String[] getSpreadFields()
Gets all spread fields that can be specified in the spreadFields parameter of loadWithLiveSpread methods for this business object.

Returns:
String[] an array of all spread fields

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.