Class Activity
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
ConstructorsConstructorDescriptionClass constructor specifying the Session.Class constructor specifying the Session and ObjectId of the object.Class constructor called internally after objects are retrieved from the server. -
Method Summary
Modifier and TypeMethodDescriptioncreate()Creates this Activity object in the database.static ObjectId[]Creates multiple Activity objects in the database.createActivityExpense(ActivityExpense activityexpense) Creates an associated ActivityExpense object in the database.ObjectId[]createActivityExpenses(ActivityExpense[] activityexpenses) Creates multiple associated ActivityExpense objects in the database.createActivityNote(ActivityNote activitynote) Creates an associated ActivityNote object in the database.ObjectId[]createActivityNotes(ActivityNote[] activitynotes) Creates multiple associated ActivityNote objects in the database.createActivityStep(ActivityStep activitystep) Creates an associated ActivityStep object in the database.ObjectId[]createActivitySteps(ActivityStep[] activitysteps) Creates multiple associated ActivityStep objects in the database.createCopy(ObjectId projectObjectId, ObjectId wbsObjectId, String newId, CopyActivityOptions copyOptions) Copies the activity to a project node or a WBS node.createLeanTask(LeanTask leantask) Creates an associated LeanTask object in the database.ObjectId[]createLeanTasks(LeanTask[] leantasks) Creates multiple associated LeanTask objects in the database.createPredecessorRelationship(Relationship predecessorrelationship) Creates an associated Relationship object in the database.ObjectId[]createPredecessorRelationships(Relationship[] predecessorrelationships) Creates multiple associated Relationship objects in the database.createProjectDocument(ProjectDocument projectdocument) Creates an associated ProjectDocument object in the database.ObjectId[]createProjectDocuments(ProjectDocument[] projectdocuments) Creates multiple associated ProjectDocument objects in the database.createProjectIssue(ProjectIssue projectissue) Creates an associated ProjectIssue object in the database.ObjectId[]createProjectIssues(ProjectIssue[] projectissues) Creates multiple associated ProjectIssue objects in the database.createResourceAssignment(ResourceAssignment resourceassignment) Creates an associated ResourceAssignment object in the database.ObjectId[]createResourceAssignments(ResourceAssignment[] resourceassignments) Creates multiple associated ResourceAssignment objects in the database.createSuccessorRelationship(Relationship successorrelationship) Creates an associated Relationship object in the database.ObjectId[]createSuccessorRelationships(Relationship[] successorrelationships) Creates multiple associated Relationship objects in the database.voiddelete()Deletes this Activity object from the database.static voidDeletes multiple Activity objects from the database.voiddeleteActivityExpenses(ActivityExpense[] activityexpenses) Deletes multiple associated ActivityExpense objects from the database.voiddeleteActivityNotes(ActivityNote[] activitynotes) Deletes multiple associated ActivityNote objects from the database.voiddeleteActivitySteps(ActivityStep[] activitysteps) Deletes multiple associated ActivityStep objects from the database.voiddeleteLeanTasks(LeanTask[] leantasks) Deletes multiple associated LeanTask objects from the database.voiddeletePredecessorRelationships(Relationship[] predecessorrelationships) Deletes multiple associated Relationship objects from the database.voiddeleteProjectDocuments(ProjectDocument[] projectdocuments) Deletes multiple associated ProjectDocument objects from the database.voiddeleteResourceAssignments(ResourceAssignment[] resourceassignments) Deletes multiple associated ResourceAssignment objects from the database.voiddeleteSuccessorRelationships(Relationship[] successorrelationships) Deletes multiple associated Relationship objects from the database.booleandissolve()Deletes the activity without breaking the relationship chains.Gets the difference between the planned value of work scheduled and the actual cost of work performed.Gets the difference between the planned value of work scheduled and the actual work performed.Gets the live activity spread data.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).Gets the actual costs for all project expenses associated with the activity.Gets the date on which the activity is actually finished.Gets the actual costs for all labor resources assigned to the activity.Gets the actual units for all labor resources assigned to the activity.Gets the sum of all regular and overtime costs for material resources.Gets the actual costs for all nonlabor resources assigned to the activity.Gets the actual units for all nonlabor resources assigned to the activity.Gets the date on which the activity is actually started.Gets the actual this period labor cost for all labor resources assigned to the activity.Gets the actual this period labor units (hours) for all labor resources assigned to the activity.Gets the sum of all material resource costs for the current period.Gets the actual this period nonlabor cost for all nonlabor resources assigned to the activity.Gets the actual this period nonlabor units (hours) for all nonlabor resources assigned to the activity.Gets the actual total cost for the activity, including labor resources, nonlabor resources, and project expenses.Gets the sum of Actual Labor Units and Actual Nonlabor Units.static String[]Gets all non-code fields for this business object.Gets the total working time from the activity's current start date to the current finish date.Gets the sum of the actual plus remaining costs for all expenses associated with the activity.Gets the sum of the actual plus remaining costs for all labor resources assigned to the activity.Gets the sum of the actual plus remaining units for all labor resources assigned to the activity.Gets the project baseline planned total labor units minus the estimate at completion labor units.Gets the sum of all actual and remaining costs for material resources.Gets the sum of the actual plus remaining costs for all nonlabor resources assigned to the activity.Gets the sum of the actual plus remaining units for all nonlabor resources assigned to the activity.Gets the total cost at completion for the activity, including labor resources, nonlabor resources, and project expenses.Gets the sum of the actual plus remaining units for the resource assignment on the activity.Gets the difference between the project baseline total cost and the current estimate of total cost.booleanGets 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.Gets the duration for the activity in the primary baseline.Gets the current finish date of the activity in the primary baseline.Gets the planned duration for the activity in the primary baseline.Gets the planned costs for all project expenses associated with the activity.Gets the cost at completion for all labor resources assigned to the activity in the primary baseline.Gets the planned units for all labor resources assigned to the activity.Gets the Planned Material Cost for a primary baseline activity.Gets the planned costs for all nonlabor resources assigned to the activity.Gets the planned units for all nonlabor resources assigned to the activity.Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses.Gets the current start date of the activity in the primary baseline.Gets the duration for the activity in the secondary baseline.Gets the current finish date of the activity in the primary baseline.Gets the planned duration for the activity in the secondary baseline.Gets the planned costs for all project expenses associated with the activity.Gets the cost at completion for all labor resources assigned to the activity in the primary baseline.Gets the planned units for all labor resources assigned to the activity.Gets the Planned Material Cost for a primary baseline activity.Gets the planned costs for all nonlabor resources assigned to the activity.Gets the planned units for all nonlabor resources assigned to the activity.Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses.Gets the current start date of the activity in the primary baseline.Gets the duration for the activity in the tertiary baseline.Gets the current finish date of the activity in the primary baseline.Gets the planned duration for the activity in the tertiary baseline.Gets the planned costs for all project expenses associated with the activity.Gets the cost at completion for all labor resources assigned to the activity in the primary baseline.Gets the planned units for all labor resources assigned to the activity.Gets the Planned Material Cost for a primary baseline activity.Gets the planned costs for all nonlabor resources assigned to the activity.Gets the planned units for all nonlabor resources assigned to the activity.Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses.Gets the current start date of the activity in the primary baseline.Gets the duration for the activity in the project baseline.static String[]Gets all fields in the baseline group for this business object.Gets the current finish date of the activity in the project baseline.Gets the planned duration for the activity in the project baseline.Gets the planned costs for all project expenses associated with the activity.Gets the cost at completion for all labor resources assigned to the activity in the project baseline.Gets the planned units for all labor resources assigned to the activity.Gets the Planned Material Cost for a project baseline activity.Gets the planned costs for all nonlabor resources assigned to the activity.Gets the planned units for all nonlabor resources assigned to the activity.Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses.Gets the current start date of the activity in the project baseline.Gets the planned total cost through activity completion.Gets the name of the calendar.Gets the unique ID of the calendar assigned to the activity.Gets the unique name of CBS Code.getCBSId()Gets the unique Id of CBS Code.Gets the Id for CBS.Gets the percent complete of costs for all labor resources, nonlabor resources, and expenses for the activity.Gets the percent complete of planned costs for all labor resources, nonlabor resources, and expenses for the activity.doubleGets the earned value divided by the actual cost.doubleGets the ratio of the earned value labor units and the actual work performed.Gets the difference between the earned value and the actual cost of work performed.doubleGets the ratio of the cost variance and the earned value of work performed.doubleGets the ratio of the cost variance labor units and the earned value of work performed.Gets the difference between the earned value of labor units and the actual cost of labor units.Gets the date this activity was created.Gets the name of the user that created this activity.Gets the current data date for the project.static String[]Deprecated.Gets the duration between the activity's primary baseline duration and the at complete duration.Gets the duration between the activity's secondary baseline duration and the at complete duration.Gets the duration between the activity's tertiary baseline duration and the at complete duration.Gets the percent complete of the activity duration.Gets the activity actual duration percent of planned.Gets the duration type of the activity.Gets the duration between the activity's project baseline duration and the at complete duration.Gets the earliest possible date the activity can finish.Gets the earliest possible date the remaining work for the activity can begin.Gets the portion of the project baseline total cost of the activity that is actually completed as of the project data date.Gets the portion of the project baseline labor units that is actually completed as of the project data date.Gets the estimated cost at completion for the activity.Gets the estimated labor units at completion of the activity.doubleGets the estimation weight for the activity, used for top-down estimation.Gets displays the projected duration required to complete an activity based on schedule performance to date.Gets displays the projected labor effort needed to complete the remaining scope of work, based on labor efficiency to date.Gets the estimated cost to complete the activity.Gets the estimated quantity to complete the activity.Gets the date the activity is expected to be finished according to the progress made on the activity's work products.Gets the difference between primary baseline expense cost and at completion expense cost.Gets the difference between secondary baseline expense cost and at completion expense cost.Gets the difference between tertiary baseline expense cost and at completion expense cost.Gets the percent complete of costs for all expenses associated with the activity.Gets the difference between project baseline expense cost and at completion expense cost.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).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).Gets the feedback from the resource.static String[]Gets all fields that can be filtered.Gets financial Period Template Id.Gets the current finish date of the activity.Gets the duration between the finish date in the current project and the primary baseline finish date.Gets the duration between the finish date in the current project and the secondary baseline finish date.Gets the duration between the finish date in the current project and the tertiary baseline finish date.Gets the duration between the finish date in the current project and the project baseline finish date.intGets the integer representing the critical path this activity is on.intGets the integer representing the order in which this object was found on one of the critical paths.Gets the amount of time the activity can be delayed before delaying the start date of any successor activity.getGUID()Gets the globally unique ID generated by the system.booleanGets the flag that indicates whether a resource assignment on the activity has future bucket data.getId()Gets the short ID that uniquely identifies the activity within the project.static String[]An internal method that should not be called directly by client code.An internal method that should not be called directly by client code.static String[]An internal method that should not be called directly by client code.booleanGets the boolean value indicating if this business object is related to a Project or Baseline.booleanGets the flag that indicates whether the activity is critical.booleanGets the flag that indicates whether an activity is on the longest path.booleanGets the flag that indicates that a resource has sent feedback notes about this activity which have not been reviewed yet.booleanGets the flag that indicates whether this activity is marked as starred activity.booleanGets the boolean value indicating if this business object is related to a template Project.booleanGets indicates if this WBS is a workpackage in Prime or not.Gets the difference between primary baseline labor cost and at completion labor cost.Gets the difference between secondary baseline labor cost and at completion labor cost.Gets the difference between tertiary baseline labor cost and at completion labor cost.Gets the percent complete of costs for all labor resources assigned to the activity.Gets the difference between project baseline labor cost and at completion labor cost.Gets the difference between primary baseline labor units and at completion labor units.Gets the difference between secondary baseline labor units and at completion labor units.Gets the difference between tertiary baseline labor units and at completion labor units.Gets the percent complete of units for all labor resources for the activity.Gets the difference between project baseline labor units and at completion labor units.Gets the date this activity was last updated.Gets the name of the user that last updated this activity.Gets the latest possible date the activity must finish without delaying the project finish date.Gets the latest possible date the remaining work for the activity must begin without delaying the project finish date.Gets the activity priority used to prioritize activities in a project when performing resource leveling.Gets the name of the location assigned to the activity.Gets the unique ID of the location assigned to the activity.static String[]Gets all fields in the main group for this business object.Gets the primary Baseline Planned Material Cost minus the At Completion Material Cost.Gets the secondary Baseline Planned Material Cost minus the At Completion Material Cost.Gets the tertiary Baseline Planned Material Cost minus the At Completion Material Cost.Gets the percent complete of costs for all material resources assigned to the activity.Gets the project BaselinePlannedMaterialCost minus the AtCompletionMaterialCost.Gets the maximum duration of the activity.Gets the minimum duration of the activity.static String[]Gets all fields that are always exported at a minimum by the new flat XML exporterGets the most likely duration of the activity.getName()Gets the name of the activity.Gets the difference between the primary baseline nonlabor cost and at completion nonlabor cost.Gets the difference between the secondary baseline nonlabor cost and at completion nonlabor cost.Gets the difference between the tertiary baseline nonlabor cost and at completion nonlabor cost.Gets the percent complete of costs for all nonlabor resources assigned to the activity.Gets the difference between the project baseline labor cost and at completion labor cost.Gets the difference between the primary baseline nonlabor units and at completion nonlabor units.Gets the difference between the secondary baseline nonlabor units and at completion nonlabor units.Gets the difference between the tertiary baseline nonlabor units and at completion nonlabor units.Gets the percent complete of units for all nonlabor resources for the activity.Gets the difference between the project baseline labor units and at completion labor units.Gets the notes from the project manager to the timesheet resources.Gets the unique ID generated by the system.String[]String[]Gets the activity percent complete.Gets the activity percent complete type: 'Physical', 'Duration', or 'Units'.Gets the activity performance percent complete.Gets performancePercentCompleteByLaborUnits = ('Earned Value Labor Units' / 'Budget at Completion Labor Units') * 100.Gets the physical percent complete, which can either be user entered or calculated from the activity's weighted steps.Gets the total working time from the activity planned start date to the planned finish date.Gets the planned costs for all project expenses associated with the activity.Gets the date the activity is scheduled to finish.Gets the planned costs for all labor resources assigned to the activity.Gets the planned units for all labor resources assigned to the activity.Gets the sum of all material resource costs.Gets the planned costs for all nonlabor resources assigned to the activity.Gets the planned units for all nonlabor resources assigned to the activity.Gets the date the activity is scheduled to begin.Gets the planned total cost for the activity, including labor resources, nonlabor resources, and project expenses.Gets the sum of Planned Labor Units and Planned Nonlabor Units.Gets the portion of the project baseline total cost of the activity that is scheduled to be completed as of the project data date.Gets the portion of the project baseline labor units that is scheduled to be completed as of the project data date.Gets post Response Criticality Index.Gets post response Activity Pessimistic finish.Gets post response Activity Pessimistic start.Gets pre Response Criticality Index.Gets pre response Activity Pessimistic finish.Gets pre response Activity Pessimistic start.Gets the constraint date for the activity, if the activity has a constraint.Gets the type of constraint applied to the activity start or finish date.Gets the name of the resource.Gets the name of the resource.Gets the unique ID of the primary resource for the activity.Gets indicates if this WBS node a Project/EPS node?.Gets the short code of the associated project.Gets the name of the associated project.Gets project Name Separate Char.Gets the unique ID of the associated project.Gets indicates if this Project/EPS node a Project or EPS?.Gets the remaining duration of the activity.Gets the remaining late end date, which is calculated by the scheduler.Gets the date the remaining work for the activity is scheduled to begin.Gets the remaining costs for all project expenses associated with the activity.Gets the amount of time remaining by which the activity can be delayed before delaying the project finish date.Gets the remaining costs for all labor resources assigned to the activity.Gets the remaining units for all labor resources assigned to the activity.Gets the remaining late finish date calculated by the scheduler.Gets the remaining late start date calculated by the scheduler.Gets the sum of all material resource remaining costs.Gets the remaining costs for all nonlabor resources assigned to the activity.Gets the remaining units for all nonlabor resources assigned to the activity.Gets the remaining total cost for the activity, including labor resources, nonlabor resources, and project expenses.Gets the sum of Remaining Labor Units and Remaining Nonlabor Units.static String[]Gets all fields that must be set before calling create() on this business object.Gets the date when a suspended task or resource dependent activity should be resumed.Gets the finish date of the activity as proposed by the primary resource using Timesheets, while the activity is in "For Review" state.booleanGets the indicator that determines whether the activity status updates made in Team Member applications must be approved before commiting changes.Gets the activity review status.Gets the activity schedule percent complete, which specifies how much of the activity's project baseline duration has been completed so far.doubleGets the ratio of the earned value of work performed and the work scheduled to be performed.doubleGets the ratio of the earned value of labor units and the planned value of labor units.Gets the difference between the earned value of work performed and the work scheduled to be performed.doubleGets the ratio of the schedule variance and the work scheduled to be performed.doubleGets the ratio of the schedule variance and the work scheduled to be performed.Gets the difference between the earned value of work performed and the work scheduled to be performed.Gets the scope percent complete is imported from Prime via integration.Gets the date to be used for the cstr_type2 assignment, if the activity has a cstr_type2 value.Gets the additional constraint to be used by the scheduler.static String[]Gets all spread fields that can be specified in the spreadFields parameter of loadWithLiveSpread methods for this business object.Gets the start date of the activity.Gets the duration between the start date in the current project and the primary baseline start date.Gets the duration between the start date in the current project and the secondary baseline start date.Gets the duration between the start date in the current project and the tertiary baseline start date.Gets the duration between the start date in the current project and the project baseline start date.Gets the current status of the activity, either 'Not Started', 'In Progress', or 'Completed'.Gets the project status: 'Planned', 'Active', 'Inactive', 'What-If', 'Requested', or 'Template'.Gets the start date when the progress of a task or resource dependent activity is delayed from.Gets completion status of the activity.Gets status of the activity as per the activity dates.booleanGets indicates the status of the activity.doubleGets the TCPI, which is calculated as (budget at completion - earned value) / (estimate at completion - ACWP).Gets the difference between the primary baseline total cost and the at completion total cost.Gets the difference between the secondary baseline total cost and the at completion total cost.Gets the difference between the tertiary baseline total cost and the at completion total cost.Gets the difference between the project baseline total cost and the at completion total cost.Gets the amount of time the activity can be delayed before delaying the project finish date.Gets the total stored period earned value cost for each activity.Gets the total stored period earned value labor units for each activity.Gets the total stored period expense cost for each activity.Gets the total stored period labor cost for each activity.Gets the total stored period labor units for each activity.Gets the total stored period material cost for each activity.Gets the total stored period non labor cost for each activity.Gets the total stored period non labor units for each activity.Gets the total stored period planned value cost for each activity.Gets the total stored period planned value labor units for each activity.getType()Gets the type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', 'Start Milestone', 'Finish Milestone', or 'WBS Summary'.Gets the percent complete of units for all labor and nonlabor resources assigned to the activity.intGets the total number of unread comments on this activity for a user.Gets the short code assigned to each WBS element for identification.Gets the name of the WBS element.Gets the WBS name hierarchy of the Activity.Gets the unique ID of the WBS for the activity.Gets the WBS hierarchy of the Activity.Gets the ID of the workpackage coming from prime.Gets the name of the workpackage coming from prime.static String[]Gets all writable fields for this business object.static ActivityLoads a single Activity object from the database.static BOIterator<Activity>Loads multiple Activity objects from the database.loadActivityCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityCodeAssignment objects from the database.loadActivityExpenses(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityExpense objects from the database.loadActivityNotes(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityNote objects from the database.loadActivityOwner(String[] fields) Loads an associated ActivityOwner object from the database.loadActivityPeriodActuals(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityPeriodActual objects from the database.loadActivityRisks(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityRisk objects from the database.loadActivitySteps(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityStep objects from the database.loadCalendar(String[] fields) Loads an associated Calendar object from the database.loadLeanTasks(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated LeanTask objects from the database.loadLocation(String[] fields) Loads an associated Location object from the database.loadPredecessorRelationships(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated Relationship objects from the database.loadProject(String[] fields) Loads an associated Project object from the database.loadProjectDocuments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectDocument objects from the database.loadProjectIssues(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectIssue objects from the database.loadResourceAssignments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ResourceAssignment objects from the database.loadResourceAssignmentsWithLiveSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) Loads multiple associated ResourceAssignment objects with spreads from the database.loadRiskResponseActions(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated RiskResponseAction objects from the database.loadSuccessorRelationships(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated Relationship objects from the database.loadUDFValues(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated UDFValue objects from the database.Loads an associated WBS object from the database.static BOIterator<Activity>loadWithLiveSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) Loads multiple Activity objects with summarized spreads from the database.static ActivityloadWithLiveSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) Loads a Activity object with summarized spreads from the database.static BOIterator<Activity>loadWithLiveSpreadActivityOrAssignment(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) Loads multiple Activity objects with summarized spreads from the database.voidSets 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).voidSets the date on which the activity is actually finished.voidSets the actual costs for all labor resources assigned to the activity.voidSets the actual units for all labor resources assigned to the activity.voidSets the actual costs for all nonlabor resources assigned to the activity.voidSets the actual units for all nonlabor resources assigned to the activity.voidSets the date on which the activity is actually started.voidSets the actual this period labor cost for all labor resources assigned to the activity.voidSets the actual this period labor units (hours) for all labor resources assigned to the activity.voidSets the actual this period nonlabor cost for all nonlabor resources assigned to the activity.voidSets the actual this period nonlabor units (hours) for all nonlabor resources assigned to the activity.voidSets the total working time from the activity's current start date to the current finish date.voidSets the sum of the actual plus remaining costs for all labor resources assigned to the activity.voidSets the sum of the actual plus remaining units for all labor resources assigned to the activity.voidSets the sum of the actual plus remaining costs for all nonlabor resources assigned to the activity.voidSets the sum of the actual plus remaining units for all nonlabor resources assigned to the activity.voidsetAutoComputeActuals(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.voidSets the unique ID of the calendar assigned to the activity.voidsetCBSCode(String s) Sets the unique name of CBS Code.voidSets the unique Id of CBS Code.voidSets the percent complete of the activity duration.voidSets the duration type of the activity.voidSets the earliest possible date the activity can finish.voidSets the earliest possible date the remaining work for the activity can begin.voidsetEstimatedWeight(double d) Sets the estimation weight for the activity, used for top-down estimation.voidSets the date the activity is expected to be finished according to the progress made on the activity's work products.voidSets 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).voidSets 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).voidSets the feedback from the resource.voidSets the current finish date of the activity.voidSets the globally unique ID generated by the system.voidSets the short ID that uniquely identifies the activity within the project.voidsetIsNewFeedback(boolean b) Sets the flag that indicates that a resource has sent feedback notes about this activity which have not been reviewed yet.voidsetIsStarred(boolean b) Sets the flag that indicates whether this activity is marked as starred activity.voidSets the latest possible date the activity must finish without delaying the project finish date.voidSets the latest possible date the remaining work for the activity must begin without delaying the project finish date.voidSets the activity priority used to prioritize activities in a project when performing resource leveling.voidSets the unique ID of the location assigned to the activity.voidSets the maximum duration of the activity.voidSets the minimum duration of the activity.voidSets the most likely duration of the activity.voidSets the name of the activity.voidSets the percent complete of units for all nonlabor resources for the activity.voidSets the notes from the project manager to the timesheet resources.voidSets the unique ID generated by the system.voidsetOwnerIDArray(String[] s) voidsetOwnerNamesArray(String[] s) voidSets the activity percent complete.voidSets the activity percent complete type: 'Physical', 'Duration', or 'Units'.voidSets the physical percent complete, which can either be user entered or calculated from the activity's weighted steps.voidSets the total working time from the activity planned start date to the planned finish date.voidSets the date the activity is scheduled to finish.voidSets the planned costs for all labor resources assigned to the activity.voidSets the planned units for all labor resources assigned to the activity.voidSets the planned costs for all nonlabor resources assigned to the activity.voidSets the planned units for all nonlabor resources assigned to the activity.voidSets the date the activity is scheduled to begin.voidSets post Response Criticality Index.voidSets post response Activity Pessimistic finish.voidSets post response Activity Pessimistic start.voidSets pre Response Criticality Index.voidSets pre response Activity Pessimistic finish.voidSets pre response Activity Pessimistic start.voidSets the constraint date for the activity, if the activity has a constraint.voidSets the type of constraint applied to the activity start or finish date.voidSets the unique ID of the primary resource for the activity.voidSets the unique ID of the associated project.voidSets the remaining duration of the activity.voidSets the remaining late end date, which is calculated by the scheduler.voidSets the date the remaining work for the activity is scheduled to begin.voidSets the remaining costs for all labor resources assigned to the activity.voidSets the remaining units for all labor resources assigned to the activity.voidSets the remaining late finish date calculated by the scheduler.voidSets the remaining late start date calculated by the scheduler.voidSets the remaining costs for all nonlabor resources assigned to the activity.voidSets the remaining units for all nonlabor resources assigned to the activity.voidSets the date when a suspended task or resource dependent activity should be resumed.voidsetReviewRequired(boolean b) Sets the indicator that determines whether the activity status updates made in Team Member applications must be approved before commiting changes.voidSets the activity review status.voidSets the scope percent complete is imported from Prime via integration.voidSets the date to be used for the cstr_type2 assignment, if the activity has a cstr_type2 value.voidSets the additional constraint to be used by the scheduler.voidSets the start date of the activity.voidsetStatus(ActivityStatus enm) Sets the current status of the activity, either 'Not Started', 'In Progress', or 'Completed'.voidSets the start date when the progress of a task or resource dependent activity is delayed from.voidSets completion status of the activity.voidSets status of the activity as per the activity dates.voidsetTaskStatusIndicator(boolean b) Sets indicates the status of the activity.voidSets the total stored period earned value cost for each activity.voidSets the total stored period earned value labor units for each activity.voidSets the total stored period expense cost for each activity.voidSets the total stored period labor cost for each activity.voidSets the total stored period labor units for each activity.voidSets the total stored period material cost for each activity.voidSets the total stored period non labor cost for each activity.voidSets the total stored period non labor units for each activity.voidSets the total stored period planned value cost for each activity.voidSets the total stored period planned value labor units for each activity.voidsetType(ActivityType enm) Sets the type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', 'Start Milestone', 'Finish Milestone', or 'WBS Summary'.voidSets the percent complete of units for all labor and nonlabor resources assigned to the activity.voidSets the unique ID of the WBS for the activity.voidSets the ID of the workpackage coming from prime.voidSets the name of the workpackage coming from prime.toString()Returns a string representation of the object.voidupdate()Updates this Activity object in the database.static voidUpdates multiple Activity objects in the database.voidupdateActivityExpenses(ActivityExpense[] activityexpenses) Updates multiple associated ActivityExpense objects in the database.voidupdateActivityNotes(ActivityNote[] activitynotes) Updates multiple associated ActivityNote objects in the database.voidupdateActivitySteps(ActivityStep[] activitysteps) Updates multiple associated ActivityStep objects in the database.voidupdateLeanTasks(LeanTask[] leantasks) Updates multiple associated LeanTask objects in the database.voidupdatePredecessorRelationships(Relationship[] predecessorrelationships) Updates multiple associated Relationship objects in the database.voidupdateProjectDocuments(ProjectDocument[] projectdocuments) Updates multiple associated ProjectDocument objects in the database.voidupdateResourceAssignments(ResourceAssignment[] resourceassignments) Updates multiple associated ResourceAssignment objects in the database.voidupdateSuccessorRelationships(Relationship[] successorrelationships) Updates multiple associated Relationship objects in the database.Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, getMaxFieldLength, getValue, getValue, hashCode, isNull, setEarlyDate, setNullMethods inherited from class com.primavera.integration.client.BOBase
combineFields
-
Constructor Details
-
Activity
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
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 SessionobjId- 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 SessionrowSet- the PrmRowSet retrieved from the serveriIndex- the row index in the PrmRowSet associated with this business object- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
-
Method Details
-
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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadResourceAssignments
public BOIterator<ResourceAssignment> loadResourceAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ResourceAssignment objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadResourceAssignmentsWithLiveSpread
public BOIterator<ResourceAssignment> loadResourceAssignmentsWithLiveSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ResourceAssignment objects with spreads from the database.- Parameters:
nonSpreadFields- fields to loadsWhereClause- where clausesOrderBy- order-by clausespreadFields- the fields to include in the spread objectperiodType- the period of the spread data (hour, day, etc.)startDate- the start date of the spreadendDate- the end date of the spreadbIncludeCumulative- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadActivityExpenses
public BOIterator<ActivityExpense> loadActivityExpenses(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ActivityExpense objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadActivityNotes
public BOIterator<ActivityNote> loadActivityNotes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ActivityNote objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadActivitySteps
public BOIterator<ActivityStep> loadActivitySteps(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ActivityStep objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
createLeanTask
public ObjectId createLeanTask(LeanTask leantask) throws ServerException, NetworkException, BusinessObjectException Creates an associated LeanTask object in the database.- Parameters:
leantask- LeanTask object to create- Returns:
- ObjectId unique ID of the newly created LeanTask object
- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
createLeanTasks
public ObjectId[] createLeanTasks(LeanTask[] leantasks) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated LeanTask objects in the database.- Parameters:
leantasks- array of LeanTask objects to create- Returns:
- ObjectId[] array of object ids of newly created LeanTask objects
- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadLeanTasks
public BOIterator<LeanTask> loadLeanTasks(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated LeanTask objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
updateLeanTasks
public void updateLeanTasks(LeanTask[] leantasks) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated LeanTask objects in the database.- Parameters:
leantasks- array of LeanTask objects to update- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
deleteLeanTasks
public void deleteLeanTasks(LeanTask[] leantasks) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated LeanTask objects from the database.- Parameters:
leantasks- array of LeanTask objects to delete- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadActivityPeriodActuals
public BOIterator<ActivityPeriodActual> loadActivityPeriodActuals(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ActivityPeriodActual objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadProjectDocuments
public BOIterator<ProjectDocument> loadProjectDocuments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectDocument objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadPredecessorRelationships
public BOIterator<Relationship> loadPredecessorRelationships(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated Relationship objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadSuccessorRelationships
public BOIterator<Relationship> loadSuccessorRelationships(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated Relationship objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadProject
public Project loadProject(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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadCalendar
public Calendar loadCalendar(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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadActivityOwner
public ActivityOwner loadActivityOwner(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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadProjectIssues
public BOIterator<ProjectIssue> loadProjectIssues(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectIssue objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadWBS
public WBS loadWBS(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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadActivityCodeAssignments
public BOIterator<ActivityCodeAssignment> loadActivityCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ActivityCodeAssignment objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadUDFValues
public BOIterator<UDFValue> loadUDFValues(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated UDFValue objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadActivityRisks
public BOIterator<ActivityRisk> loadActivityRisks(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ActivityRisk objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadRiskResponseActions
public BOIterator<RiskResponseAction> loadRiskResponseActions(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated RiskResponseAction objects from the database.- Parameters:
fields- fields to loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadLocation
public Location loadLocation(String[] fields) throws ServerException, NetworkException, BusinessObjectException Loads an associated Location object from the database.- Parameters:
fields- fields to load- Returns:
- Location the Location object
- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
createCopy
public ObjectId createCopy(ObjectId projectObjectId, ObjectId wbsObjectId, 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.- 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 objectsServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layer
-
dissolve
Deletes the activity without breaking the relationship chains. The successors of the activity will become successors of its predecessors, and the predecessors of the activity will become predecessors of its successors.- Returns:
- boolean true if this activity is succesfully dissolved, otherwise false.
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objectsServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layer
-
getObjectId
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:
getObjectIdin classBusinessObject- Returns:
- the value in the field ObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setObjectId
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:
setObjectIdin classBusinessObject- Parameters:
o- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getWBSObjectId
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
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
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
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
-
getIsWorkPackage
Gets indicates if this WBS is a workpackage in Prime or not.- Returns:
- the value in the field IsWorkPackage
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getProjectObjectId
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
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
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
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
-
getStatusCode
Gets the project status: 'Planned', 'Active', 'Inactive', 'What-If', 'Requested', or 'Template'.- Returns:
- the value in the field StatusCode
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCalendarObjectId
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
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
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
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
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
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
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
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
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
Gets the type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', 'Start Milestone', 'Finish Milestone', or 'WBS Summary'. 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 'Start Milestone' or 'Finish 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'. A 'WBS Summary' comprises a group of activities that share a common WBS level. For example, all activities whose WBS codes start with A (A.1, A.1.1, A.1.1.2, A.2, A.3 and so forth) can be part of one WBS activity whose WBS code is A.- Returns:
- the value in the field Type
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setType
Sets the type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', 'Start Milestone', 'Finish Milestone', or 'WBS Summary'. 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 'Start Milestone' or 'Finish 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'. A 'WBS Summary' comprises a group of activities that share a common WBS level. For example, all activities whose WBS codes start with A (A.1, A.1.1, A.1.1.2, A.2, A.3 and so forth) can be part of one WBS activity whose WBS code is A.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getId
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
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
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
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
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
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
-
getReviewRequired
Gets the indicator that determines whether the activity status updates made in Team Member applications must be approved before commiting changes.- Returns:
- the value in the field ReviewRequired
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setReviewRequired
Sets the indicator that determines whether the activity status updates made in Team Member applications must be approved before commiting changes.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLevelingPriority
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
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
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
-
setReviewStatus
Sets 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.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getReviewFinishDate
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
-
setLateStartDate
Sets 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.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLateFinishDate
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
-
setLateFinishDate
Sets 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.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getEarlyStartDate
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
-
setEarlyStartDate
Sets 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.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getEarlyFinishDate
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
-
setEarlyFinishDate
Sets 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.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getStartDate
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
-
getScopePercentComplete
Gets the scope percent complete is imported from Prime via integration. 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 ScopePercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setScopePercentComplete
Sets the scope percent complete is imported from Prime via integration. 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
-
getWorkPackageId
Gets the ID of the workpackage coming from prime.- Returns:
- the value in the field WorkPackageId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setWorkPackageId
Sets the ID of the workpackage coming from prime.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getWorkPackageName
Gets the name of the workpackage coming from prime.- Returns:
- the value in the field WorkPackageName
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setWorkPackageName
Sets the name of the workpackage coming from prime.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getDurationPercentComplete
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
-
getEstimateTimeToComplete
Gets displays the projected duration required to complete an activity based on schedule performance to date. Calculated as Original Duration divided by Schedule Performance Index (SPI). This field provides an estimate of the remaining time assuming current performance trends continue. 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 EstimateTimeToComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getEstimateTimeToCompleteUnits
Gets displays the projected labor effort needed to complete the remaining scope of work, based on labor efficiency to date. Calculated as Remaining Labor Units divided by SPI (Labor). Provides a forward-looking view of labor resource demand aligned with current productivity levels. 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 EstimateTimeToCompleteUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSecondaryConstraintDate
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
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
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
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
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
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
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
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
-
getUnreadCommentCount
Gets the total number of unread comments on this activity for a user. 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 UnreadCommentCount
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getFloatPath
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
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
-
getTotalPastPeriodLaborUnits
Gets the total stored period labor units for each 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 TotalPastPeriodLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodLaborUnits
Sets the total stored period labor units for each activity. This field may not be included in the where clause or order by clause specified when loading business objects.- Parameters:
u- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalPastPeriodNonLaborUnits
Gets the total stored period non labor units for each 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 TotalPastPeriodNonLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodNonLaborUnits
Sets the total stored period non labor units for each activity. This field may not be included in the where clause or order by clause specified when loading business objects.- Parameters:
u- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalPastPeriodLaborCost
Gets the total stored period labor cost for each 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 TotalPastPeriodLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodLaborCost
Sets the total stored period labor cost for each 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
-
getTotalPastPeriodNonLaborCost
Gets the total stored period non labor cost for each 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 TotalPastPeriodNonLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodNonLaborCost
Sets the total stored period non labor cost for each 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
-
getTotalPastPeriodMaterialCost
Gets the total stored period material cost for each 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 TotalPastPeriodMaterialCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodMaterialCost
Sets the total stored period material cost for each 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
-
getTotalPastPeriodExpenseCost
Gets the total stored period expense cost for each 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 TotalPastPeriodExpenseCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodExpenseCost
Sets the total stored period expense cost for each 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
-
getTotalPastPeriodPlannedValueLaborUnits
Gets the total stored period planned value labor units for each 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 TotalPastPeriodPlannedValueLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodPlannedValueLaborUnits
Sets the total stored period planned value labor units for each activity. This field may not be included in the where clause or order by clause specified when loading business objects.- Parameters:
u- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalPastPeriodPlannedValueCost
Gets the total stored period planned value cost for each 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 TotalPastPeriodPlannedValueCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodPlannedValueCost
Sets the total stored period planned value cost for each 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
-
getTotalPastPeriodEarnedValueLaborUnits
Gets the total stored period earned value labor units for each 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 TotalPastPeriodEarnedValueLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodEarnedValueLaborUnits
Sets the total stored period earned value labor units for each activity. This field may not be included in the where clause or order by clause specified when loading business objects.- Parameters:
u- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalPastPeriodEarnedValueCostBCWP
Gets the total stored period earned value cost for each 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 TotalPastPeriodEarnedValueCostBCWP
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTotalPastPeriodEarnedValueCostBCWP
Sets the total stored period earned value cost for each 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
-
getLocationObjectId
Gets the unique ID of the location assigned to the activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.- Returns:
- the value in the field LocationObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setLocationObjectId
Sets the unique ID of the location assigned to the activity. 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
-
getLocationName
Gets the name of the location assigned to the activity.- Returns:
- the value in the field LocationName
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCreateDate
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
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
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
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
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
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
-
getBaseline2StartDate
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 Baseline2StartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline2FinishDate
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 Baseline2FinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3StartDate
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 Baseline3StartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3FinishDate
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 Baseline3FinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline1Duration
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
-
getBaseline2Duration
Gets the duration for the activity in the secondary 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 Baseline2Duration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3Duration
Gets the duration for the activity in the tertiary 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 Baseline3Duration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getExpenseCost1Variance
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
-
getExpenseCost2Variance
Gets the difference between secondary baseline expense cost and at completion expense cost. Calculated as secondary 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 ExpenseCost2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getExpenseCost3Variance
Gets the difference between tertiary baseline expense cost and at completion expense cost. Calculated as tertiary 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 ExpenseCost3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLaborCost1Variance
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
-
getLaborCost2Variance
Gets the difference between secondary 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 LaborCost2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLaborCost3Variance
Gets the difference between tertiary 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 LaborCost3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getNonLaborCost1Variance
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
-
getNonLaborCost2Variance
Gets the difference between the secondary 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 NonLaborCost2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getNonLaborCost3Variance
Gets the difference between the tertiary 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 NonLaborCost3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getMaterialCost1Variance
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
-
getMaterialCost2Variance
Gets the secondary 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 MaterialCost2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getMaterialCost3Variance
Gets the tertiary 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 MaterialCost3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalCost1Variance
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
-
getTotalCost2Variance
Gets the difference between the secondary 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 TotalCost2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalCost3Variance
Gets the difference between the tertiary 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 TotalCost3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLaborUnits1Variance
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
-
getLaborUnits2Variance
Gets the difference between secondary 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 LaborUnits2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLaborUnits3Variance
Gets the difference between tertiary 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 LaborUnits3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getNonLaborUnits1Variance
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
-
getNonLaborUnits2Variance
Gets the difference between the secondary 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 NonLaborUnits2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getNonLaborUnits3Variance
Gets the difference between the tertiary 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 NonLaborUnits3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getDuration1Variance
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
-
getDuration2Variance
Gets the duration between the activity's secondary baseline duration and the at complete duration. Computed as secondary 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 Duration2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getDuration3Variance
Gets the duration between the activity's tertiary baseline duration and the at complete duration. Computed as tertiary 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 Duration3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getStartDate1Variance
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
-
getStartDate2Variance
Gets the duration between the start date in the current project and the secondary baseline start date. Calculated as start date - secondary 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 StartDate2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getStartDate3Variance
Gets the duration between the start date in the current project and the tertiary baseline start date. Calculated as start date - tertiary 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 StartDate3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getFinishDate1Variance
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
-
getFinishDate2Variance
Gets the duration between the finish date in the current project and the secondary baseline finish date. Calculated as finish date - secondary 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 FinishDate2Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getFinishDate3Variance
Gets the duration between the finish date in the current project and the tertiary baseline finish date. Calculated as finish date - tertiary 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 FinishDate3Variance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline1PlannedExpenseCost
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
-
getBaseline2PlannedExpenseCost
Gets the planned costs for all project expenses associated with the activity. This field is named Baseline 2 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 Baseline2PlannedExpenseCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3PlannedExpenseCost
Gets the planned costs for all project expenses associated with the activity. This field is named Baseline 3 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 Baseline3PlannedExpenseCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline1PlannedLaborCost
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
-
getBaseline2PlannedLaborCost
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 2 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 Baseline2PlannedLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3PlannedLaborCost
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 3 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 Baseline3PlannedLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline1PlannedNonLaborCost
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
-
getBaseline2PlannedNonLaborCost
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 2 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 Baseline2PlannedNonLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3PlannedNonLaborCost
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 3 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 Baseline3PlannedNonLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline1PlannedMaterialCost
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
-
getBaseline2PlannedMaterialCost
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 Baseline2PlannedMaterialCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3PlannedMaterialCost
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 Baseline3PlannedMaterialCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline1PlannedTotalCost
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
-
getBaseline2PlannedTotalCost
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 2 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 Baseline2PlannedTotalCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3PlannedTotalCost
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 3 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 Baseline3PlannedTotalCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline1PlannedLaborUnits
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
-
getBaseline2PlannedLaborUnits
Gets the planned units for all labor resources assigned to the activity. This field is named Baseline 2 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 Baseline2PlannedLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3PlannedLaborUnits
Gets the planned units for all labor resources assigned to the activity. This field is named Baseline 3 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 Baseline3PlannedLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline1PlannedNonLaborUnits
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
-
getBaseline2PlannedNonLaborUnits
Gets the planned units for all nonlabor resources assigned to the activity. This field is named Baseline 2 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 Baseline2PlannedNonLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3PlannedNonLaborUnits
Gets the planned units for all nonlabor resources assigned to the activity. This field is named Baseline 3 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 Baseline3PlannedNonLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline1PlannedDuration
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
-
getBaseline2PlannedDuration
Gets the planned duration for the activity in the secondary 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 2 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 Baseline2PlannedDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaseline3PlannedDuration
Gets the planned duration for the activity in the tertiary 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 3 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 Baseline3PlannedDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getProjectFlag
Gets indicates if this WBS node a Project/EPS node?.- Returns:
- the value in the field ProjectFlag
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getProjectProjectFlag
Gets indicates if this Project/EPS node a Project or EPS?.- Returns:
- the value in the field ProjectProjectFlag
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getIsBaseline
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
-
getIsTemplate
Gets the boolean value indicating if this business object is related to a template Project.- Returns:
- the value in the field IsTemplate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityOwnerUserId
- Throws:
BusinessObjectException
-
getOwnerNamesArray
- Throws:
BusinessObjectException
-
setOwnerNamesArray
- Throws:
BusinessObjectException
-
getOwnerIDArray
- Throws:
BusinessObjectException
-
setOwnerIDArray
- Throws:
BusinessObjectException
-
getActivitySpread
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
-
getIsStarred
Gets the flag that indicates whether this activity is marked as starred activity.- Returns:
- the value in the field IsStarred
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setIsStarred
Sets the flag that indicates whether this activity is marked as starred activity.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCBSObjectId
Gets the Id for CBS. Just mapped to another random field.Doesn't get saved.- Returns:
- the value in the field CBSObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCBSId
Gets the unique Id of CBS Code. 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 CBSId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setCBSId
Sets the unique Id of CBS Code. This field may not be included in the where clause or order by clause specified when loading business objects.- Parameters:
o- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCBSCode
Gets the unique name of CBS Code.- Returns:
- the value in the field CBSCode
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setCBSCode
Sets the unique name of CBS Code.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getMinimumDuration
Gets the minimum duration of the activity.- Returns:
- the value in the field MinimumDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setMinimumDuration
Sets the minimum duration of the activity.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getMostLikelyDuration
Gets the most likely duration of the activity.- Returns:
- the value in the field MostLikelyDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setMostLikelyDuration
Sets the most likely duration of the activity.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getMaximumDuration
Gets the maximum duration of the activity.- Returns:
- the value in the field MaximumDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setMaximumDuration
Sets the maximum duration of the activity.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPreRespCriticalityIndex
Gets pre Response Criticality Index.- Returns:
- the value in the field PreRespCriticalityIndex
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setPreRespCriticalityIndex
Sets pre Response Criticality Index.- Parameters:
p- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPostRespCriticalityIndex
Gets post Response Criticality Index.- Returns:
- the value in the field PostRespCriticalityIndex
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setPostRespCriticalityIndex
Sets post Response Criticality Index.- Parameters:
p- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPreResponsePessimisticStart
Gets pre response Activity Pessimistic start.- Returns:
- the value in the field PreResponsePessimisticStart
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setPreResponsePessimisticStart
Sets pre response Activity Pessimistic start.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPreResponsePessimisticFinish
Gets pre response Activity Pessimistic finish.- Returns:
- the value in the field PreResponsePessimisticFinish
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setPreResponsePessimisticFinish
Sets pre response Activity Pessimistic finish.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPostResponsePessimisticStart
Gets post response Activity Pessimistic start.- Returns:
- the value in the field PostResponsePessimisticStart
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setPostResponsePessimisticStart
Sets post response Activity Pessimistic start.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPostResponsePessimisticFinish
Gets post response Activity Pessimistic finish.- Returns:
- the value in the field PostResponsePessimisticFinish
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setPostResponsePessimisticFinish
Sets post response Activity Pessimistic finish.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getProjectNameSepChar
Gets project Name Separate Char. 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 ProjectNameSepChar
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getWBSPath
Gets the WBS hierarchy of 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 WBSPath
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getWBSNamePath
Gets the WBS name hierarchy of 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 WBSNamePath
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPerformancePercentCompleteByLaborUnits
Gets performancePercentCompleteByLaborUnits = ('Earned Value Labor Units' / 'Budget at Completion Labor Units') * 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 PerformancePercentCompleteByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTaskStatusIndicator
Gets indicates the status of the activity.- Returns:
- the value in the field TaskStatusIndicator
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTaskStatusIndicator
Sets indicates the status of the activity.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTaskStatusDates
Gets status of the activity as per the activity dates.- Returns:
- the value in the field TaskStatusDates
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTaskStatusDates
Sets status of the activity as per the activity dates.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTaskStatusCompletion
Gets completion status of the activity.- Returns:
- the value in the field TaskStatusCompletion
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTaskStatusCompletion
Sets completion status of the activity.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getFinancialPeriodTmplId
Gets financial Period Template Id.- Returns:
- the value in the field FinancialPeriodTmplId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
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
Gets all fields that can be filtered.- Returns:
- String[] an array of filterable fields
-
getInternalDefaultLoadFields
An internal method that should not be called directly by client code.- Returns:
- String[] an internal array
-
getAllFields
Gets all non-code fields for this business object.- Returns:
- String[] an array of all fields
-
getInternalAllFields
An internal method that should not be called directly by client code.- Returns:
- String[] an internal array
-
getInternalAllFieldsSet
An internal method that should not be called directly by client code.- Returns:
- String[] an internal array
-
getBaselineFields
Gets all fields in the baseline group for this business object.- Returns:
- String[] an array of fields in this group
-
getMainFields
Gets all fields in the main group for this business object.- Returns:
- String[] an array of fields in this group
-
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
Gets all writable fields for this business object.- Returns:
- String[] an array of writable fields
-
getDefaultXMLExportFields
Deprecated.Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.- Returns:
- String[] an array of field names
-
getMinimumXMLExportFields
Gets all fields that are always exported at a minimum by the new flat XML exporter- Returns:
- String[] an array of exported fields
-
toString
Returns a string representation of the object. The output is in XML. -
create
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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 objectactivities- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
load
public static Activity load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException Loads a single Activity object from the database.- Parameters:
session- the Session objectfields- fields to loadobjId- unique ID of the Activity object- Returns:
- Activity the Activity object
- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
load
public static BOIterator<Activity> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException Loads multiple Activity objects from the database.- Parameters:
session- the Session objectfields- fields to loadobjIds- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadWithLiveSpread
public static Activity loadWithLiveSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException Loads a Activity object with summarized spreads from the database.- Parameters:
nonSpreadFields- fields to loadobjId- unique ID of the Activity objectspreadFields- the fields to include in the spread objectperiodType- the period of the spread data (hour, day, etc.)startDate- the start date of the spreadendDate- the end date of the spreadbIncludeCumulative- indicates whether to include cumulative spread data- Returns:
- Activity the Activity object
- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadWithLiveSpread
public static BOIterator<Activity> loadWithLiveSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException Loads multiple Activity objects with summarized spreads from the database.- Parameters:
nonSpreadFields- fields to loadobjIds- object ids of the Activity objectsspreadFields- the fields to include in the spread objectperiodType- the period of the spread data (hour, day, etc.)startDate- the start date of the spreadendDate- the end date of the spreadbIncludeCumulative- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
loadWithLiveSpreadActivityOrAssignment
public static BOIterator<Activity> loadWithLiveSpreadActivityOrAssignment(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException Loads multiple Activity objects with summarized spreads from the database.- Parameters:
nonSpreadFields- fields to loadobjIds- object ids of the Activity objectsspreadFields- the fields to include in the spread objectperiodType- the period of the spread data (hour, day, etc.)startDate- the start date of the spreadendDate- the end date of the spreadbIncludeCumulative- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
update
Updates this Activity object in the database.- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 objectactivities- array of Activity objects to update- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
delete
Deletes this Activity object from the database.- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 objectactivities- array of Activity objects to delete- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-