Class BaselineProject
- All Implemented Interfaces:
com.primavera.integration.client.xml.xmlexporter.ChildAccessor
A baseline is a complete copy of a project plan that you can compare to the current schedule to evaluate progress. Baselines can be used to perform cost and schedule analysis. Before you update a schedule for the first time, you should create a baseline plan in the Project Management application.
The simplest baseline plan is a complete copy, or snapshot, of the original schedule. This snapshot provides a target against which you can track a project's cost, schedule, and performance. When you create a baseline, you can save a copy of the current project to use as the baseline or you can choose to convert another project in the EPS hierarchy to a baseline for the current project.
You can save an unlimited number of baselines per project; however, the number of baselines you can actually save per project is determined by administrative preference settings, which are typically controlled by the project controls coordinator or administrator. Regardless of the number of baselines you save for a project, at any given time you can select only up to three baselines for comparison purposes. The Baselines feature includes an option for you to specify which baselines you want to use for comparison. You must select a primary baseline. The primary baseline is used for project/activity usage spreadsheets and profiles, as well as earned value calculations. Second and third baselines are not required.
Special methods are provided to help you work with baselines. If you know the object IDs activities in a project, you can load their corresponding baseline activities using the loadBaselineActivity() or loadBaselineActivities() methods. The method linkBaselineActivity() will set the Id and GUID of a baseline activity equal to that of an activity in the corresponding project.
BaselineProjects may not be directly summarized by the summarizer job service. Baseline projects will have summary data if the summarizer job service was used to summarize the project that was used to create the baseline before the baseline was created. The StartDate and FinishDate fields are based on summary data..
This business object supports user defined fields (UDFs) and codes. Use the UDFValue business object to assign UDFs, and the ProjectCodeAssignment business object to assign ProjectCodes.
-
Constructor Summary
ConstructorsConstructorDescriptionBaselineProject(Session session) Class constructor specifying the Session.BaselineProject(Session session, ObjectId objId) Class constructor specifying the Session and ObjectId of the object.BaselineProject(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) Class constructor called internally after objects are retrieved from the server. -
Method Summary
Modifier and TypeMethodDescriptioncreate()Creates this BaselineProject object in the database.static ObjectId[]create(Session session, BaselineProject[] baselineprojects) Creates multiple BaselineProject objects in the database.createProjectFunding(ProjectFunding projectfunding) Creates an associated ProjectFunding object in the database.ObjectId[]createProjectFundings(ProjectFunding[] projectfundings) Creates multiple associated ProjectFunding objects in the database.ObjectId[]createProjectLevelActivities(Activity[] projectlevelactivities) Creates multiple associated Activity objects in the database.createProjectLevelActivity(Activity projectlevelactivity) Creates an associated Activity object in the database.createProjectLevelBudgetChangeLog(ProjectBudgetChangeLog projectlevelbudgetchangelog) Creates an associated ProjectBudgetChangeLog object in the database.ObjectId[]createProjectLevelBudgetChangeLogs(ProjectBudgetChangeLog[] projectlevelbudgetchangelogs) Creates multiple associated ProjectBudgetChangeLog objects in the database.createProjectLevelIssue(ProjectIssue projectlevelissue) Creates an associated ProjectIssue object in the database.ObjectId[]createProjectLevelIssues(ProjectIssue[] projectlevelissues) Creates multiple associated ProjectIssue objects in the database.createProjectLevelNote(ProjectNote projectlevelnote) Creates an associated ProjectNote object in the database.ObjectId[]createProjectLevelNotes(ProjectNote[] projectlevelnotes) Creates multiple associated ProjectNote objects in the database.createProjectLevelSpendingPlan(ProjectSpendingPlan projectlevelspendingplan) Creates an associated ProjectSpendingPlan object in the database.ObjectId[]createProjectLevelSpendingPlans(ProjectSpendingPlan[] projectlevelspendingplans) Creates multiple associated ProjectSpendingPlan objects in the database.createProjectLevelThreshold(ProjectThreshold projectlevelthreshold) Creates an associated ProjectThreshold object in the database.ObjectId[]createProjectLevelThresholds(ProjectThreshold[] projectlevelthresholds) Creates multiple associated ProjectThreshold objects in the database.createProjectLevelWBSMilestone(WBSMilestone projectlevelwbsmilestone) Creates an associated WBSMilestone object in the database.ObjectId[]createProjectLevelWBSMilestones(WBSMilestone[] projectlevelwbsmilestones) Creates multiple associated WBSMilestone objects in the database.createRisk(Risk risk) Creates an associated Risk object in the database.ObjectId[]createRisks(Risk[] risks) Creates multiple associated Risk objects in the database.createWBSChild(WBS wbschild) Creates an associated WBS object in the database.ObjectId[]createWBSChildren(WBS[] wbschildren) Creates multiple associated WBS objects in the database.voiddelete()Deletes this BaselineProject object from the database.static voiddelete(Session session, BaselineProject[] baselineprojects) Deletes multiple BaselineProject objects from the database.voiddeleteActivities(Activity[] activities) Deletes multiple associated Activity objects from the database.voiddeleteProjectBudgetChangeLogs(ProjectBudgetChangeLog[] projectbudgetchangelogs) Deletes multiple associated ProjectBudgetChangeLog objects from the database.voiddeleteProjectFundings(ProjectFunding[] projectfundings) Deletes multiple associated ProjectFunding objects from the database.voiddeleteProjectIssues(ProjectIssue[] projectissues) Deletes multiple associated ProjectIssue objects from the database.voiddeleteProjectNotes(ProjectNote[] projectnotes) Deletes multiple associated ProjectNote objects from the database.voiddeleteProjectSpendingPlans(ProjectSpendingPlan[] projectspendingplans) Deletes multiple associated ProjectSpendingPlan objects from the database.voiddeleteProjectThresholds(ProjectThreshold[] projectthresholds) Deletes multiple associated ProjectThreshold objects from the database.voiddeleteRisks(Risk[] risks) Deletes multiple associated Risk objects from the database.voidDeletes multiple associated WBS objects from the database.voiddeleteWBSMilestones(WBSMilestone[] wbsmilestones) Deletes multiple associated WBSMilestone objects from the database.Gets the default type for activities.Gets the unique ID of the calendar assigned to new activities by default.Gets the unique ID of the cost account assigned to new activities and project expenses by default.Gets the duration type assigned to new activities by default.Gets the percent complete type assigned to new activities by default.Gets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments.booleanGets the indicator that determines whether status changes for new activities must be approved by default.booleanGets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix.intGets the increment used for auto-numbering of activity IDs.Gets the prefix used for auto-numbering of activity IDs.intGets the suffix used for auto-numbering of activity IDs.booleanGets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.booleanGets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated.Gets the name of the user who added the project to the database.static String[]Gets all non-code fields for this business object.booleanGets the indicator that determines whether status updates to activities in a project are eligible for manual approval before commiting changes.doubleGets the user-defined number field that identifies the discount rate for the project.Gets the anticipated finish date of WBS, project and EPS elements.Gets the anticipated start date of WBS, project and EPS elements.booleanGets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.Gets the default rate type when adding resource assignments to a project.Gets the name of the baseline type for this project baseline.Gets the unique ID of the baseline type.Gets the date on which the baseline project was checked out of the Project Management database.booleanGets the flag that indicates that the baseline project is currently checked out to an external file or database and is being managed remotely.Gets the unique ID of the User that checked out this baseline project.booleanGets the flag that indicates that the WBS has been summarized.booleanGets the flag that indicates whether quantities should be updated when costs are updated, if costs and quantities are linked.Gets the date this project baseline was created.Gets the name of the user that created this project baseline.Gets the duration used to determine if an activity is critical.Gets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.Gets the sum of the original budget plus the approved and pending budgets from the budget change log.Gets the current budget minus the total spending plan.Gets the current data date for the project.Gets the date on which the project was added to the Project Management database.Gets the time units associated with the project's default price per time.static String[]Deprecated.Gets the description of the Project.Gets the timescale for entering ROI spending and benefit plan.Gets the sum of the current budget values from one level lower.booleanGets enables the project to be processed by the Project Arbiter service.booleanGets the flag which, when true, causes the Summarizer service to automatically summarize the project.static String[]Gets all spread fields that can be specified in the spreadFields parameter of loadWithExpenseCategoryCBSSpread methods for this business object.Gets the field containing expense category cbs spread data for this project.static String[]Gets all fields that can be filtered.Gets the unique ID generated by the system.Gets the finish date of the baseline project.intGets the month that marks the beginning of the fiscal year for the project.Gets the alternate end date to be optionally used by the scheduler).Gets the alternate start date to be optionally used by the scheduler.getGUID()Gets the globally unique ID generated by the system.booleanGets the flag that indicates whether a resource assignment in the baseline has future bucket data.Gets the time interval for how historical project data is stored for use in P6 Analytics, could be 'Month', 'Week', 'Quarter', 'Year' and 'Financial Period'.Gets the level of historical project data that is stored for use in P6 Analytics, cab be 'None', 'Project', 'WBS' and 'Activity'.getId()Gets the short code assigned to each WBS element for identification.Gets the user-entered ETC total labor.Gets the user-entered ETC total cost.booleanGets the indicator that determines whether a WBS is synchronized or not.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.Gets the date this project baseline was last changed by Baseline Update in Project Management.Gets the unique ID of the last closed financial period for the baseline project.Gets the date the project was last leveled.Gets the date the project was last published.Gets the date the project was last scheduled.Gets the date the project was last summarized.Gets hash value for the last options used when this baseline project was updated via Update Baseline module.Gets the date this project baseline was last updated.Gets the name of the user that last updated this project baseline.intGets the priority for scheduling.booleanGets the flag that determines whether actual units and costs are linked to actual-this-period units and costs.booleanGets the flag that determines whether actual units and cost should be recalculated when percent complete changes.booleanGets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities.Gets the name of the location assigned to the project.Gets the unique ID of the location assigned to the project.static String[]Gets all fields in the main group for this business object.static String[]Gets all fields that are always exported at a minimum by the new flat XML exporterGets the date by which all project activities must finish.getName()Gets the name of the baseline project.Gets the unique ID generated by the system.Gets the name of the person/role in the organization, sometimes referred to as the "responsible manager".Gets the unique ID of the project manager from the project's OBS tree who is responsible for the WBS.Gets the original budget for the baseline project.Gets the unique ID of the project from which the project baseline was created, if the current project is a project baseline.Gets the unique ID of the Owner Resource of this baseline project.Gets the short name of the parent EPS of this project.Gets the name of the parent EPS of this project.Gets the unique ID of the parent EPS of this baseline project.Gets the planned start date of the project.booleanGets the flag that indicates whether primary resources can mark the project activities as completed.Gets the alternate start date to be optionally used by the scheduler.Gets the type of schedule the project is based on.Gets the field containing spread data for this project.Gets the sum of the original budget plus the approved and pending budgets from the budget change log.intGets a priority value the Project Arbiter service uses to determine the order in which projects are submitted to the service queue, where 1 is highest priority and 100 is lowest priority.static String[]Gets all fields that must be set before calling create() on this business object.booleanGets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started.static String[]Gets all spread fields that can be specified in the spreadFields parameter of loadWithResourceCBSSpread methods for this business object.Gets the field containing resource cbs spread data for this project.booleanGets the flag that indicates whether a resource can be assigned more than once to the same activity.Gets the name of the resource assigned to the project.booleanGets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.booleanGets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project outside Resource Manager access.booleanGets the flag that indicates whether the project's resource can use the timesheet application to update remaining units or percent complete for their activities.booleanGets the flag that indicates whether team-member's application users are allowed to staff themselves to empty role assignments in this project.Gets the calculated exposure value for the project.Gets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'.Gets the unique ID of the associated Risk Matrix.intGets the calculated risk score for the project.Gets the early finish date of the latest activity in the project, as computed by the project scheduler.static String[]Gets all spread fields that can be specified in the spreadFields parameter of loadWithSummarizedSpread methods for this business object.Gets the start date of the baseline project.Gets the project status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.Gets the the name of the user reviewing status updates.Gets the ID's of the user reviewing status updates.intGets the baseline project's priority.Gets the data date of the project when it was last summarized-only updated by summarizer.intGets the maximum level within the project's WBS to perform summarization - default to 2.Gets the Planned Value minus the Actual Cost.Gets the Planned Value Labor Units minus the Actual Units.intGets the number of activities that are currently in progress.Gets the actual duration.Gets the actual costs for all project expenses associated with the project.Gets the latest actual finish date of all activities in the project.Gets the actual cost for all labor resources assigned to the activity.Gets the actual labor units.Gets the actual units for all material resources assigned to the activity.Gets the actual units for all nonlabor resources assigned to the activity.Gets the actual nonlabor units.Gets the earliest actual start date of all activities in the project.Gets the actual this period cost (will be labor or nonlabor).Gets the actual this period labor cost.Gets the actual this period labor units.Gets the actual this period material cost.Gets the actual this period nonlabor cost.Gets the actual this period nonlabor units.Gets the actual labor cost + actual nonlabor cost + actual expense cost as of the project data date.Gets the actual total cost incurred on the activity as of the project data date, computed as Actual Labor Cost + Actual Nonlabor Cost + Actual Material Cost + Actual Expense Cost.Gets the actual total labor units for the activity as of the project data date (i.e., actual total cost by labor units).Gets the duration at completion.Gets the sum of the actual plus remaining cost for all project expenses associated with the cost account.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 material cost at completion.Gets the nonlabor cost at completion.Gets the nonlabor units at completion.Gets the estimated cost at completion for the activity.Gets the Baseline Planned Total Cost - At Completion Total Cost.intGets the number of completed activities in the baseline.Gets the planned duration for the activity in the primary baseline.Gets the planned cost for all project expenses associated with the activity in the primary baseline.Gets the current latest finish date of all activities in the project for the current baseline.intGets the number of in-progress activities in the baseline.Gets the planned cost for all labor resources assigned to the activity in the primary baseline.Gets the planned units for all labor resources assigned to the activity in the primary baseline.Gets the planned cost for all material resources assigned to the activity in the primary baseline.Gets the planned cost for all nonlabor resources assigned to the activity in the primary baseline.Gets the planned units for all nonlabor resources assigned to the activity in the primary baseline.intGets the number of activities not started in the baseline.Gets the current earliest start date of all activities in the WBS for the current baseline.Gets the Planned Total Cost for the activity in the primary baseline, including labor resources, nonlabor resources, and project expenses.Gets the Planned Total Cost through activity completion.Gets the Baseline Planned Labor Cost + Baseline Planned Nonlabor Cost + Baseline Planned Expense Cost.intGets the number of activities that have an Actual Finish in the WBS.Gets the percent complete of cost for all nonlabor resources assigned.Gets the activity actual cost percent of planned.doubleGets the Earned Value divided by the Actual Cost.doubleGets the Earned Value Labor Units / Actual Labor Units.Gets the Earned Value minus the Actual Cost.Gets the Earned Value Labor Cost minus Actual Value Labor Cost.doubleGets the value that is calculated as the Cost Variance divided by Earned Value.Gets the Cost Variance divided by Earned Value.doubleGets the Cost Variance Labor Units divided by Earned Value Labor Units.Gets the activity actual duration percent of planned.Gets the summary actual duration percent of planned of all activities under this project.Gets the duration between the activity's baseline duration and the at complete duration.Gets the Budget at Completion * Performance % Complete.Gets the portion of the baseline labor units that is actually completed as of the project data date.Gets the Actual Cost plus the Estimate to Complete Cost.Gets the Actual Labor Units + Estimate To Complete Labor Units.Gets the high forecast of Estimate At Completion (EAC) by labor units.Gets the low forecast of Estimate At Completion (EAC) by labor units.Gets the Remaining Total Cost for the activity or the Performance Factor * (Budget at Completion - Earned Value), depending on the Earned Value technique selected for the activity's WBS (calculated from the primary baseline).Gets the estimated quantity to complete the activity.Gets the percent complete of cost for all expenses associated with the project.Gets the Baseline Planned Expense Cost - At Completion Expense Cost (At Completion Expense Cost = Actual Expense Cost + Remaining Expense Cost).static String[]Gets all fields in the summary group for this business object.Gets the duration between the finish date in the current project and the baseline finish date.intGets the number of activities that are currently in progress.Gets the percent complete of cost for all labor resources assigned to the project.Gets the Baseline Planned Labor Cost - At Completion Labor Cost.Gets the percent complete of units for all labor resources for the WBS.Gets the difference between baseline labor units and at completion labor units.Gets the percent complete of cost for all material resources assigned to the project.Gets the variance that is calculated as Baseline Material Cost - At Completion Material Cost.Gets the percent complete of cost for all non-labor resources assigned to the project.Gets the Baseline Planned Nonlabor Cost - At Completion Nonlabor Cost.Gets the percent complete of units for all nonlabor resources for the Project.Gets the difference between baseline nonlabor units and at completion non labor units.intGets the number of activities that are currently not started.Gets the percent complete of units for the resource assignments in the WBS Computed as Actual Units / At Complete Units * 100.Gets the sum of all planned expense, non labor, labor, and material costs in the baseline project.Gets the total working days between planned start and finish dates in the baseline project.Gets the sum of all planned expense costs in the baseline project.Gets the latest planned finish date of all activities in the baseline project.Gets the sum of all planned labor costs in the baseline project.Gets the sum of all planned labor units in the baseline project.Gets the sum of all planned material costs in the baseline project.Gets the sum of all planned non labor costs in the baseline project.Gets the sum of all planned non labor units in the baseline project.Gets the earliest planned start date of all activities in the baseline project.Gets the Budget at Completion * Schedule % Complete.Gets the portion of the baseline labor units that is scheduled to be completed as of the project data date.Gets the date the activity is expected to be finished according to the progress made on the activity's work products.Gets the total working time from the WBS remaining start date to the remaining finish date.Gets the remaining costs for all project expenses associated with the activities in the WBS.Gets the date the resource is scheduled to finish the remaining work for the activity.Gets the remaining costs for all labor resources assigned to the activities.Gets the remaining units for all labor resources assigned to the activities.Gets the remaining material costs for all project expenses associated with the activities in the WBS.Gets the remaining nonlabor costs for all project expenses associated with the activities in the WBS.Gets the remaining units for all nonlabor resources assigned to the activities.Gets the earliest remaining start of all activities assigned to the WBS.Gets the sum of all remaining total costs in the WBS.Gets the measure that indicates how much of the WBS baseline duration has been completed so far.Gets the percent complete of cost for all labor resources, nonlabor resources, and expenses.Gets the percent complete of units for all labor resources.doubleGets the Earned Value divided by the Planned Value.doubleGets the Earned Value Labor Units divided by Planned Value Labor Units.Gets the Earned Value divided by the Planned Value.Gets the Earned Value Labor Units minus the Planned Value Labor Units.doubleGets the value that is calculated as the Schedule Variance Labor Units divided by Planned Value Labor Units.Gets the Schedule Variance divided by the Planned Value.doubleGets the Schedule Variance Labor Units divided by the Planned Value Labor Units.Gets the duration between the start date in the current project and the baseline start date.doubleGets the (Budget at Completion - Earned Value) divided by (Estimate at Completion - Actual Cost).Gets the value that is calculated as baseline total cost - total cost.Gets the amount of time the WBS can be delayed before delaying the project finish date.Gets the percent complete of units for the resource assignments in the WBS.Gets the Baseline Planned Total Labor Units minus Estimate at Completion Labor Units.Gets the list of activity fields that can be updated by the team member.Gets the indicator that determines whether team member can update activity fields, assignment fields, or both.Gets the list of assignment fields that can be updated by the team member.Gets the list of step UDF fields that are viewable by the team member.Gets the list of fields that are viewable by the team member.Gets the sum of the monthly benefit plan.Gets the sum of the monthly benefit plan tally.Gets the sum of the monthly spending plan.Gets the sum of the monthly spending plan tally.Gets the total current budget minus the distributed current budget.Gets the total spending plan minus the total spending plan tally.Gets the unique ID of the associated WBS category value.Gets the character used to separate the concatenated code fields for the project's WBS tree.Gets the internal WBS ID of the project.Gets the root directory for storing project Web site files before they are published to the Web server.Gets the project Web site URL, which is the Web address of the project's website.static String[]Gets all writable fields for this business object.voidlinkBaselineActivity(ObjectId origActivity, ObjectId baselineActivity) Link an existing Activity from BaselineProject as a baseline Activity of an original Activity.static BaselineProjectLoads a single BaselineProject object from the database.static BOIterator<BaselineProject>Loads multiple BaselineProject objects from the database.loadActivityCodeTypes(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityCodeType objects from the database.loadAllActivities(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated Activity objects from the database.loadAllActivitiesWithLiveSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) Loads multiple associated Activity objects with spreads from the database.loadAllActivityCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityCodeAssignment objects from the database.loadAllActivityComment(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityComment objects from the database.loadAllActivityExpenses(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityExpense objects from the database.loadAllActivityNotes(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityNote objects from the database.loadAllActivityOwners(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityOwner objects from the database.loadAllActivityPeriodActuals(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityPeriodActual objects from the database.loadAllActivityRisks(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityRisk objects from the database.loadAllActivitySteps(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityStep objects from the database.loadAllCBSDurationSummarys(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated CBSDurationSummary objects from the database.loadAllLeanTasks(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated LeanTask objects from the database.loadAllProjectBudgetChangeLogs(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectBudgetChangeLog objects from the database.loadAllProjectIssues(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectIssue objects from the database.loadAllProjectNotes(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectNote objects from the database.loadAllProjectResourceQuantities(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectResourceQuantity objects from the database.loadAllProjectResources(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectResource objects from the database.loadAllProjectSpendingPlans(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectSpendingPlan objects from the database.loadAllProjectThresholds(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectThreshold objects from the database.loadAllResourceAssignmentCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ResourceAssignmentCodeAssignment objects from the database.loadAllResourceAssignmentPeriodActuals(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ResourceAssignmentPeriodActual objects from the database.loadAllResourceAssignments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ResourceAssignment objects from the database.loadAllResourceAssignmentsWithLiveSpread(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.loadAllUDFValues(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated UDFValue objects from the database.loadAllWBS(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated WBS objects from the database.loadAllWBSMilestones(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated WBSMilestone objects from the database.loadAllWBSWithSummarizedSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) Loads multiple associated WBS objects with spreads from the database.Activity[]loadBaselineActivities(String[] fields, ObjectId[] origActivities) Return the corresponding linked Activities from the BaselineProject.loadBaselineActivity(String[] fields, ObjectId origActivity) Return the corresponding linked Activity from the BaselineProject.loadBaselineType(String[] fields) Loads an associated BaselineType object from the database.loadCalculatedUDFValues(UDFType[] udfTypes) Loads multiple associatedUDFValueobjectsloadDefaultCalendar(String[] fields) Loads an associated Calendar object from the database.loadDocuments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated Document objects from the database.loadIssueHistories(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated IssueHistory objects from the database.loadLocation(String[] fields) Loads an associated Location object from the database.Loads an associated OBS object from the database.loadOriginalProject(String[] fields) Loads an associated Project object from the database.loadParentEPS(String[] fields) Loads an associated EPS object from the database.loadProjectCalendars(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated Calendar objects from the database.loadProjectCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectCodeAssignment objects from the database.loadProjectDocuments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectDocument objects from the database.loadProjectFundings(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectFunding objects from the database.loadProjectLevelActivities(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated Activity objects from the database.loadProjectLevelBudgetChangeLogs(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectBudgetChangeLog objects from the database.loadProjectLevelIssues(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectIssue objects from the database.loadProjectLevelNotes(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectNote objects from the database.loadProjectLevelResources(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectResource objects from the database.loadProjectLevelSpendingPlans(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectSpendingPlan objects from the database.loadProjectLevelThresholds(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectThreshold objects from the database.loadProjectLevelUDFValues(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated UDFValue objects from the database.loadProjectLevelWBSMilestones(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated WBSMilestone objects from the database.loadRelationships(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated Relationship objects from the database.loadResourceAssignmentCodeTypes(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ResourceAssignmentCodeType objects from the database.loadResourceHours(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ResourceHour objects from the database.loadRiskImpacts(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated RiskImpact objects from the database.loadRiskMatrix(String[] fields) Loads an associated RiskMatrix object from the database.loadRiskResponseActionImpacts(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated RiskResponseActionImpact objects from the database.loadRiskResponseActions(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated RiskResponseAction objects from the database.loadRiskResponsePlans(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated RiskResponsePlan objects from the database.Loads multiple associated Risk objects from the database.loadScheduleOptions(String[] fields) Loads an associated ScheduleOptions object from the database.loadWBSChildren(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated WBS objects from the database.loadWBSChildrenWithSummarizedSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) Loads multiple associated WBS objects with spreads from the database.static BOIterator<BaselineProject>loadWithExpenseCategoryCBSSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] expensecategorycbsObjectIds) Loads multiple BaselineProject objects with summarized spreads from the database.static BaselineProjectloadWithExpenseCategoryCBSSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] expensecategorycbsObjectIds) Loads a BaselineProject object with summarized spreads from the database.static BOIterator<BaselineProject>loadWithResourceAssignmentCBSSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] resourcecbsObjectIds) Loads multiple BaselineProject objects with summarized spreads from the database.static BaselineProjectloadWithResourceAssignmentCBSSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] resourcecbsObjectIds) Loads a BaselineProject object with summarized spreads from the database.static BOIterator<BaselineProject>loadWithSpreads(Session session, String[] nonSpreadFields, ObjectId[] objIds, SpreadOptions... spreadOptions) Loads multiple BaselineProject objects with spreads from the database.static BaselineProjectloadWithSpreads(Session session, String[] nonSpreadFields, ObjectId objId, SpreadOptions... spreadOptions) Loads a BaselineProject object with spreads from the database.static BOIterator<BaselineProject>loadWithSpreads(Session session, String[] nonSpreadFields, String sWhereClause, String sOrderBy, SpreadOptions... spreadOptions) Loads multiple BaselineProject objects with spreads from the database.static BOIterator<BaselineProject>loadWithSummarizedSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) Loads multiple BaselineProject objects with summarized spreads from the database.static BaselineProjectloadWithSummarizedSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) Loads a BaselineProject object with summarized spreads from the database.restore()Restore a BaselineProject which unlinks the BaselineProject and its project and makes them separate projects.voidSets the default type for activities.voidSets the unique ID of the calendar assigned to new activities by default.voidSets the unique ID of the cost account assigned to new activities and project expenses by default.voidSets the duration type assigned to new activities by default.voidSets the percent complete type assigned to new activities by default.voidSets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments.voidsetActivityDefaultReviewRequired(boolean b) Sets the indicator that determines whether status changes for new activities must be approved by default.voidsetActivityIdBasedOnSelectedActivity(boolean b) Sets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix.voidsetActivityIdIncrement(int i) Sets the increment used for auto-numbering of activity IDs.voidSets the prefix used for auto-numbering of activity IDs.voidsetActivityIdSuffix(int i) Sets the suffix used for auto-numbering of activity IDs.voidSets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.voidsetAddActualToRemaining(boolean b) Sets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated.voidsetAddedBy(String s) Sets the name of the user who added the project to the database.voidsetAllowStatusReview(boolean b) Sets the indicator that determines whether status updates to activities in a project are eligible for manual approval before commiting changes.voidsetAnnualDiscountRate(double d) Sets the user-defined number field that identifies the discount rate for the project.voidSets the anticipated finish date of WBS, project and EPS elements.voidSets the anticipated start date of WBS, project and EPS elements.voidsetAssignmentDefaultDrivingFlag(boolean b) Sets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.voidSets the default rate type when adding resource assignments to a project.voidSets the unique ID of the baseline type.voidsetCostQuantityRecalculateFlag(boolean b) Sets the flag that indicates whether quantities should be updated when costs are updated, if costs and quantities are linked.voidSets the duration used to determine if an activity is critical.voidSets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.voidsetDataDate(Date d) Sets the current data date for the project.voidsetDateAdded(Date d) Sets the date on which the project was added to the Project Management database.voidSets the time units associated with the project's default price per time.voidSets the description of the Project.voidSets the timescale for entering ROI spending and benefit plan.voidsetEnablePublication(boolean b) Sets enables the project to be processed by the Project Arbiter service.voidsetEnableSummarization(boolean b) Sets the flag which, when true, causes the Summarizer service to automatically summarize the project.voidSets the unique ID generated by the system.voidsetFiscalYearStartMonth(int i) Sets the month that marks the beginning of the fiscal year for the project.voidSets the globally unique ID generated by the system.voidSets the time interval for how historical project data is stored for use in P6 Analytics, could be 'Month', 'Week', 'Quarter', 'Year' and 'Financial Period'.voidSets the level of historical project data that is stored for use in P6 Analytics, cab be 'None', 'Project', 'WBS' and 'Activity'.voidSets the short code assigned to each WBS element for identification.voidSets the user-entered ETC total labor.voidSets the user-entered ETC total cost.voidsetIntegratedWBS(boolean b) Sets the indicator that determines whether a WBS is synchronized or not.voidSets the date this project baseline was last changed by Baseline Update in Project Management.voidSets the unique ID of the last closed financial period for the baseline project.voidSets hash value for the last options used when this baseline project was updated via Update Baseline module.voidsetLevelingPriority(int i) Sets the priority for scheduling.voidsetLinkActualToActualThisPeriod(boolean b) Sets the flag that determines whether actual units and costs are linked to actual-this-period units and costs.voidsetLinkPercentCompleteWithActual(boolean b) Sets the flag that determines whether actual units and cost should be recalculated when percent complete changes.voidsetLinkPlannedAndAtCompletionFlag(boolean b) Sets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities.voidSets the unique ID of the location assigned to the project.voidSets the date by which all project activities must finish.voidSets the name of the baseline project.voidSets the unique ID generated by the system.voidSets the unique ID of the project manager from the project's OBS tree who is responsible for the WBS.voidSets the original budget for the baseline project.voidSets the unique ID of the project from which the project baseline was created, if the current project is a project baseline.voidSets the unique ID of the Owner Resource of this baseline project.voidSets the unique ID of the parent EPS of this baseline project.voidSets the planned start date of the project.voidSets the flag that indicates whether primary resources can mark the project activities as completed.voidSets the alternate start date to be optionally used by the scheduler.voidSets the type of schedule the project is based on.voidsetPublicationPriority(int i) Sets a priority value the Project Arbiter service uses to determine the order in which projects are submitted to the service queue, where 1 is highest priority and 100 is lowest priority.voidsetResetPlannedToRemainingFlag(boolean b) Sets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started.voidSets the flag that indicates whether a resource can be assigned more than once to the same activity.voidsetResourcesCanAssignThemselvesToActivities(boolean b) Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.voidSets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project outside Resource Manager access.voidsetResourcesCanEditAssignmentPercentComplete(boolean b) Sets the flag that indicates whether the project's resource can use the timesheet application to update remaining units or percent complete for their activities.voidsetResourcesCanStaffRoleAssignment(boolean b) Sets the flag that indicates whether team-member's application users are allowed to staff themselves to empty role assignments in this project.voidSets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'.voidSets the unique ID of the associated Risk Matrix.voidSets the early finish date of the latest activity in the project, as computed by the project scheduler.voidsetStatus(ProjectStatus enm) Sets the project status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.voidSets the the name of the user reviewing status updates.voidSets the ID's of the user reviewing status updates.voidsetStrategicPriority(int i) Sets the baseline project's priority.voidSets the list of activity fields that can be updated by the team member.voidSets the indicator that determines whether team member can update activity fields, assignment fields, or both.voidSets the list of assignment fields that can be updated by the team member.voidSets the list of step UDF fields that are viewable by the team member.voidSets the list of fields that are viewable by the team member.voidSets the unique ID of the associated WBS category value.voidSets the character used to separate the concatenated code fields for the project's WBS tree.voidSets the root directory for storing project Web site files before they are published to the Web server.voidSets the project Web site URL, which is the Web address of the project's website.toString()Returns a string representation of the object.voidupdate()Updates this BaselineProject object in the database.static voidupdate(Session session, BaselineProject[] baselineprojects) Updates multiple BaselineProject objects in the database.voidupdateAllActivities(Activity[] allactivities) Updates multiple associated Activity objects in the database.voidupdateAllWBS(WBS[] allwbs) Updates multiple associated WBS objects in the database.voidupdateProjectFundings(ProjectFunding[] projectfundings) Updates multiple associated ProjectFunding objects in the database.voidupdateProjectLevelBudgetChangeLogs(ProjectBudgetChangeLog[] projectlevelbudgetchangelogs) Updates multiple associated ProjectBudgetChangeLog objects in the database.voidupdateProjectLevelIssues(ProjectIssue[] projectlevelissues) Updates multiple associated ProjectIssue objects in the database.voidupdateProjectLevelNotes(ProjectNote[] projectlevelnotes) Updates multiple associated ProjectNote objects in the database.voidupdateProjectLevelSpendingPlans(ProjectSpendingPlan[] projectlevelspendingplans) Updates multiple associated ProjectSpendingPlan objects in the database.voidupdateProjectLevelThresholds(ProjectThreshold[] projectlevelthresholds) Updates multiple associated ProjectThreshold objects in the database.voidupdateProjectLevelWBSMilestones(WBSMilestone[] projectlevelwbsmilestones) Updates multiple associated WBSMilestone objects in the database.voidupdateRisks(Risk[] risks) Updates multiple associated Risk 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
-
BaselineProject
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
-
BaselineProject
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
-
BaselineProject
public BaselineProject(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
-
loadOriginalProject
public Project loadOriginalProject(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
-
loadParentEPS
public EPS loadParentEPS(String[] fields) throws ServerException, NetworkException, BusinessObjectException Loads an associated EPS object from the database.- Parameters:
fields- fields to load- Returns:
- EPS the EPS 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
-
loadAllWBS
public BOIterator<WBS> loadAllWBS(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated WBS 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
-
loadAllWBSWithSummarizedSpread
public BOIterator<WBS> loadAllWBSWithSummarizedSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated WBS 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
-
updateAllWBS
public void updateAllWBS(WBS[] allwbs) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated WBS objects in the database.- Parameters:
allwbs- array of WBS 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
-
deleteWBS
Deletes multiple associated WBS objects from the database.- Parameters:
wbs- array of WBS 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
-
createWBSChild
public ObjectId createWBSChild(WBS wbschild) throws ServerException, NetworkException, BusinessObjectException Creates an associated WBS object in the database.- Parameters:
wbschild- WBSChild object to create- Returns:
- ObjectId unique ID of the newly created 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
-
createWBSChildren
public ObjectId[] createWBSChildren(WBS[] wbschildren) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated WBS objects in the database.- Parameters:
wbschildren- array of WBSChild objects to create- Returns:
- ObjectId[] array of object ids of newly created WBS 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
-
loadWBSChildren
public BOIterator<WBS> loadWBSChildren(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated WBS 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
-
loadWBSChildrenWithSummarizedSpread
public BOIterator<WBS> loadWBSChildrenWithSummarizedSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated WBS 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
-
loadAllProjectThresholds
public BOIterator<ProjectThreshold> loadAllProjectThresholds(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectThreshold 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
-
deleteProjectThresholds
public void deleteProjectThresholds(ProjectThreshold[] projectthresholds) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated ProjectThreshold objects from the database.- Parameters:
projectthresholds- array of ProjectThreshold 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
-
createProjectLevelThreshold
public ObjectId createProjectLevelThreshold(ProjectThreshold projectlevelthreshold) throws ServerException, NetworkException, BusinessObjectException Creates an associated ProjectThreshold object in the database.- Parameters:
projectlevelthreshold- ProjectLevelThreshold object to create- Returns:
- ObjectId unique ID of the newly created ProjectThreshold 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
-
createProjectLevelThresholds
public ObjectId[] createProjectLevelThresholds(ProjectThreshold[] projectlevelthresholds) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated ProjectThreshold objects in the database.- Parameters:
projectlevelthresholds- array of ProjectLevelThreshold objects to create- Returns:
- ObjectId[] array of object ids of newly created ProjectThreshold 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
-
loadProjectLevelThresholds
public BOIterator<ProjectThreshold> loadProjectLevelThresholds(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectThreshold 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
-
updateProjectLevelThresholds
public void updateProjectLevelThresholds(ProjectThreshold[] projectlevelthresholds) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated ProjectThreshold objects in the database.- Parameters:
projectlevelthresholds- array of ProjectThreshold 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
-
loadAllActivities
public BOIterator<Activity> loadAllActivities(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated Activity 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
-
loadAllActivitiesWithLiveSpread
public BOIterator<Activity> loadAllActivitiesWithLiveSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated Activity 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
-
updateAllActivities
public void updateAllActivities(Activity[] allactivities) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated Activity objects in the database.- Parameters:
allactivities- 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
-
deleteActivities
public void deleteActivities(Activity[] activities) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated Activity objects from the database.- Parameters:
activities- 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
-
createProjectLevelActivity
public ObjectId createProjectLevelActivity(Activity projectlevelactivity) throws ServerException, NetworkException, BusinessObjectException Creates an associated Activity object in the database.- Parameters:
projectlevelactivity- ProjectLevelActivity object to create- Returns:
- ObjectId 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
-
createProjectLevelActivities
public ObjectId[] createProjectLevelActivities(Activity[] projectlevelactivities) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated Activity objects in the database.- Parameters:
projectlevelactivities- array of ProjectLevelActivity objects to create- Returns:
- ObjectId[] array of object 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
-
loadProjectLevelActivities
public BOIterator<Activity> loadProjectLevelActivities(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated Activity 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
-
loadOBS
public OBS loadOBS(String[] fields) throws ServerException, NetworkException, BusinessObjectException Loads an associated OBS object from the database.- Parameters:
fields- fields to load- Returns:
- OBS the OBS 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
-
createProjectLevelIssue
public ObjectId createProjectLevelIssue(ProjectIssue projectlevelissue) throws ServerException, NetworkException, BusinessObjectException Creates an associated ProjectIssue object in the database.- Parameters:
projectlevelissue- ProjectLevelIssue 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
-
createProjectLevelIssues
public ObjectId[] createProjectLevelIssues(ProjectIssue[] projectlevelissues) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated ProjectIssue objects in the database.- Parameters:
projectlevelissues- array of ProjectLevelIssue 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
-
loadProjectLevelIssues
public BOIterator<ProjectIssue> loadProjectLevelIssues(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
-
updateProjectLevelIssues
public void updateProjectLevelIssues(ProjectIssue[] projectlevelissues) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated ProjectIssue objects in the database.- Parameters:
projectlevelissues- array of ProjectIssue 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
-
deleteProjectIssues
public void deleteProjectIssues(ProjectIssue[] projectissues) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated ProjectIssue objects from the database.- Parameters:
projectissues- array of ProjectIssue 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
-
loadAllProjectIssues
public BOIterator<ProjectIssue> loadAllProjectIssues(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
-
createProjectLevelBudgetChangeLog
public ObjectId createProjectLevelBudgetChangeLog(ProjectBudgetChangeLog projectlevelbudgetchangelog) throws ServerException, NetworkException, BusinessObjectException Creates an associated ProjectBudgetChangeLog object in the database.- Parameters:
projectlevelbudgetchangelog- ProjectLevelBudgetChangeLog object to create- Returns:
- ObjectId unique ID of the newly created ProjectBudgetChangeLog 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
-
createProjectLevelBudgetChangeLogs
public ObjectId[] createProjectLevelBudgetChangeLogs(ProjectBudgetChangeLog[] projectlevelbudgetchangelogs) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated ProjectBudgetChangeLog objects in the database.- Parameters:
projectlevelbudgetchangelogs- array of ProjectLevelBudgetChangeLog objects to create- Returns:
- ObjectId[] array of object ids of newly created ProjectBudgetChangeLog 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
-
loadProjectLevelBudgetChangeLogs
public BOIterator<ProjectBudgetChangeLog> loadProjectLevelBudgetChangeLogs(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectBudgetChangeLog 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
-
updateProjectLevelBudgetChangeLogs
public void updateProjectLevelBudgetChangeLogs(ProjectBudgetChangeLog[] projectlevelbudgetchangelogs) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated ProjectBudgetChangeLog objects in the database.- Parameters:
projectlevelbudgetchangelogs- array of ProjectBudgetChangeLog 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
-
deleteProjectBudgetChangeLogs
public void deleteProjectBudgetChangeLogs(ProjectBudgetChangeLog[] projectbudgetchangelogs) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated ProjectBudgetChangeLog objects from the database.- Parameters:
projectbudgetchangelogs- array of ProjectBudgetChangeLog 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
-
loadAllProjectBudgetChangeLogs
public BOIterator<ProjectBudgetChangeLog> loadAllProjectBudgetChangeLogs(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectBudgetChangeLog 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
-
createProjectFunding
public ObjectId createProjectFunding(ProjectFunding projectfunding) throws ServerException, NetworkException, BusinessObjectException Creates an associated ProjectFunding object in the database.- Parameters:
projectfunding- ProjectFunding object to create- Returns:
- ObjectId unique ID of the newly created ProjectFunding 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
-
createProjectFundings
public ObjectId[] createProjectFundings(ProjectFunding[] projectfundings) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated ProjectFunding objects in the database.- Parameters:
projectfundings- array of ProjectFunding objects to create- Returns:
- ObjectId[] array of object ids of newly created ProjectFunding 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
-
loadProjectFundings
public BOIterator<ProjectFunding> loadProjectFundings(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectFunding 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
-
updateProjectFundings
public void updateProjectFundings(ProjectFunding[] projectfundings) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated ProjectFunding objects in the database.- Parameters:
projectfundings- array of ProjectFunding 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
-
deleteProjectFundings
public void deleteProjectFundings(ProjectFunding[] projectfundings) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated ProjectFunding objects from the database.- Parameters:
projectfundings- array of ProjectFunding 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
-
createProjectLevelNote
public ObjectId createProjectLevelNote(ProjectNote projectlevelnote) throws ServerException, NetworkException, BusinessObjectException Creates an associated ProjectNote object in the database.- Parameters:
projectlevelnote- ProjectLevelNote object to create- Returns:
- ObjectId unique ID of the newly created ProjectNote 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
-
createProjectLevelNotes
public ObjectId[] createProjectLevelNotes(ProjectNote[] projectlevelnotes) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated ProjectNote objects in the database.- Parameters:
projectlevelnotes- array of ProjectLevelNote objects to create- Returns:
- ObjectId[] array of object ids of newly created ProjectNote 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
-
loadProjectLevelNotes
public BOIterator<ProjectNote> loadProjectLevelNotes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectNote 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
-
updateProjectLevelNotes
public void updateProjectLevelNotes(ProjectNote[] projectlevelnotes) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated ProjectNote objects in the database.- Parameters:
projectlevelnotes- array of ProjectNote 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
-
deleteProjectNotes
public void deleteProjectNotes(ProjectNote[] projectnotes) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated ProjectNote objects from the database.- Parameters:
projectnotes- array of ProjectNote 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
-
loadAllProjectNotes
public BOIterator<ProjectNote> loadAllProjectNotes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectNote 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
-
loadProjectLevelResources
public BOIterator<ProjectResource> loadProjectLevelResources(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectResource 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
-
loadAllProjectResources
public BOIterator<ProjectResource> loadAllProjectResources(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectResource 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
-
loadAllProjectResourceQuantities
public BOIterator<ProjectResourceQuantity> loadAllProjectResourceQuantities(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectResourceQuantity 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
-
createProjectLevelWBSMilestone
public ObjectId createProjectLevelWBSMilestone(WBSMilestone projectlevelwbsmilestone) throws ServerException, NetworkException, BusinessObjectException Creates an associated WBSMilestone object in the database.- Parameters:
projectlevelwbsmilestone- ProjectLevelWBSMilestone object to create- Returns:
- ObjectId unique ID of the newly created WBSMilestone 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
-
createProjectLevelWBSMilestones
public ObjectId[] createProjectLevelWBSMilestones(WBSMilestone[] projectlevelwbsmilestones) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated WBSMilestone objects in the database.- Parameters:
projectlevelwbsmilestones- array of ProjectLevelWBSMilestone objects to create- Returns:
- ObjectId[] array of object ids of newly created WBSMilestone 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
-
loadProjectLevelWBSMilestones
public BOIterator<WBSMilestone> loadProjectLevelWBSMilestones(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated WBSMilestone 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
-
updateProjectLevelWBSMilestones
public void updateProjectLevelWBSMilestones(WBSMilestone[] projectlevelwbsmilestones) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated WBSMilestone objects in the database.- Parameters:
projectlevelwbsmilestones- array of WBSMilestone 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
-
deleteWBSMilestones
public void deleteWBSMilestones(WBSMilestone[] wbsmilestones) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated WBSMilestone objects from the database.- Parameters:
wbsmilestones- array of WBSMilestone 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
-
loadAllWBSMilestones
public BOIterator<WBSMilestone> loadAllWBSMilestones(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated WBSMilestone 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
-
loadAllActivityExpenses
public BOIterator<ActivityExpense> loadAllActivityExpenses(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
-
loadAllActivityComment
public BOIterator<ActivityComment> loadAllActivityComment(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ActivityComment 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
-
loadAllActivityNotes
public BOIterator<ActivityNote> loadAllActivityNotes(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
-
loadAllActivitySteps
public BOIterator<ActivityStep> loadAllActivitySteps(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
-
loadAllLeanTasks
public BOIterator<LeanTask> loadAllLeanTasks(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
-
loadAllActivityOwners
public BOIterator<ActivityOwner> loadAllActivityOwners(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ActivityOwner 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
-
loadAllResourceAssignments
public BOIterator<ResourceAssignment> loadAllResourceAssignments(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
-
loadAllResourceAssignmentsWithLiveSpread
public BOIterator<ResourceAssignment> loadAllResourceAssignmentsWithLiveSpread(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
-
loadAllActivityPeriodActuals
public BOIterator<ActivityPeriodActual> loadAllActivityPeriodActuals(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
-
loadAllResourceAssignmentPeriodActuals
public BOIterator<ResourceAssignmentPeriodActual> loadAllResourceAssignmentPeriodActuals(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ResourceAssignmentPeriodActual 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
-
loadAllActivityCodeAssignments
public BOIterator<ActivityCodeAssignment> loadAllActivityCodeAssignments(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
-
loadAllUDFValues
public BOIterator<UDFValue> loadAllUDFValues(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
-
loadProjectLevelUDFValues
public BOIterator<UDFValue> loadProjectLevelUDFValues(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
-
loadResourceHours
public BOIterator<ResourceHour> loadResourceHours(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ResourceHour 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
-
loadScheduleOptions
public ScheduleOptions loadScheduleOptions(String[] fields) throws ServerException, NetworkException, BusinessObjectException Loads an associated ScheduleOptions object from the database.- Parameters:
fields- fields to load- Returns:
- ScheduleOptions the ScheduleOptions 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
-
loadDefaultCalendar
public Calendar loadDefaultCalendar(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
-
loadProjectCalendars
public BOIterator<Calendar> loadProjectCalendars(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated Calendar 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
-
loadActivityCodeTypes
public BOIterator<ActivityCodeType> loadActivityCodeTypes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ActivityCodeType 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
-
loadIssueHistories
public BOIterator<IssueHistory> loadIssueHistories(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated IssueHistory 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
-
createProjectLevelSpendingPlan
public ObjectId createProjectLevelSpendingPlan(ProjectSpendingPlan projectlevelspendingplan) throws ServerException, NetworkException, BusinessObjectException Creates an associated ProjectSpendingPlan object in the database.- Parameters:
projectlevelspendingplan- ProjectLevelSpendingPlan object to create- Returns:
- ObjectId unique ID of the newly created ProjectSpendingPlan 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
-
createProjectLevelSpendingPlans
public ObjectId[] createProjectLevelSpendingPlans(ProjectSpendingPlan[] projectlevelspendingplans) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated ProjectSpendingPlan objects in the database.- Parameters:
projectlevelspendingplans- array of ProjectLevelSpendingPlan objects to create- Returns:
- ObjectId[] array of object ids of newly created ProjectSpendingPlan 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
-
loadProjectLevelSpendingPlans
public BOIterator<ProjectSpendingPlan> loadProjectLevelSpendingPlans(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectSpendingPlan 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
-
updateProjectLevelSpendingPlans
public void updateProjectLevelSpendingPlans(ProjectSpendingPlan[] projectlevelspendingplans) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated ProjectSpendingPlan objects in the database.- Parameters:
projectlevelspendingplans- array of ProjectSpendingPlan 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
-
loadAllProjectSpendingPlans
public BOIterator<ProjectSpendingPlan> loadAllProjectSpendingPlans(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectSpendingPlan 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
-
deleteProjectSpendingPlans
public void deleteProjectSpendingPlans(ProjectSpendingPlan[] projectspendingplans) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated ProjectSpendingPlan objects from the database.- Parameters:
projectspendingplans- array of ProjectSpendingPlan 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
-
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
-
loadDocuments
public BOIterator<Document> loadDocuments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated Document 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
-
loadProjectCodeAssignments
public BOIterator<ProjectCodeAssignment> loadProjectCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ProjectCodeAssignment 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
-
loadBaselineType
public BaselineType loadBaselineType(String[] fields) throws ServerException, NetworkException, BusinessObjectException Loads an associated BaselineType object from the database.- Parameters:
fields- fields to load- Returns:
- BaselineType the BaselineType 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
-
loadAllActivityRisks
public BOIterator<ActivityRisk> loadAllActivityRisks(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
-
loadRiskResponsePlans
public BOIterator<RiskResponsePlan> loadRiskResponsePlans(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated RiskResponsePlan 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
-
createRisk
public ObjectId createRisk(Risk risk) throws ServerException, NetworkException, BusinessObjectException Creates an associated Risk object in the database.- Parameters:
risk- Risk object to create- Returns:
- ObjectId unique ID of the newly created Risk 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
-
createRisks
public ObjectId[] createRisks(Risk[] risks) throws ServerException, NetworkException, BusinessObjectException Creates multiple associated Risk objects in the database.- Parameters:
risks- array of Risk objects to create- Returns:
- ObjectId[] array of object ids of newly created Risk 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
-
loadRisks
public BOIterator<Risk> loadRisks(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated Risk 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
-
updateRisks
public void updateRisks(Risk[] risks) throws ServerException, NetworkException, BusinessObjectException Updates multiple associated Risk objects in the database.- Parameters:
risks- array of Risk 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
-
deleteRisks
public void deleteRisks(Risk[] risks) throws ServerException, NetworkException, BusinessObjectException Deletes multiple associated Risk objects from the database.- Parameters:
risks- array of Risk 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
-
loadRiskImpacts
public BOIterator<RiskImpact> loadRiskImpacts(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated RiskImpact 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
-
loadRiskResponseActionImpacts
public BOIterator<RiskResponseActionImpact> loadRiskResponseActionImpacts(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated RiskResponseActionImpact 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
-
loadRiskMatrix
public RiskMatrix loadRiskMatrix(String[] fields) throws ServerException, NetworkException, BusinessObjectException Loads an associated RiskMatrix object from the database.- Parameters:
fields- fields to load- Returns:
- RiskMatrix the RiskMatrix 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
-
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
-
loadAllCBSDurationSummarys
public BOIterator<CBSDurationSummary> loadAllCBSDurationSummarys(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated CBSDurationSummary 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
-
loadAllResourceAssignmentCodeAssignments
public BOIterator<ResourceAssignmentCodeAssignment> loadAllResourceAssignmentCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ResourceAssignmentCodeAssignment 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
-
loadResourceAssignmentCodeTypes
public BOIterator<ResourceAssignmentCodeType> loadResourceAssignmentCodeTypes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated ResourceAssignmentCodeType 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
-
loadRelationships
public BOIterator<Relationship> loadRelationships(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException Loads multiple associated Relationship objects from the database.- Specified by:
loadRelationshipsin interfacecom.primavera.integration.client.xml.xmlexporter.ChildAccessor- Overrides:
loadRelationshipsin classcom.primavera.integration.client.bo.base.BaselineProjectBase- Parameters:
fields- array of field namessWhereClause- where clausesOrderBy- order by clause- Returns:
- BOIterator that contains Relationships
- Throws:
ServerExceptionNetworkExceptionBusinessObjectException
-
loadBaselineActivity
public Activity loadBaselineActivity(String[] fields, ObjectId origActivity) throws ServerException, NetworkException, BusinessObjectException Return the corresponding linked Activity from the BaselineProject.- Parameters:
fields- array of field namesorigActivity- original Activity- Returns:
- corresponding baseline Activity
- Throws:
BusinessObjectException- if the activity does not exist as a linked activity in the baseline projectServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layer
-
loadBaselineActivities
public Activity[] loadBaselineActivities(String[] fields, ObjectId[] origActivities) throws ServerException, NetworkException, BusinessObjectException Return the corresponding linked Activities from the BaselineProject.- Parameters:
fields- array of field namesorigActivities- original Activities- Returns:
- corresponding baseline Activities
- Throws:
BusinessObjectException- if one of the activities does not exist as a linked activity in the baseline projectServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layer
-
linkBaselineActivity
public void linkBaselineActivity(ObjectId origActivity, ObjectId baselineActivity) throws ServerException, NetworkException, BusinessObjectException Link an existing Activity from BaselineProject as a baseline Activity of an original Activity.- Parameters:
origActivity- original ActivitybaselineActivity- Activity from BaselineProject to link as a baseline Activity- Throws:
ServerExceptionNetworkExceptionBusinessObjectException
-
restore
Restore a BaselineProject which unlinks the BaselineProject and its project and makes them separate projects.- Returns:
- ObjectId the unique ID of the Project that the BaselineProject has become (which is the same as the ID of the BaselineProject)
- Throws:
ServerExceptionNetworkExceptionBusinessObjectException
-
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 internal WBS ID of the project. This ID cannot be used to load a WBS object directly. This field is automatically loaded by default whenever this type of business object is loaded from the database.- Returns:
- the value in the field WBSObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getParentEPSObjectId
Gets the unique ID of the parent EPS of this baseline 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 ParentEPSObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setParentEPSObjectId
Sets the unique ID of the parent EPS of this baseline 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
-
getParentEPSId
Gets the short name of the parent EPS of this 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 ParentEPSId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getParentEPSName
Gets the name of the parent EPS of this 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 ParentEPSName
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getBaselineTypeObjectId
Gets the unique ID of the baseline type. This field is automatically loaded by default whenever this type of business object is loaded from the database.- Returns:
- the value in the field BaselineTypeObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setBaselineTypeObjectId
Sets the unique ID of the baseline type. 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
-
getBaselineTypeName
Gets the name of the baseline type for this project baseline. Baseline types are used to categorize project baselines. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field BaselineTypeName
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getOriginalProjectObjectId
Gets the unique ID of the project from which the project baseline was created, if the current project is a project baseline. This field is automatically loaded by default whenever this type of business object is loaded from the database.- Returns:
- the value in the field OriginalProjectObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setOriginalProjectObjectId
Sets the unique ID of the project from which the project baseline was created, if the current project is a project baseline. 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
-
getActivityDefaultCalendarObjectId
Gets the unique ID of the calendar assigned to new activities by default. Can be null for EPS and baselines. This field is automatically loaded by default whenever this type of business object is loaded from the database.- Returns:
- the value in the field ActivityDefaultCalendarObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityDefaultCalendarObjectId
Sets the unique ID of the calendar assigned to new activities by default. Can be null for EPS and baselines. 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
-
getActivityDefaultCostAccountObjectId
Gets the unique ID of the cost account assigned to new activities and project expenses by default.- Returns:
- the value in the field ActivityDefaultCostAccountObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityDefaultCostAccountObjectId
Sets the unique ID of the cost account assigned to new activities and project expenses by default.- Parameters:
o- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getName
Gets the name of the baseline project.- 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 baseline project.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getId
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 Id
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setId
Sets 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.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getOBSObjectId
Gets the unique ID of the project manager from the project's OBS tree who is responsible for the WBS. This field is automatically loaded by default whenever this type of business object is loaded from the database.- Returns:
- the value in the field OBSObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setOBSObjectId
Sets the unique ID of the project manager from the project's OBS tree who is responsible for the WBS. 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
-
getOBSName
Gets the name of the person/role in the organization, sometimes referred to as the "responsible manager".- Returns:
- the value in the field OBSName
- 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
-
getContainsSummaryData
Gets the flag that indicates that the WBS has been summarized.- Returns:
- the value in the field ContainsSummaryData
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getStatus
Gets the project status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.- Returns:
- the value in the field Status
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setStatus
Sets the project status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getIntegratedWBS
Gets the indicator that determines whether a WBS is synchronized or not.- Returns:
- the value in the field IntegratedWBS
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setIntegratedWBS
Sets the indicator that determines whether a WBS is synchronized or not.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getWBSCategoryObjectId
Gets the unique ID of the associated WBS category value. Note that the label used for the WBS category is dynamic; it is controlled by the system administrator.- Returns:
- the value in the field WBSCategoryObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setWBSCategoryObjectId
Sets the unique ID of the associated WBS category value. Note that the label used for the WBS category is dynamic; it is controlled by the system administrator.- Parameters:
o- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getDefaultPriceTimeUnits
Gets the time units associated with the project's default price per time. Valid values are 'Hour', 'Day', 'Week', 'Month', and 'Year'.- Returns:
- the value in the field DefaultPriceTimeUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setDefaultPriceTimeUnits
Sets the time units associated with the project's default price per time. Valid values are 'Hour', 'Day', 'Week', 'Month', and 'Year'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCurrentBudget
Gets the sum of the original budget plus the approved and pending budgets from the budget change log. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field CurrentBudget
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getDistributedCurrentBudget
Gets the sum of the current budget values from one level lower. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field DistributedCurrentBudget
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getIndependentETCTotalCost
Gets the user-entered ETC total cost.- Returns:
- the value in the field IndependentETCTotalCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setIndependentETCTotalCost
Sets the user-entered ETC total cost.- Parameters:
c- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getIndependentETCLaborUnits
Gets the user-entered ETC total labor.- Returns:
- the value in the field IndependentETCLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setIndependentETCLaborUnits
Sets the user-entered ETC total labor.- Parameters:
u- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getOriginalBudget
Gets the original budget for the baseline project.- Returns:
- the value in the field OriginalBudget
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setOriginalBudget
Sets the original budget for the baseline project.- Parameters:
c- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalBenefitPlan
Gets the sum of the monthly benefit plan. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field TotalBenefitPlan
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalBenefitPlanTally
Gets the sum of the monthly benefit plan tally. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field TotalBenefitPlanTally
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalSpendingPlan
Gets the sum of the monthly spending plan. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field TotalSpendingPlan
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTotalSpendingPlanTally
Gets the sum of the monthly spending plan tally. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field TotalSpendingPlanTally
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getStartDate
Gets the start date of the baseline project. This field depends on summary data that was created when the original project was last summarized before this baseline was created. This 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
-
getFinishDate
Gets the finish date of the baseline project. This field depends on summary data that was created when the original project was last summarized before this baseline was created. This 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
-
getProjectSpread
Gets the field containing spread data for this project. If a baseline project is attempted to be loaded with spread data, getProjectSpread will return null if no spread data was available for that 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 ProjectSpread
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getResourceAssignmentCBSSpreads
public ResourceAssignmentCBSSpread[] getResourceAssignmentCBSSpreads() throws BusinessObjectExceptionGets the field containing resource cbs spread data for this project. If a project is attempted to be loaded with resource cbs spread data, getResourceAssignmentCBSSpread will return null if no spread data was available for that 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 ResourceAssignmentCBSSpread
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getExpenseCategoryCBSSpreads
Gets the field containing expense category cbs spread data for this project. If a project is attempted to be loaded with expense category cbs spread data, getExpenseCategoryCBSSpread will return null if no spread data was available for that 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 ExpenseCategoryCBSSpread
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getAnticipatedFinishDate
Gets the anticipated finish date of WBS, project and EPS elements. User-entered - not dependent upon any other fields. If there are no children, the anticipated finish date will be the finish date displayed in the columns.- Returns:
- the value in the field AnticipatedFinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setAnticipatedFinishDate
Sets the anticipated finish date of WBS, project and EPS elements. User-entered - not dependent upon any other fields. If there are no children, the anticipated finish date will be the finish date displayed in the columns.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getAnticipatedStartDate
Gets the anticipated start date of WBS, project and EPS elements. User-entered - not dependent upon any other fields. If there are no children, the anticipated start date will be the start date displayed in the columns.- Returns:
- the value in the field AnticipatedStartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setAnticipatedStartDate
Sets the anticipated start date of WBS, project and EPS elements. User-entered - not dependent upon any other fields. If there are no children, the anticipated start date will be the start date displayed in the columns.- Parameters:
d- 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
-
setDataDate
Sets 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.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPlannedStartDate
Gets the planned start date of the project. Used by the project scheduler.- Returns:
- the value in the field PlannedStartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setPlannedStartDate
Sets the planned start date of the project. 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
-
getMustFinishByDate
Gets the date by which all project activities must finish. If entered, it is used as the project late finish date by the project scheduler.- Returns:
- the value in the field MustFinishByDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setMustFinishByDate
Sets the date by which all project activities must finish. If entered, it is used as the project late finish date 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
-
getProjectForecastStartDate
Gets the alternate start date to be optionally used by the scheduler. The user sets the alternate start date by dragging the project bar in the Gantt Chart while manually leveling the resource profile in a resource analysis layout.- Returns:
- the value in the field ProjectForecastStartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setProjectForecastStartDate
Sets the alternate start date to be optionally used by the scheduler. The user sets the alternate start date by dragging the project bar in the Gantt Chart while manually leveling the resource profile in a resource analysis layout.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getForecastStartDate
Gets the alternate start date to be optionally used by the scheduler. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field ForecastStartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getForecastFinishDate
Gets the alternate end date to be optionally used by the scheduler). This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field ForecastFinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getScheduledFinishDate
Gets the early finish date of the latest activity in the project, as computed by the project scheduler.- Returns:
- the value in the field ScheduledFinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setScheduledFinishDate
Sets the early finish date of the latest activity in the project, as computed 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
-
getActivityIdBasedOnSelectedActivity
Gets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix. Default = 'N'.- Returns:
- the value in the field ActivityIdBasedOnSelectedActivity
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityIdBasedOnSelectedActivity
Sets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix. Default = 'N'.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getAddedBy
Gets the name of the user who added the project to the database.- Returns:
- the value in the field AddedBy
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setAddedBy
Sets the name of the user who added the project to the database.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getDateAdded
Gets the date on which the project was added to the Project Management database.- Returns:
- the value in the field DateAdded
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setDateAdded
Sets the date on which the project was added to the Project Management database.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCostQuantityRecalculateFlag
Gets the flag that indicates whether quantities should be updated when costs are updated, if costs and quantities are linked.- Returns:
- the value in the field CostQuantityRecalculateFlag
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setCostQuantityRecalculateFlag
Sets the flag that indicates whether quantities should be updated when costs are updated, if costs and quantities are linked.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLinkPercentCompleteWithActual
Gets the flag that determines whether actual units and cost should be recalculated when percent complete changes. Default = 'N'.- Returns:
- the value in the field LinkPercentCompleteWithActual
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setLinkPercentCompleteWithActual
Sets the flag that determines whether actual units and cost should be recalculated when percent complete changes. Default = 'N'.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLevelingPriority
Gets the priority for scheduling.- Returns:
- the value in the field LevelingPriority
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setLevelingPriority
Sets the priority for scheduling.- Parameters:
i- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getWebSiteURL
Gets the project Web site URL, which is the Web address of the project's website.- Returns:
- the value in the field WebSiteURL
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setWebSiteURL
Sets the project Web site URL, which is the Web address of the project's website.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getAssignmentDefaultRateType
Gets the default rate type when adding resource assignments to a project. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', and 'Price / Unit5'.- Returns:
- the value in the field AssignmentDefaultRateType
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setAssignmentDefaultRateType
Sets the default rate type when adding resource assignments to a project. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', and 'Price / Unit5'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getRiskScore
Gets the calculated risk score for 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 RiskScore
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getRiskExposure
Gets the calculated exposure value for 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 RiskExposure
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getRiskLevel
Gets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field RiskLevel
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setRiskLevel
Sets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'. This field may not be included in the where clause or order by clause specified when loading business objects.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getStrategicPriority
Gets the baseline project's priority. The range is from 1 to 10,000.- Returns:
- the value in the field StrategicPriority
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setStrategicPriority
Sets the baseline project's priority. The range is from 1 to 10,000.- Parameters:
i- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getWebSiteRootDirectory
Gets the root directory for storing project Web site files before they are published to the Web server.- Returns:
- the value in the field WebSiteRootDirectory
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setWebSiteRootDirectory
Sets the root directory for storing project Web site files before they are published to the Web server.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLastSummarizedDate
Gets the date the project was last summarized.- Returns:
- the value in the field LastSummarizedDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummarizedDataDate
Gets the data date of the project when it was last summarized-only updated by summarizer.- Returns:
- the value in the field SummarizedDataDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getEnablePublication
Gets enables the project to be processed by the Project Arbiter service.- Returns:
- the value in the field EnablePublication
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setEnablePublication
Sets enables the project to be processed by the Project Arbiter service.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getProjectScheduleType
Gets the type of schedule the project is based on. It can contain either "Duration" or "Resource" or "Cost".- Returns:
- the value in the field ProjectScheduleType
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setProjectScheduleType
Sets the type of schedule the project is based on. It can contain either "Duration" or "Resource" or "Cost".- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getEnableSummarization
Gets the flag which, when true, causes the Summarizer service to automatically summarize the project. If this is false, the project will be skipped during the summary run.- Returns:
- the value in the field EnableSummarization
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setEnableSummarization
Sets the flag which, when true, causes the Summarizer service to automatically summarize the project. If this is false, the project will be skipped during the summary run.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCheckOutStatus
Gets the flag that indicates that the baseline project is currently checked out to an external file or database and is being managed remotely.- Returns:
- the value in the field CheckOutStatus
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCheckOutDate
Gets the date on which the baseline project was checked out of the Project Management database.- Returns:
- the value in the field CheckOutDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCheckOutUserObjectId
Gets the unique ID of the User that checked out this baseline project.- Returns:
- the value in the field CheckOutUserObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityDefaultDurationType
Gets the duration type assigned to new activities by default. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'.- Returns:
- the value in the field ActivityDefaultDurationType
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityDefaultDurationType
Sets the duration type assigned to new activities by default. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityDefaultPercentCompleteType
Gets the percent complete type assigned to new activities by default. Valid values are 'Physical', 'Duration', and 'Units'.- Returns:
- the value in the field ActivityDefaultPercentCompleteType
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityDefaultPercentCompleteType
public void setActivityDefaultPercentCompleteType(PercentCompleteType enm) throws BusinessObjectException Sets the percent complete type assigned to new activities by default. Valid values are 'Physical', 'Duration', and 'Units'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityDefaultActivityType
Gets the default type for activities. Possible values are 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. A 'Task Dependent' activity is scheduled using the activity's calendar rather than the calendars of the assigned resources. A 'Resource Dependent' activity is scheduled using the calendars of the assigned resources. This type is used when several resources are assigned to the activity, but they may work separately. A 'Milestone' is a zero-duration activity without resources, marking a significant project event. A 'Level of Effort' activity has a duration that is determined by its dependent activities. Administration-type activities are typically 'Level of Effort'.- Returns:
- the value in the field ActivityDefaultActivityType
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityDefaultActivityType
Sets the default type for activities. Possible values are 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. A 'Task Dependent' activity is scheduled using the activity's calendar rather than the calendars of the assigned resources. A 'Resource Dependent' activity is scheduled using the calendars of the assigned resources. This type is used when several resources are assigned to the activity, but they may work separately. A 'Milestone' is a zero-duration activity without resources, marking a significant project event. A 'Level of Effort' activity has a duration that is determined by its dependent activities. Administration-type activities are typically 'Level of Effort'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityIdPrefix
Gets the prefix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.- Returns:
- the value in the field ActivityIdPrefix
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityIdPrefix
Sets the prefix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityIdSuffix
Gets the suffix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.- Returns:
- the value in the field ActivityIdSuffix
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityIdSuffix
Sets the suffix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.- Parameters:
i- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityIdIncrement
Gets the increment used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.- Returns:
- the value in the field ActivityIdIncrement
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityIdIncrement
Sets the increment used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.- Parameters:
i- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getResourceCanBeAssignedToSameActivityMoreThanOnce
Gets the flag that indicates whether a resource can be assigned more than once to the same activity. This is useful when the resource is expected to perform more than one role on an activity, for example, documentation plus QA.- Returns:
- the value in the field ResourceCanBeAssignedToSameActivityMoreThanOnce
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setResourceCanBeAssignedToSameActivityMoreThanOnce
public void setResourceCanBeAssignedToSameActivityMoreThanOnce(boolean b) throws BusinessObjectException Sets the flag that indicates whether a resource can be assigned more than once to the same activity. This is useful when the resource is expected to perform more than one role on an activity, for example, documentation plus QA.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPrimaryResourcesCanMarkActivitiesAsCompleted
Gets the flag that indicates whether primary resources can mark the project activities as completed. If not selected, a primary resource can only mark an activity as For Review. In this case the project manager reviews the activity and marks it as either Rejected or completed.- Returns:
- the value in the field PrimaryResourcesCanMarkActivitiesAsCompleted
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setPrimaryResourcesCanMarkActivitiesAsCompleted
public void setPrimaryResourcesCanMarkActivitiesAsCompleted(boolean b) throws BusinessObjectException Sets the flag that indicates whether primary resources can mark the project activities as completed. If not selected, a primary resource can only mark an activity as For Review. In this case the project manager reviews the activity and marks it as either Rejected or completed.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getResourcesCanAssignThemselvesToActivities
Gets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.- Returns:
- the value in the field ResourcesCanAssignThemselvesToActivities
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setResourcesCanAssignThemselvesToActivities
Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess
public boolean getResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess() throws BusinessObjectExceptionGets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project outside Resource Manager access.- Returns:
- the value in the field ResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess
public void setResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess(boolean b) throws BusinessObjectException Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project outside Resource Manager access.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getResourcesCanStaffRoleAssignment
Gets the flag that indicates whether team-member's application users are allowed to staff themselves to empty role assignments in this project.- Returns:
- the value in the field ResourcesCanStaffRoleAssignment
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setResourcesCanStaffRoleAssignment
Sets the flag that indicates whether team-member's application users are allowed to staff themselves to empty role assignments in this project.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getResourcesCanEditAssignmentPercentComplete
Gets the flag that indicates whether the project's resource can use the timesheet application to update remaining units or percent complete for their activities.- Returns:
- the value in the field ResourcesCanEditAssignmentPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setResourcesCanEditAssignmentPercentComplete
Sets the flag that indicates whether the project's resource can use the timesheet application to update remaining units or percent complete for their activities.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getAnnualDiscountRate
Gets the user-defined number field that identifies the discount rate for the project.- Returns:
- the value in the field AnnualDiscountRate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setAnnualDiscountRate
Sets the user-defined number field that identifies the discount rate for the project.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getDiscountApplicationPeriod
Gets the timescale for entering ROI spending and benefit plan. Valid values are 'Month', 'Quarter', or 'Year'.- Returns:
- the value in the field DiscountApplicationPeriod
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setDiscountApplicationPeriod
public void setDiscountApplicationPeriod(DiscountApplicationPeriod enm) throws BusinessObjectException Sets the timescale for entering ROI spending and benefit plan. Valid values are 'Month', 'Quarter', or 'Year'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummarizeToWBSLevel
Gets the maximum level within the project's WBS to perform summarization - default to 2.- Returns:
- the value in the field SummarizeToWBSLevel
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getWBSCodeSeparator
Gets the character used to separate the concatenated code fields for the project's WBS tree.- Returns:
- the value in the field WBSCodeSeparator
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setWBSCodeSeparator
Sets the character used to separate the concatenated code fields for the project's WBS tree.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getFiscalYearStartMonth
Gets the month that marks the beginning of the fiscal year for the project.- Returns:
- the value in the field FiscalYearStartMonth
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setFiscalYearStartMonth
Sets the month that marks the beginning of the fiscal year for the project.- Parameters:
i- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCriticalActivityFloatLimit
Gets the duration used to determine if an activity is critical. When an activity has total float that is less than or equal to this duration, the activity is marked as critical.- Returns:
- the value in the field CriticalActivityFloatLimit
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setCriticalActivityFloatLimit
Sets the duration used to determine if an activity is critical. When an activity has total float that is less than or equal to this duration, the activity is marked as critical.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCriticalActivityPathType
Gets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.- Returns:
- the value in the field CriticalActivityPathType
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setCriticalActivityPathType
public void setCriticalActivityPathType(CriticalActivityPathType enm) throws BusinessObjectException Sets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityPercentCompleteBasedOnActivitySteps
Gets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.- Returns:
- the value in the field ActivityPercentCompleteBasedOnActivitySteps
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityPercentCompleteBasedOnActivitySteps
public void setActivityPercentCompleteBasedOnActivitySteps(boolean b) throws BusinessObjectException Sets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityDefaultPricePerUnit
Gets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments. This price is also used to compute costs for activities in cases where resources are assigned but the resources have no prices. Resource cost is computed as the resource units multiplied by the price per time.- Returns:
- the value in the field ActivityDefaultPricePerUnit
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityDefaultPricePerUnit
Sets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments. This price is also used to compute costs for activities in cases where resources are assigned but the resources have no prices. Resource cost is computed as the resource units multiplied by the price per time.- Parameters:
c- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getAddActualToRemaining
Gets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated. Default = 'Y'.- Returns:
- the value in the field AddActualToRemaining
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setAddActualToRemaining
Sets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated. Default = 'Y'.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLinkActualToActualThisPeriod
Gets the flag that determines whether actual units and costs are linked to actual-this-period units and costs. Default = 'Y'.- Returns:
- the value in the field LinkActualToActualThisPeriod
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setLinkActualToActualThisPeriod
Sets the flag that determines whether actual units and costs are linked to actual-this-period units and costs. Default = 'Y'.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCurrentVariance
Gets the current budget minus the total spending plan. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field CurrentVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getUndistributedCurrentVariance
Gets the total spending plan minus the total spending plan tally. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field UndistributedCurrentVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getUnallocatedBudget
Gets the total current budget minus the distributed current budget. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field UnallocatedBudget
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getProposedBudget
Gets the sum of the original budget plus the approved and pending budgets from the budget change log. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field ProposedBudget
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getOwnerResourceObjectId
Gets the unique ID of the Owner Resource of this baseline project.- Returns:
- the value in the field OwnerResourceObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setOwnerResourceObjectId
Sets the unique ID of the Owner Resource of this baseline project.- Parameters:
o- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getResourceName
Gets the name of the resource assigned to the project.- Returns:
- the value in the field ResourceName
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLinkPlannedAndAtCompletionFlag
Gets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities. Default = 'Y'.- Returns:
- the value in the field LinkPlannedAndAtCompletionFlag
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setLinkPlannedAndAtCompletionFlag
Sets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities. Default = 'Y'.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getResetPlannedToRemainingFlag
Gets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started. Default = 'Y'.- Returns:
- the value in the field ResetPlannedToRemainingFlag
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setResetPlannedToRemainingFlag
Sets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started. Default = 'Y'.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getAssignmentDefaultDrivingFlag
Gets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.- Returns:
- the value in the field AssignmentDefaultDrivingFlag
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setAssignmentDefaultDrivingFlag
Sets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLastFinancialPeriodObjectId
Gets the unique ID of the last closed financial period for the baseline project.- Returns:
- the value in the field LastFinancialPeriodObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setLastFinancialPeriodObjectId
Sets the unique ID of the last closed financial period for the baseline project.- Parameters:
o- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCreateDate
Gets the date this project baseline 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 project baseline was last updated.- Returns:
- the value in the field LastUpdateDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLastPublishedOn
Gets the date the project was last published.- Returns:
- the value in the field LastPublishedOn
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getPublicationPriority
Gets a priority value the Project Arbiter service uses to determine the order in which projects are submitted to the service queue, where 1 is highest priority and 100 is lowest priority.- Returns:
- the value in the field PublicationPriority
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setPublicationPriority
Sets a priority value the Project Arbiter service uses to determine the order in which projects are submitted to the service queue, where 1 is highest priority and 100 is lowest priority.- Parameters:
i- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLastLevelDate
Gets the date the project was last leveled.- Returns:
- the value in the field LastLevelDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLastScheduleDate
Gets the date the project was last scheduled.- Returns:
- the value in the field LastScheduleDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getCreateUser
Gets the name of the user that created this project baseline.- 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 project baseline.- Returns:
- the value in the field LastUpdateUser
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLastBaselineUpdateDate
Gets the date this project baseline was last changed by Baseline Update in Project Management.- Returns:
- the value in the field LastBaselineUpdateDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setLastBaselineUpdateDate
Sets the date this project baseline was last changed by Baseline Update in Project Management.- Parameters:
d- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getHasFutureBucketData
Gets the flag that indicates whether a resource assignment in the baseline 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
-
getSummaryAccountingVarianceByCost
Gets the Planned Value minus the Actual Cost. A negative value indicates that the Actual Cost has 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 SummaryAccountingVarianceByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAccountingVarianceByLaborUnits
Gets the Planned Value Labor Units minus the Actual Units. Negative value indicates that Actual Units have exceeded the 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 SummaryAccountingVarianceByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActivityCount
Gets the number of activities that are currently in progress. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryActivityCount
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualDuration
Gets the actual 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 SummaryActualDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualExpenseCost
Gets the actual costs for all project expenses associated with 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 SummaryActualExpenseCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualFinishDate
Gets the latest actual finish date of all activities in 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 SummaryActualFinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualLaborCost
Gets the actual 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 SummaryActualLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualLaborUnits
Gets the 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 SummaryActualLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualMaterialCost
Gets the actual units for all material 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 SummaryActualMaterialCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualNonLaborCost
Gets the actual units for all nonlabor 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 SummaryActualNonLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualNonLaborUnits
Gets the 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 SummaryActualNonLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualStartDate
Gets the earliest actual start date of all activities in 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 SummaryActualStartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualThisPeriodCost
Gets the actual this period cost (will be labor or nonlabor). This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryActualThisPeriodCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualThisPeriodLaborCost
Gets the actual this period 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 SummaryActualThisPeriodLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualThisPeriodLaborUnits
Gets the actual this period 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 SummaryActualThisPeriodLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualThisPeriodMaterialCost
Gets the actual this period 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 SummaryActualThisPeriodMaterialCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualThisPeriodNonLaborCost
Gets the actual this period 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 SummaryActualThisPeriodNonLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualThisPeriodNonLaborUnits
Gets the actual this period 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 SummaryActualThisPeriodNonLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualTotalCost
Gets the actual labor cost + actual nonlabor cost + actual expense cost as of the project data 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 SummaryActualTotalCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualValueByCost
Gets the actual total cost incurred on the activity as of the project data date, computed as Actual Labor Cost + Actual Nonlabor Cost + Actual Material Cost + Actual 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 SummaryActualValueByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryActualValueByLaborUnits
Gets the actual total labor units for the activity as of the project data date (i.e., actual total cost by 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 SummaryActualValueByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAtCompletionDuration
Gets the duration at completion. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryAtCompletionDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAtCompletionExpenseCost
Gets the sum of the actual plus remaining cost for all project expenses associated with the cost account. 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 SummaryAtCompletionExpenseCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAtCompletionLaborCost
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 SummaryAtCompletionLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAtCompletionLaborUnits
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. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryAtCompletionLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAtCompletionMaterialCost
Gets the material cost at completion. It is the sum of the actual plus remaining costs for all material resources assigned to the activity. Computed as actual material cost + remaining material cost. Same as the planned material costs if the activity is not started and the actual material 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 SummaryAtCompletionMaterialCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAtCompletionNonLaborCost
Gets the nonlabor cost at completion. It is 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 SummaryAtCompletionNonLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAtCompletionNonLaborUnits
Gets the nonlabor units at completion. It is 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. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryAtCompletionNonLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAtCompletionTotalCost
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 SummaryAtCompletionTotalCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryAtCompletionTotalCostVariance
Gets the Baseline Planned 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 SummaryAtCompletionTotalCostVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineCompletedActivityCount
Gets the number of completed activities in 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 SummaryBaselineCompletedActivityCount
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineDuration
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 may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryBaselineDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineExpenseCost
Gets the planned cost for all project expenses associated with the activity in the primary baseline. Computed as the baseline actual expense cost plus the baseline 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 SummaryBaselineExpenseCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineFinishDate
Gets the current latest finish date of all activities in the project for the current 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 SummaryBaselineFinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineInProgressActivityCount
Gets the number of in-progress activities in 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 SummaryBaselineInProgressActivityCount
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineLaborCost
Gets the planned cost for all labor resources assigned to the activity in the primary baseline. Computed from the baseline At Completion labor units. If no resources are assigned, computed as the activity Baseline Planned 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 SummaryBaselineLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineLaborUnits
Gets the planned units for all labor resources assigned to the activity in the primary baseline. Computed as the baseline actual labor units plus the baseline remaining 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 SummaryBaselineLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineMaterialCost
Gets the planned cost for all material resources assigned to the activity in the primary baseline. Computed from the baseline At Completion nonlabor units. If no resources are assigned. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryBaselineMaterialCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineNonLaborCost
Gets the planned cost for all nonlabor resources assigned to the activity in the primary baseline. Computed from the baseline At Completion nonlabor units. If no resources are assigned, computed as the activity Baseline Planned 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 SummaryBaselineNonLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineNonLaborUnits
Gets the planned units for all nonlabor resources assigned to the activity in the primary baseline. Computed as the baseline actual nonlabor units plus the baseline remaining 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 SummaryBaselineNonLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineNotStartedActivityCount
Gets the number of activities not started in 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 SummaryBaselineNotStartedActivityCount
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineStartDate
Gets the current earliest start date of all activities in the WBS for the current 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 SummaryBaselineStartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBaselineTotalCost
Gets the Planned Total Cost for the activity in the primary baseline, including labor resources, nonlabor resources, and project expenses. Baseline Planned Total Cost = Baseline Planned Labor Cost + Baseline Planned Nonlabor Cost + Baseline Planned 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 SummaryBaselineTotalCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBudgetAtCompletionByCost
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 SummaryBudgetAtCompletionByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryBudgetAtCompletionByLaborUnits
Gets the Baseline Planned Labor Cost + Baseline Planned Nonlabor Cost + Baseline Planned Expense Cost. Same as the Baseline 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 SummaryBudgetAtCompletionByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCompletedActivityCount
Gets the number of activities that have an Actual Finish in 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 SummaryCompletedActivityCount
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCostPercentComplete
Gets the percent complete of cost for all nonlabor resources assigned. 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 SummaryCostPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCostPercentOfPlanned
Gets the activity actual cost percent of planned. Computed as actual total cost / baseline total cost * 100, or equivalently as ACWP / BAC * 100. The value can exceed 100. The baseline total cost is the activity's at completion cost from the current baseline. This field is named SummaryCostPercentOfBudget 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 SummaryCostPercentOfPlanned
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCostPerformanceIndexByCost
Gets the Earned Value divided by the Actual Cost. A value less than 1 indicates that the Actual Cost has 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 SummaryCostPerformanceIndexByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCostPerformanceIndexByLaborUnits
Gets the 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 SummaryCostPerformanceIndexByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCostVarianceByCost
Gets the Earned Value minus the Actual Cost. A negative value indicates that the Actual Cost has 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 SummaryCostVarianceByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCostVarianceByLaborUnits
Gets the Earned Value Labor Cost minus Actual Value 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 SummaryCostVarianceByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCostVarianceIndex
Gets the value that is calculated as the Cost Variance divided by 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 SummaryCostVarianceIndex
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCostVarianceIndexByLaborUnits
Gets the Cost Variance Labor Units divided by 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 SummaryCostVarianceIndexByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryCostVarianceIndexByCost
Gets the Cost Variance divided by 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 SummaryCostVarianceIndexByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryDurationPercentComplete
Gets the activity actual duration percent of planned. Computed as (baseline planned duration - remaining duration) / baseline planned duration * 100. The baseline planned duration is the activity's at complete duration from the primary 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 SummaryDurationPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryDurationPercentOfPlanned
Gets the summary actual duration percent of planned of all activities under this project. Computed as actual duration / baseline duration * 100. The value can exceed 100. The Baseline duration is the activity's at complete duration from the current 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 SummaryDurationPercentOfPlanned
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryDurationVariance
Gets the duration between the activity's baseline duration and the at complete duration. Computed as baseline planned 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 SummaryDurationVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryEarnedValueByCost
Gets the Budget at Completion * Performance % Complete. The method for computing the Performance Percent Complete depends on the Earned Value technique selected for the activity's WBS. Budget at Completion is computed from the primary 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 SummaryEarnedValueByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryEarnedValueByLaborUnits
Gets the portion of the baseline labor units that is actually completed as of the project data date. Computed as Baseline Labor Units * Performance % Complete. The planned labor units performed is essentially the labor units Earned Value for the activity. The method for computing the Performance % Complete depends on the Earned Value technique selected for the activity's WBS. The Baseline Labor Units is taken from the current 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 SummaryEarnedValueByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryEstimateAtCompletionByCost
Gets the Actual Cost plus the Estimate to Complete Cost. The method for computing Estimate to Complete 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 SummaryEstimateAtCompletionByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryEstimateAtCompletionByLaborUnits
Gets the 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 SummaryEstimateAtCompletionByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryEstimateAtCompletionHighPercentByLaborUnits
public Percent getSummaryEstimateAtCompletionHighPercentByLaborUnits() throws BusinessObjectExceptionGets the high forecast of Estimate At Completion (EAC) by 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 SummaryEstimateAtCompletionHighPercentByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryEstimateAtCompletionLowPercentByLaborUnits
public Percent getSummaryEstimateAtCompletionLowPercentByLaborUnits() throws BusinessObjectExceptionGets the low forecast of Estimate At Completion (EAC) by 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 SummaryEstimateAtCompletionLowPercentByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryEstimateToCompleteByCost
Gets the Remaining Total Cost for the activity or the Performance Factor * (Budget at Completion - Earned Value), depending on the Earned Value technique selected for the activity's WBS (calculated from the primary 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 SummaryEstimateToCompleteByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryEstimateToCompleteByLaborUnits
Gets the estimated quantity to complete the activity. Computed as either the remaining total units for the activity, or as Performance Factor * (Baseline Planned Labor Units - Planned Quantity of Work Performed), 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 SummaryEstimateToCompleteByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryExpenseCostPercentComplete
Gets the percent complete of cost for all expenses associated with the project. It is computed as Actual Expense Cost / At Complete Expense Cost * 100, and it is always in the range of 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 SummaryExpenseCostPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryExpenseCostVariance
Gets the Baseline Planned 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 SummaryExpenseCostVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryFinishDateVariance
Gets the duration between the finish date in the current project and the baseline finish date. Calculated as finish date - 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 SummaryFinishDateVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryInProgressActivityCount
Gets the number of activities that are currently in progress. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryInProgressActivityCount
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryLaborCostPercentComplete
Gets the percent complete of cost for all labor resources assigned to the project. It is computed as Actual Labor Cost / At Complete Labor Cost * 100, and it is always in the range of 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 SummaryLaborCostPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryLaborCostVariance
Gets the Baseline Planned 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 SummaryLaborCostVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryLaborUnitsPercentComplete
Gets the percent complete of units for all labor resources for the WBS. Computed as actual labor units / at complete 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 SummaryLaborUnitsPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryLaborUnitsVariance
Gets the difference between baseline labor units and at completion labor units. Calculated as baseline 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 SummaryLaborUnitsVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryMaterialCostPercentComplete
Gets the percent complete of cost for all material resources assigned to the project. It is computed as Actual Material Cost / At Complete Material Cost * 100, and it is always in the range of 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 SummaryMaterialCostPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryMaterialCostVariance
Gets the variance that is calculated as Baseline Material Cost - 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 SummaryMaterialCostVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryNonLaborCostPercentComplete
Gets the percent complete of cost for all non-labor resources assigned to the project. It is computed as Actual Nonlabor Cost / At Complete Nonlabor Cost * 100, and it is always in the range of 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 SummaryNonLaborCostPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryNonLaborCostVariance
Gets the Baseline Planned 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 SummaryNonLaborCostVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryNonLaborUnitsPercentComplete
Gets the percent complete of units for all nonlabor resources for the Project. 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 SummaryNonLaborUnitsPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryNonLaborUnitsVariance
Gets the difference between baseline nonlabor units and at completion non labor units. Calculated as baseline 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 SummaryNonLaborUnitsVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryNotStartedActivityCount
Gets the number of activities that are currently not started. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryNotStartedActivityCount
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPerformancePercentCompleteByLaborUnits
Gets the percent complete of units for the resource assignments in the WBS Computed as Actual Units / At Complete 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 SummaryPerformancePercentCompleteByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedValueByCost
Gets the Budget at Completion * Schedule % Complete. The Schedule % Complete specifies how much of the activity's baseline duration has been completed so far. Budget at Completion is computed from the primary 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 SummaryPlannedValueByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedValueByLaborUnits
Gets the portion of the baseline labor units that is scheduled to be completed as of the project data date. Computed as Baseline Labor Units * Schedule % Complete. The Schedule % Complete specifies how much of the activity's baseline duration has been completed so far. The Baseline Labor Units is taken from the current 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 SummaryPlannedValueByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryProgressFinishDate
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. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryProgressFinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingDuration
Gets the total working time from the WBS remaining start date to the remaining 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 SummaryRemainingDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingExpenseCost
Gets the remaining costs for all project expenses associated with the activities in 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 SummaryRemainingExpenseCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingFinishDate
Gets the date the resource is scheduled to finish the remaining work for the activity. This date is computed by the project scheduler but can be updated manually by the project manager. Before the activity is started, the remaining finish date is the same as the planned 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 SummaryRemainingFinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingLaborCost
Gets the remaining costs for all labor resources assigned to the activities. The remaining cost reflects the cost remaining for 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 SummaryRemainingLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingLaborUnits
Gets the remaining units for all labor resources assigned to the activities. The remaining units reflects the work remaining to be done for 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 SummaryRemainingLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingMaterialCost
Gets the remaining material costs for all project expenses associated with the activities in 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 SummaryRemainingMaterialCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingNonLaborCost
Gets the remaining nonlabor costs for all project expenses associated with the activities in 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 SummaryRemainingNonLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingNonLaborUnits
Gets the remaining units for all nonlabor resources assigned to the activities. The remaining units reflects the work remaining to be done for 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 SummaryRemainingNonLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingStartDate
Gets the earliest remaining start of all activities assigned to 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 SummaryRemainingStartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryRemainingTotalCost
Gets the sum of all remaining total costs in 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 SummaryRemainingTotalCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummarySchedulePercentComplete
Gets the measure that indicates how much of the WBS baseline duration has been completed so far. Computed based on where the current data date falls between the activity's baseline start and finish dates. If the data date is earlier than the baseline start, the schedule % complete is 0. If the data date is later than the baseline finish, the schedule % complete is 100. The schedule % complete indicates how much of the WBS duration should be currently completed, relative to the selected 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 SummarySchedulePercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummarySchedulePercentCompleteByCost
Gets the percent complete of cost for all labor resources, nonlabor resources, and expenses. 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 SummarySchedulePercentCompleteByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummarySchedulePercentCompleteByLaborUnits
Gets the percent complete of units for all labor resources. 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 SummarySchedulePercentCompleteByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummarySchedulePerformanceIndexByCost
Gets the Earned Value divided by the 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 SummarySchedulePerformanceIndexByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummarySchedulePerformanceIndexByLaborUnits
Gets the Earned Value Labor Units divided by 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 SummarySchedulePerformanceIndexByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryScheduleVarianceByCost
Gets the Earned Value divided by the 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 SummaryScheduleVarianceByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryScheduleVarianceIndex
Gets the value that is calculated as the Schedule Variance Labor Units divided by 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 SummaryScheduleVarianceIndex
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryScheduleVarianceIndexByCost
Gets the Schedule Variance divided by 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 SummaryScheduleVarianceIndexByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryScheduleVarianceByLaborUnits
Gets the Earned Value Labor Units minus the 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 SummaryScheduleVarianceByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryScheduleVarianceIndexByLaborUnits
Gets the Schedule Variance Labor Units divided by the 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 SummaryScheduleVarianceIndexByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryStartDateVariance
Gets the duration between the start date in the current project and the baseline start date. Calculated as start date - 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 SummaryStartDateVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryToCompletePerformanceIndexByCost
Gets the (Budget at Completion - Earned Value) divided by (Estimate at Completion - Actual 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 SummaryToCompletePerformanceIndexByCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryTotalCostVariance
Gets the value that is calculated as baseline total cost - 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 SummaryTotalCostVariance
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryTotalFloat
Gets the amount of time the WBS 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. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field SummaryTotalFloat
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryUnitsPercentComplete
Gets the percent complete of units for the resource assignments in the WBS. Computed as Actual Units / At Complete 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 SummaryUnitsPercentComplete
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryVarianceAtCompletionByLaborUnits
Gets the Baseline Planned Total Labor Units minus 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 SummaryVarianceAtCompletionByLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedCost
Gets the sum of all planned expense, non labor, labor, and material costs in the baseline 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 SummaryPlannedCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedNonLaborCost
Gets the sum of all planned non labor costs in the baseline 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 SummaryPlannedNonLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedExpenseCost
Gets the sum of all planned expense costs in the baseline 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 SummaryPlannedExpenseCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedMaterialCost
Gets the sum of all planned material costs in the baseline 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 SummaryPlannedMaterialCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedLaborCost
Gets the sum of all planned labor costs in the baseline 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 SummaryPlannedLaborCost
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedNonLaborUnits
Gets the sum of all planned non labor units in the baseline 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 SummaryPlannedNonLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedLaborUnits
Gets the sum of all planned labor units in the baseline 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 SummaryPlannedLaborUnits
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedStartDate
Gets the earliest planned start date of all activities in the baseline 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 SummaryPlannedStartDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedFinishDate
Gets the latest planned finish date of all activities in the baseline 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 SummaryPlannedFinishDate
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getSummaryPlannedDuration
Gets the total working days between planned start and finish dates in the baseline 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 SummaryPlannedDuration
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getDescription
Gets the description of the Project.- Returns:
- the value in the field Description
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setDescription
Sets the description of the Project.- Parameters:
s- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getRiskMatrixObjectId
Gets the unique ID of the associated Risk Matrix. This field is automatically loaded by default whenever this type of business object is loaded from the database.- Returns:
- the value in the field RiskMatrixObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setRiskMatrixObjectId
Sets the unique ID of the associated Risk Matrix. 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
-
getHistoryInterval
Gets the time interval for how historical project data is stored for use in P6 Analytics, could be 'Month', 'Week', 'Quarter', 'Year' and 'Financial Period'.- Returns:
- the value in the field HistoryInterval
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setHistoryInterval
Sets the time interval for how historical project data is stored for use in P6 Analytics, could be 'Month', 'Week', 'Quarter', 'Year' and 'Financial Period'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getHistoryLevel
Gets the level of historical project data that is stored for use in P6 Analytics, cab be 'None', 'Project', 'WBS' and 'Activity'.- Returns:
- the value in the field HistoryLevel
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setHistoryLevel
Sets the level of historical project data that is stored for use in P6 Analytics, cab be 'None', 'Project', 'WBS' and 'Activity'.- Parameters:
enm- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getStatusReviewerObjectId
Gets the ID's of the user reviewing status updates. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field StatusReviewerObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setStatusReviewerObjectId
Sets the ID's of the user reviewing status updates. 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
-
getStatusReviewerName
Gets the the name of the user reviewing status updates. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field StatusReviewerName
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setStatusReviewerName
Sets the the name of the user reviewing status updates. 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
-
getAllowStatusReview
Gets the indicator that determines whether status updates to activities in a project are eligible for manual approval before commiting changes.- Returns:
- the value in the field AllowStatusReview
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setAllowStatusReview
Sets the indicator that determines whether status updates to activities in a project are eligible for manual approval before commiting changes.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getActivityDefaultReviewRequired
Gets the indicator that determines whether status changes for new activities must be approved by default. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field ActivityDefaultReviewRequired
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setActivityDefaultReviewRequired
Sets the indicator that determines whether status changes for new activities must be approved by default. This field may not be included in the where clause or order by clause specified when loading business objects.- Parameters:
b- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getTeamMemberAssignmentOption
Gets the indicator that determines whether team member can update activity fields, assignment fields, or both. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field TeamMemberAssignmentOption
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTeamMemberAssignmentOption
Sets the indicator that determines whether team member can update activity fields, assignment fields, or both. 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
-
getTeamMemberResourceAssignmentFields
Gets the list of assignment fields that can be updated by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field TeamMemberResourceAssignmentFields
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTeamMemberResourceAssignmentFields
Sets the list of assignment fields that can be updated by the team member. 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
-
getTeamMemberActivityFields
Gets the list of activity fields that can be updated by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field TeamMemberActivityFields
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTeamMemberActivityFields
Sets the list of activity fields that can be updated by the team member. 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
-
getTeamMemberViewableFields
Gets the list of fields that are viewable by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field TeamMemberViewableFields
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTeamMemberViewableFields
Sets the list of fields that are viewable by the team member. 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
-
getTeamMemberStepUDFViewableFields
Gets the list of step UDF fields that are viewable by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field TeamMemberStepUDFViewableFields
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setTeamMemberStepUDFViewableFields
Sets the list of step UDF fields that are viewable by the team member. 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
-
getLocationObjectId
Gets the unique ID of the location assigned to the 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 LocationObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setLocationObjectId
Sets the unique ID of the location assigned to the 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
-
getLocationName
Gets the name of the location assigned to the project.- Returns:
- the value in the field LocationName
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getLastUpdateBaselineOptions
Gets hash value for the last options used when this baseline project was updated via Update Baseline module. Internal use only. This field may not be included in the where clause or order by clause specified when loading business objects.- Returns:
- the value in the field LastUpdateBaselineOptions
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setLastUpdateBaselineOptions
Sets hash value for the last options used when this baseline project was updated via Update Baseline module. Internal use only. 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
-
getFinancialPeriodTmplId
Gets the unique ID generated by the system.- Returns:
- the value in the field FinancialPeriodTmplId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setFinancialPeriodTmplId
Sets the unique ID generated by the system.- Parameters:
o- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
loadCalculatedUDFValues
public BOIterator<UDFValue> loadCalculatedUDFValues(UDFType[] udfTypes) throws ServerException, NetworkException, BusinessObjectException Loads multiple associatedUDFValueobjects- Parameters:
udfTypes- the udf types to loadUDFValueobjects for- Throws:
ServerExceptionNetworkExceptionBusinessObjectException
-
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
-
getSummaryFields
Gets all fields in the summary 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 loadWithSummarizedSpread methods for this business object.- Returns:
- String[] an array of all spread fields
-
getResourceAssignmentCBSSpreadFields
Gets all spread fields that can be specified in the spreadFields parameter of loadWithResourceCBSSpread methods for this business object.- Returns:
- String[] an array of all spread fields
-
getExpenseCategoryCBSSpreadFields
Gets all spread fields that can be specified in the spreadFields parameter of loadWithExpenseCategoryCBSSpread 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 BaselineProject object in the database.- Returns:
- ObjectId the unique ID of the newly created BaselineProject 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, BaselineProject[] baselineprojects) throws ServerException, NetworkException, BusinessObjectException Creates multiple BaselineProject objects in the database.- Parameters:
session- the Session objectbaselineprojects- array of BaselineProject objects to create- Returns:
- ObjectId[] the array of unique IDs of newly created BaselineProject 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 BaselineProject load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException Loads a single BaselineProject object from the database.- Parameters:
session- the Session objectfields- fields to loadobjId- unique ID of the BaselineProject object- Returns:
- BaselineProject the BaselineProject 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<BaselineProject> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException Loads multiple BaselineProject objects from the database.- Parameters:
session- the Session objectfields- fields to loadobjIds- object ids of the BaselineProject 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
-
loadWithSummarizedSpread
public static BaselineProject loadWithSummarizedSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException Loads a BaselineProject object with summarized spreads from the database.- Parameters:
nonSpreadFields- fields to loadobjId- unique ID of the BaselineProject 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:
- BaselineProject the BaselineProject 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
-
loadWithSummarizedSpread
public static BOIterator<BaselineProject> loadWithSummarizedSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException Loads multiple BaselineProject objects with summarized spreads from the database.- Parameters:
nonSpreadFields- fields to loadobjIds- object ids of the BaselineProject 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
-
loadWithResourceAssignmentCBSSpread
public static BaselineProject loadWithResourceAssignmentCBSSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] resourcecbsObjectIds) throws ServerException, NetworkException, BusinessObjectException Loads a BaselineProject object with summarized spreads from the database.- Parameters:
nonSpreadFields- fields to loadobjId- unique ID of the BaselineProject 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 dataresourcecbsObjectIds- object ids of the ResourceCBS objects- Returns:
- BaselineProject the BaselineProject 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
-
loadWithResourceAssignmentCBSSpread
public static BOIterator<BaselineProject> loadWithResourceAssignmentCBSSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] resourcecbsObjectIds) throws ServerException, NetworkException, BusinessObjectException Loads multiple BaselineProject objects with summarized spreads from the database.- Parameters:
nonSpreadFields- fields to loadobjIds- object ids of the BaselineProject 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 dataresourcecbsObjectIds- object ids of the ResourceCBS 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
-
loadWithExpenseCategoryCBSSpread
public static BaselineProject loadWithExpenseCategoryCBSSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] expensecategorycbsObjectIds) throws ServerException, NetworkException, BusinessObjectException Loads a BaselineProject object with summarized spreads from the database.- Parameters:
nonSpreadFields- fields to loadobjId- unique ID of the BaselineProject 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 dataexpensecategorycbsObjectIds- object ids of the ExpenseCategoryCBS objects- Returns:
- BaselineProject the BaselineProject 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
-
loadWithExpenseCategoryCBSSpread
public static BOIterator<BaselineProject> loadWithExpenseCategoryCBSSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] expensecategorycbsObjectIds) throws ServerException, NetworkException, BusinessObjectException Loads multiple BaselineProject objects with summarized spreads from the database.- Parameters:
nonSpreadFields- fields to loadobjIds- object ids of the BaselineProject 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 dataexpensecategorycbsObjectIds- object ids of the ExpenseCategoryCBS 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
-
loadWithSpreads
public static BOIterator<BaselineProject> loadWithSpreads(Session session, String[] nonSpreadFields, String sWhereClause, String sOrderBy, SpreadOptions... spreadOptions) throws ServerException, NetworkException, BusinessObjectException Loads multiple BaselineProject objects with spreads from the database.- Parameters:
session- the Session objectnonSpreadFields- fields to loadsWhereClause- where clausesOrderBy- order-by clausespreadOptions- spread options- 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
-
loadWithSpreads
public static BOIterator<BaselineProject> loadWithSpreads(Session session, String[] nonSpreadFields, ObjectId[] objIds, SpreadOptions... spreadOptions) throws ServerException, NetworkException, BusinessObjectException Loads multiple BaselineProject objects with spreads from the database.- Parameters:
session- the Session objectnonSpreadFields- fields to loadobjIds- object ids of the BaselineProject objectsspreadOptions- spread options- 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
-
loadWithSpreads
public static BaselineProject loadWithSpreads(Session session, String[] nonSpreadFields, ObjectId objId, SpreadOptions... spreadOptions) throws ServerException, NetworkException, BusinessObjectException Loads a BaselineProject object with spreads from the database.- Parameters:
session- the Session objectnonSpreadFields- fields to loadobjId- unique ID of the BaselineProject objectspreadOptions- spread options- 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 BaselineProject 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, BaselineProject[] baselineprojects) throws ServerException, NetworkException, BusinessObjectException Updates multiple BaselineProject objects in the database.- Parameters:
session- the Session objectbaselineprojects- array of BaselineProject 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 BaselineProject 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, BaselineProject[] baselineprojects) throws ServerException, NetworkException, BusinessObjectException Deletes multiple BaselineProject objects from the database.- Parameters:
session- the Session objectbaselineprojects- array of BaselineProject 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
-