Primavera Integration API 7.0

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

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.base.WBSBase
              extended by com.primavera.integration.client.bo.object.WBS

public class WBS
extends com.primavera.integration.client.bo.base.WBSBase

The project work breakdown structure (WBS) is a hierarchical arrangement of the products and services produced during and by a project. Each element of a WBS may contain more-detailed WBS elements, activities, or both. WBS are hierarchical objects.

In the database a root-level WBS actually exists, but it corresponds to the project and is hidden in the API. If one of the Project.loadProjectLevelXXXXXX() methods is called to load project-level (root WBS-level) objects, the WBSObjectId field in the loaded objects will actually contain an ObjectId. However, attempting to load the WBS with that ObjectId will be unsuccessful and will return null.

WBS may be loaded with summarized spreads using the loadWithSummarizedSpreads() methods. The parent project must have been previously summarized using the summarizer job service for summarized spreads to be accessible. After loading, call getWBSSpread() to access the spread data.

Many of the fields exposed in this class are summary fields. To obtain a complete list of these fields, call getSummaryFields(). getMainFields() returns all fields except summary fields.

This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.

See Also:   Quick reference of WBS fields


Constructor Summary
WBS(Session session)
          Class constructor specifying the Session.
WBS(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
WBS(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this WBS object in the database.
static ObjectId[] create(Session session, WBS[] wbs)
          Creates multiple WBS objects in the database.
 ObjectId[] createActivities(Activity[] activities)
          Creates multiple associated Activity objects in the database.
 ObjectId createActivity(Activity activity)
          Creates an associated Activity object in the database.
 ObjectId createProjectBudgetChangeLog(ProjectBudgetChangeLog projectbudgetchangelog)
          Creates an associated ProjectBudgetChangeLog object in the database.
 ObjectId[] createProjectBudgetChangeLogs(ProjectBudgetChangeLog[] projectbudgetchangelogs)
          Creates multiple associated ProjectBudgetChangeLog objects in the database.
 ObjectId createProjectDocument(ProjectDocument projectdocument)
          Creates an associated ProjectDocument object in the database.
 ObjectId[] createProjectDocuments(ProjectDocument[] projectdocuments)
          Creates multiple associated ProjectDocument objects in the database.
 ObjectId createProjectEstimate(ProjectEstimate projectestimate)
          Creates an associated ProjectEstimate object in the database.
 ObjectId[] createProjectEstimates(ProjectEstimate[] projectestimates)
          Creates multiple associated ProjectEstimate objects in the database.
 ObjectId createProjectIssue(ProjectIssue projectissue)
          Creates an associated ProjectIssue object in the database.
 ObjectId[] createProjectIssues(ProjectIssue[] projectissues)
          Creates multiple associated ProjectIssue objects in the database.
 ObjectId createProjectNote(ProjectNote projectnote)
          Creates an associated ProjectNote object in the database.
 ObjectId[] createProjectNotes(ProjectNote[] projectnotes)
          Creates multiple associated ProjectNote objects in the database.
 ObjectId createProjectRisk(ProjectRisk projectrisk)
          Creates an associated ProjectRisk object in the database.
 ObjectId[] createProjectRisks(ProjectRisk[] projectrisks)
          Creates multiple associated ProjectRisk objects in the database.
 ObjectId createProjectSpendingPlan(ProjectSpendingPlan projectspendingplan)
          Creates an associated ProjectSpendingPlan object in the database.
 ObjectId[] createProjectSpendingPlans(ProjectSpendingPlan[] projectspendingplans)
          Creates multiple associated ProjectSpendingPlan objects in the database.
 ObjectId createProjectThreshold(ProjectThreshold projectthreshold)
          Creates an associated ProjectThreshold object in the database.
 ObjectId[] createProjectThresholds(ProjectThreshold[] projectthresholds)
          Creates multiple associated ProjectThreshold objects in the database.
 ObjectId createWBSChild(WBS wbschild)
          Creates an associated WBS object in the database.
 ObjectId[] createWBSChildren(WBS[] wbschildren)
          Creates multiple associated WBS objects in the database.
 ObjectId createWBSMilestone(WBSMilestone wbsmilestone)
          Creates an associated WBSMilestone object in the database.
 ObjectId[] createWBSMilestones(WBSMilestone[] wbsmilestones)
          Creates multiple associated WBSMilestone objects in the database.
 void delete()
          Deletes this WBS object from the database.
 void delete(ObjectId replacementId)
          Deletes this WBS object from the database.
static void delete(Session session, WBS[] wbs)
          Deletes multiple WBS objects from the database.
static void delete(Session session, WBS[] wbs, ObjectId replacementParent)
          Deletes multiple wbs objects in a hierarchy from the database and set the new parent of all child objects.
 void deleteActivities(Activity[] activities)
          Deletes multiple associated Activity objects from the database.
 void deleteProjectBudgetChangeLogs(ProjectBudgetChangeLog[] projectbudgetchangelogs)
          Deletes multiple associated ProjectBudgetChangeLog objects from the database.
 void deleteProjectDocuments(ProjectDocument[] projectdocuments)
          Deletes multiple associated ProjectDocument objects from the database.
 void deleteProjectEstimates(ProjectEstimate[] projectestimates)
          Deletes multiple associated ProjectEstimate objects from the database.
 void deleteProjectIssues(ProjectIssue[] projectissues)
          Deletes multiple associated ProjectIssue objects from the database.
 void deleteProjectNotes(ProjectNote[] projectnotes)
          Deletes multiple associated ProjectNote objects from the database.
 void deleteProjectRisks(ProjectRisk[] projectrisks)
          Deletes multiple associated ProjectRisk objects from the database.
 void deleteProjectThresholds(ProjectThreshold[] projectthresholds)
          Deletes multiple associated ProjectThreshold objects from the database.
 void deleteWBSMilestones(WBSMilestone[] wbsmilestones)
          Deletes multiple associated WBSMilestone objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 EndDate getAnticipatedFinishDate()
          Gets the anticipated finish date of WBS, project and EPS elements.
 BeginDate getAnticipatedStartDate()
          Gets the anticipated start date of WBS, project and EPS elements.
 java.lang.String getCode()
          Gets the short code assigned to each WBS element for identification.
 boolean getContainsSummaryData()
          Gets the flag that indicates that the WBS has been summarized.
 java.util.Date getCreateDate()
          Gets the date this wbs was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this wbs.
 Cost getCurrentBudget()
          Gets the current budget for this WBS.
 Cost getCurrentVariance()
          Gets the current budget minus the total spending plan.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 Cost getDistributedCurrentBudget()
          Gets the sum of the current budget values from one level lower.
 EarnedValueComputeType getEarnedValueComputeType()
          Gets the technique used for computing earned-value percent complete for activities within the WBS.
 EarnedValueETCComputeType getEarnedValueETCComputeType()
          Gets the technique for computing earned-value estimate-to-complete for activities within the WBS.
 Unit getEarnedValueETCUserValue()
          Gets the user-defined performance factor, PF, for computing earned-value estimate-to-complete.
 Percent getEarnedValueUserPercent()
          Gets the user-defined percent complete for computing earned value for activities within the WBS.
 Unit getEstimatedWeight()
          Gets the estimation weight for the WBS element, used for top-down estimation.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 EndDate getFinishDate()
          Gets the finish date of the WBS.
 EndDate getForecastFinishDate()
          Gets the alternate end date to be optionally used by the scheduler.
 BeginDate getForecastStartDate()
          Gets the alternate start date to be optionally used by the scheduler.
 java.lang.String getGUID()
          Gets the globally unique ID generated by the system.
 Unit getIndependentETCLaborUnits()
          Gets the user-entered ETC total labor.
 Cost getIndependentETCTotalCost()
          Gets the user-entered ETC total cost.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 boolean getIsBaseline()
          Gets the boolean value indicating if this business object is related to a Project or Baseline.
 java.util.Date getLastUpdateDate()
          Gets the date this wbs was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this wbs.
static java.lang.String[] getMainFields()
          Gets all fields in the main group for this business object.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the name of the WBS element.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 java.lang.String getOBSName()
          Gets the name of the person/role in the organization, sometimes referred to as the "responsible manager".
 ObjectId getOBSObjectId()
          Gets the unique ID of the project manager from the project's OBS tree who is responsible for the WBS.
 Cost getOriginalBudget()
          Gets the original budget for the WBS element.
 ObjectId getParentObjectId()
          Gets the unique ID of the parent WBS of this WBS in the hierarchy.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
 Cost getProposedBudget()
          Gets the sum of the original budget plus the approved and pending budgets from the budget change log.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 int getSequenceNumber()
          Gets the sequence number for sorting.
static java.lang.String[] getSpreadFields()
          Gets all spread fields that can be specified in the spreadFields parameter of loadWithSummarizedSpread methods for this business object.
 BeginDate getStartDate()
          Gets the start date of the WBS.
 ProjectStatus getStatus()
          Gets the WBS status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.
 Cost getSummaryAccountingVarianceByCost()
          Gets the Planned Value minus the Actual Cost.
 Unit getSummaryAccountingVarianceByLaborUnits()
          Gets the Planned Value Labor Units minus the Actual Units.
 int getSummaryActivityCount()
          Gets the number of activities that are currently in progress.
 Duration getSummaryActualDuration()
          Gets the actual duration.
 Cost getSummaryActualExpenseCost()
          Gets the actual costs for all project expenses associated with the WBS.
 EndDate getSummaryActualFinishDate()
          Gets the latest actual finish date of all activities in the WBS.
 Cost getSummaryActualLaborCost()
          Gets the actual cost for all labor resources assigned to the activity.
 Unit getSummaryActualLaborUnits()
          Gets the actual labor units.
 Cost getSummaryActualMaterialCost()
          Gets the actual units for all material resources assigned to the activity.
 Cost getSummaryActualNonLaborCost()
          Gets the actual units for all nonlabor resources assigned to the activity.
 Unit getSummaryActualNonLaborUnits()
          Gets the actual nonlabor units.
 BeginDate getSummaryActualStartDate()
          Gets the earliest actual start date of all activities in the WBS.
 Cost getSummaryActualThisPeriodCost()
          Gets the actual this period cost (will be labor or nonlabor).
 Cost getSummaryActualThisPeriodLaborCost()
          Gets the actual this period labor cost.
 Unit getSummaryActualThisPeriodLaborUnits()
          Gets the actual this period labor units.
 Cost getSummaryActualThisPeriodMaterialCost()
          Gets the actual this period material cost.
 Cost getSummaryActualThisPeriodNonLaborCost()
          Gets the actual this period nonlabor cost.
 Unit getSummaryActualThisPeriodNonLaborUnits()
          Gets the actual this period nonlabor units.
 Cost getSummaryActualTotalCost()
          Gets the actual labor cost + actual nonlabor cost + actual expense cost as of the project data date.
 Cost 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.
 Unit getSummaryActualValueByLaborUnits()
          Gets the actual total labor units for the activity as of the project data date (i.e., actual total cost by labor units).
 Duration getSummaryAtCompletionDuration()
          Gets the total working time from the activity's current start date to the current finish date.
 Cost getSummaryAtCompletionExpenseCost()
          Gets the sum of the actual plus remaining cost for all project expenses associated with the cost account.
 Cost getSummaryAtCompletionLaborCost()
          Gets the sum of the actual plus remaining costs for all labor resources assigned to the activity.
 Unit getSummaryAtCompletionLaborUnits()
          Gets the sum of the actual plus remaining units for all labor resources assigned to the activity.
 Cost getSummaryAtCompletionMaterialCost()
          Gets the material cost at completion.
 Cost getSummaryAtCompletionNonLaborCost()
          Gets the nonlabor cost at completion.
 Unit getSummaryAtCompletionNonLaborUnits()
          Gets the nonlabor units at completion.
 Cost getSummaryAtCompletionTotalCost()
          Gets the estimated cost at completion for the activity.
 Cost getSummaryAtCompletionTotalCostVariance()
          Gets the Baseline Planned Total Cost - At Completion Total Cost.
 int getSummaryBaselineCompletedActivityCount()
          Gets the number of completed activities in the baseline.
 Duration getSummaryBaselineDuration()
          Gets the planned duration for the activity in the primary baseline.
 Cost getSummaryBaselineExpenseCost()
          Gets the planned cost for all project expenses associated with the activity in the primary baseline.
 EndDate getSummaryBaselineFinishDate()
          Gets the current latest finish date of all activities in the WBS for the current baseline.
 int getSummaryBaselineInProgressActivityCount()
          Gets the number of activities that should be currently in progress, according to the primary baseline.
 Cost getSummaryBaselineLaborCost()
          Gets the planned cost for all labor resources assigned to the activity in the primary baseline.
 Unit getSummaryBaselineLaborUnits()
          Gets the planned units for all labor resources assigned to the activity in the primary baseline.
 Cost getSummaryBaselineMaterialCost()
          Gets the planned cost for all material resources assigned to the activity in the primary baseline.
 Cost getSummaryBaselineNonLaborCost()
          Gets the planned cost for all nonlabor resources assigned to the activity in the primary baseline.
 Unit getSummaryBaselineNonLaborUnits()
          Gets the planned units for all nonlabor resources assigned to the activity in the primary baseline.
 int getSummaryBaselineNotStartedActivityCount()
          Gets the number of activities not started in the baseline.
 BeginDate getSummaryBaselineStartDate()
          Gets the current earliest start date of all activities in the WBS for the current baseline.
 Cost getSummaryBaselineTotalCost()
          Gets the Planned Total Cost for the activity in the primary baseline, including labor resources, nonlabor resources, and project expenses.
 Cost getSummaryBudgetAtCompletionByCost()
          Gets the Planned Total Cost through activity completion.
 Unit getSummaryBudgetAtCompletionByLaborUnits()
          Gets the Baseline Labor Units.
 int getSummaryCompletedActivityCount()
          Gets the number of activities that have an Actual Finish in the WBS.
 Percent getSummaryCostPercentComplete()
          Gets the percent complete of costs for the resource assignments in the wbs.
 Percent getSummaryCostPercentOfPlanned()
          Gets the activity actual cost percent of planned.
 double getSummaryCostPerformanceIndexByCost()
          Gets the Earned Value divided by the Actual Cost.
 double getSummaryCostPerformanceIndexByLaborUnits()
          Gets the Earned Value Labor Units / Actual Labor Units.
 Cost getSummaryCostVarianceByCost()
          Gets the Earned Value minus the Actual Cost.
 Unit getSummaryCostVarianceByLaborUnits()
          Gets the Earned Value Labor Cost minus Actual Value Labor Cost.
 double getSummaryCostVarianceIndex()
          Gets the value that is calcuated as the Cost Variance divided by Earned Value.
 Percent getSummaryCostVarianceIndexByCost()
          Gets the Cost Variance divided by Earned Value.
 double getSummaryCostVarianceIndexByLaborUnits()
          Gets the Cost Variance Labor Units divided by Earned Value Labor Units.
 Percent getSummaryDurationPercentComplete()
          Gets the activity actual duration percent of planned.
 Percent getSummaryDurationPercentOfPlanned()
          Gets the summary actual duration percent of planned of all activities under this WBS.
 Duration getSummaryDurationVariance()
          Gets the duration between the activity's baseline duration and the at complete duration.
 Cost getSummaryEarnedValueByCost()
          Gets the Budget at Completion * Performance % Complete.
 Unit getSummaryEarnedValueByLaborUnits()
          Gets the portion of the baseline labor units that is actually completed as of the project data date.
 Cost getSummaryEstimateAtCompletionByCost()
          Gets the Actual Cost plus the Estimate to Complete Cost.
 Unit getSummaryEstimateAtCompletionByLaborUnits()
          Gets the Actual Labor Units + Estimate To Complete Labor Units.
 Percent getSummaryEstimateAtCompletionHighPercentByLaborUnits()
          Gets the high forecast of Estimate At Completion (EAC) by labor units.
 Percent getSummaryEstimateAtCompletionLowPercentByLaborUnits()
          Gets the low forecast of Estimate At Completion (EAC) by labor units.
 Cost 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).
 Unit getSummaryEstimateToCompleteByLaborUnits()
          Gets the estimated quantity to complete the activity.
 Percent getSummaryExpenseCostPercentComplete()
          Gets the percent complete of cost for all expenses associated with the WBS.
 Cost getSummaryExpenseCostVariance()
          Gets the Baseline Planned Expense Cost - At Completion Expense Cost (At Completion Expense Cost = Actual Expense Cost + Remaining Expense Cost).
static java.lang.String[] getSummaryFields()
          Gets all fields in the summary group for this business object.
 Duration getSummaryFinishDateVariance()
          Gets the duration between the finish date in the current project and the baseline finish date.
 int getSummaryInProgressActivityCount()
          Gets the number of activities that are currently in progress.
 Percent getSummaryLaborCostPercentComplete()
          Gets the percent complete of cost for all labor resources assigned to the WBS.
 Cost getSummaryLaborCostVariance()
          Gets the Baseline Planned Labor Cost - At Completion Labor Cost.
 Percent getSummaryLaborUnitsPercentComplete()
          Gets the percent complete of units for all labor resources for the WBS.
 Unit getSummaryLaborUnitsVariance()
          Gets the difference between baseline labor units and at completion labor units.
 Percent getSummaryMaterialCostPercentComplete()
          Gets the percent complete of cost for all material resources assigned to the WBS.
 Cost getSummaryMaterialCostVariance()
          Gets the variance that is calculated as Baseline Material Cost - At Completion Material Cost.
 Percent getSummaryNonLaborCostPercentComplete()
          Gets the percent complete of cost for all non-labor resources assigned to the WBS.
 Unit getSummaryNonLaborCostVariance()
          Gets the Baseline Planned Nonlabor Cost - At Completion Nonlabor Cost.
 Percent getSummaryNonLaborUnitsPercentComplete()
          Gets the percent complete of units for all nonlabor resources for the WBS.
 Unit getSummaryNonLaborUnitsVariance()
          Gets the difference between baseline nonlabor units and at completion non labor units.
 int getSummaryNotStartedActivityCount()
          Gets the number of activities that are currently not started.
 Percent getSummaryPerformancePercentCompleteByCost()
          Gets the percent complete of performance for all labor resources, nonlabor resources, and expenses.
 Percent getSummaryPerformancePercentCompleteByLaborUnits()
          Gets the percent complete of performance for all labor resources.
 Cost getSummaryPlannedValueByCost()
          Gets the Budget at Completion * Schedule % Complete.
 Unit getSummaryPlannedValueByLaborUnits()
          Gets the portion of the baseline labor units that is scheduled to be completed as of the project data date.
 EndDate getSummaryProgressFinishDate()
          Gets the date the activity is expected to be finished according to the progress made on the activity's work products.
 Duration getSummaryRemainingDuration()
          Gets the total working time from the WBS remaining start date to the remaining finish date.
 Cost getSummaryRemainingExpenseCost()
          Gets the remaining costs for all project expenses associated with the activities in the WBS.
 EndDate getSummaryRemainingFinishDate()
          Gets the date the resource is scheduled to finish the remaining work for the activity.
 Cost getSummaryRemainingLaborCost()
          Gets the remaining costs for all labor resources assigned to the activities.
 Unit getSummaryRemainingLaborUnits()
          Gets the remaining units for all labor resources assigned to the activities.
 Cost getSummaryRemainingMaterialCost()
          Gets the remaining material costs for all project expenses associated with the activities in the WBS.
 Cost getSummaryRemainingNonLaborCost()
          Gets the remaining nonlabor costs for all project expenses associated with the activities in the WBS.
 Unit getSummaryRemainingNonLaborUnits()
          Gets the remaining units for all nonlabor resources assigned to the activities.
 BeginDate getSummaryRemainingStartDate()
          Gets the earliest remaining start of all activities assigned to the WBS.
 Cost getSummaryRemainingTotalCost()
          Gets the sum of all remaining total costs in the WBS.
 Percent getSummarySchedulePercentComplete()
          Gets the measure that indicates how much of the WBS baseline duration has been completed so far.
 Percent getSummarySchedulePercentCompleteByCost()
          Deprecated. As of release 6.1 SP2, the name has been changed to SummaryPerformancePercentCompleteByCost.
 Percent getSummarySchedulePercentCompleteByLaborUnits()
          Gets the percent complete of units for all labor resources.
 double getSummarySchedulePerformanceIndexByCost()
          Gets the Earned Value divided by the Planned Value.
 double getSummarySchedulePerformanceIndexByLaborUnits()
          Gets the Earned Value Labor Units divided by Planned Value Labor Units.
 Cost getSummaryScheduleVarianceByCost()
          Gets the Earned Value divided by the Planned Value.
 Unit getSummaryScheduleVarianceByLaborUnits()
          Gets the Earned Value Labor Units minus the Planned Value Labor Units.
 double getSummaryScheduleVarianceIndex()
          Gets the value that is calculated as the Schedule Variance Labor Units divided by Planned Value Labor Units.
 Percent getSummaryScheduleVarianceIndexByCost()
          Gets the Schedule Variance divided by the Planned Value.
 double getSummaryScheduleVarianceIndexByLaborUnits()
          Gets the Schedule Variance Labor Units divided by the Planned Value Labor Units.
 Duration getSummaryStartDateVariance()
          Gets the duration between the start date in the current project and the baseline start date.
 double getSummaryToCompletePerformanceIndexByCost()
          Gets the (Budget at Completion - Earned Value) divided by (Estimate at Completion - Actual Cost).
 Cost getSummaryTotalCostVariance()
          Gets the value that is calculated as baseline total cost - total cost.
 Duration getSummaryTotalFloat()
          Gets the amount of time the WBS can be delayed before delaying the project finish date.
 Percent getSummaryUnitsPercentComplete()
          Gets the percent complete of units for the resource assignments in the wbs.
 Unit getSummaryVarianceAtCompletionByLaborUnits()
          Gets the Baseline Planned Total Labor Units minus Estimate at Completion Labor Units.
 Cost getTotalBenefitPlan()
          Gets the sum of the monthly benefit plan.
 Cost getTotalBenefitPlanTally()
          Gets the sum of the monthly benefit plan tally.
 Cost getTotalSpendingPlan()
          Gets the sum of the monthly spending plan.
 Cost getTotalSpendingPlanTally()
          Gets the sum of the monthly spending plan tally.
 Cost getUDFCost(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Double getUDFDouble(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 EndDate getUDFFinishDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 UDFIndicator getUDFIndicator(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Integer getUDFInteger(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 BeginDate getUDFStartDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.String getUDFText(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 ObjectId[] getUDFTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.
 Cost getUnallocatedBudget()
          Gets the difference between the total current and distributed current budget.
 Cost getUndistributedCurrentVariance()
          Gets the total spending plan minus the total spending plan tally.
 ObjectId getWBSCategoryObjectId()
          Gets the unique ID of the associated WBS category value.
 WBSSpread getWBSSpread()
          Gets the field containing spread data for this WBS.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static WBS load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single WBS object from the database.
static BOIterator<WBS> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple WBS objects from the database.
 BOIterator<Activity> loadActivities(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Activity objects from the database.
 BOIterator<ActivityCodeAssignment> loadActivityCodeAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityCodeAssignment objects from the database.
 BOIterator<ActivityExpense> loadActivityExpenses(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityExpense objects from the database.
 BOIterator<ActivityNote> loadActivityNotes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityNote objects from the database.
 BOIterator<ActivityPeriodActual> loadActivityPeriodActuals(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityPeriodActual objects from the database.
 BOIterator<ActivityStep> loadActivitySteps(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityStep objects from the database.
 BOIterator<Activity> loadAllActivities(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads the associated Activity objects with all child WBS under this WBS from the database.
 BOIterator<ActivityExpense> loadAllActivityExpenses(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads the associated ActivityExpense objects with all child WBS under this WBS from the database.
 BOIterator<ResourceAssignment> loadAllResourceAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads the associated ResourceAssignment objects with all child WBS under this WBS from the database.
 BOIterator<WBS> loadAllWBS(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads all child WBS objects under this WBS from the database.
 OBS loadOBS(java.lang.String[] fields)
          Loads an associated OBS object from the database.
 WBS loadParentWBS(java.lang.String[] fields)
          Loads an associated WBS object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 BOIterator<ProjectBudgetChangeLog> loadProjectBudgetChangeLogs(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectBudgetChangeLog objects from the database.
 BOIterator<ProjectDocument> loadProjectDocuments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectDocument objects from the database.
 BOIterator<ProjectEstimate> loadProjectEstimates(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectEstimate objects from the database.
 BOIterator<ProjectIssue> loadProjectIssues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectIssue objects from the database.
 BOIterator<ProjectNote> loadProjectNotes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectNote objects from the database.
 BOIterator<ProjectResource> loadProjectResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectResource objects from the database.
 BOIterator<ProjectRisk> loadProjectRisks(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectRisk objects from the database.
 BOIterator<ProjectSpendingPlan> loadProjectSpendingPlans(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectSpendingPlan objects from the database.
 BOIterator<ProjectThreshold> loadProjectThresholds(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectThreshold objects from the database.
 BOIterator<ResourceAssignmentPeriodActual> loadResourceAssignmentPeriodActuals(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceAssignmentPeriodActual objects from the database.
 BOIterator<ResourceAssignment> loadResourceAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceAssignment objects from the database.
 BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UDFValue objects from the database.
 WBSCategory loadWBSCategory(java.lang.String[] fields)
          Loads an associated WBSCategory object from the database.
 BOIterator<WBS> loadWBSChildren(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated WBS objects from the database.
 BOIterator<WBS> loadWBSChildrenWithSummarizedSpread(java.lang.String[] nonSpreadFields, java.lang.String sWhereClause, java.lang.String sOrderBy, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative)
          Loads multiple associated WBS objects with Summarized spreads from the database.
 BOIterator<WBSMilestone> loadWBSMilestones(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated WBSMilestone objects from the database.
static BOIterator<WBS> loadWithSummarizedSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId[] objIds, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative)
          Loads multiple WBS objects with summarized spreads from the database.
static WBS loadWithSummarizedSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId objId, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative)
          Loads a WBS object with summarized spreads from the database.
 void setAnticipatedFinishDate(EndDate d)
          Sets the anticipated finish date of WBS, project and EPS elements.
 void setAnticipatedStartDate(BeginDate d)
          Sets the anticipated start date of WBS, project and EPS elements.
 void setCode(java.lang.String s)
          Sets the short code assigned to each WBS element for identification.
 void setEarnedValueComputeType(EarnedValueComputeType enm)
          Sets the technique used for computing earned-value percent complete for activities within the WBS.
 void setEarnedValueETCComputeType(EarnedValueETCComputeType enm)
          Sets the technique for computing earned-value estimate-to-complete for activities within the WBS.
 void setEarnedValueETCUserValue(Unit u)
          Sets the user-defined performance factor, PF, for computing earned-value estimate-to-complete.
 void setEarnedValueUserPercent(Percent p)
          Sets the user-defined percent complete for computing earned value for activities within the WBS.
 void setEstimatedWeight(Unit u)
          Sets the estimation weight for the WBS element, used for top-down estimation.
 void setGUID(java.lang.String s)
          Sets the globally unique ID generated by the system.
 void setIndependentETCLaborUnits(Unit u)
          Sets the user-entered ETC total labor.
 void setIndependentETCTotalCost(Cost c)
          Sets the user-entered ETC total cost.
 void setName(java.lang.String s)
          Sets the name of the WBS element.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setOBSObjectId(ObjectId o)
          Sets the unique ID of the project manager from the project's OBS tree who is responsible for the WBS.
 void setOriginalBudget(Cost c)
          Sets the original budget for the WBS element.
 void setParentObjectId(ObjectId o)
          Sets the unique ID of the parent WBS of this WBS in the hierarchy.
 void setProjectObjectId(ObjectId o)
          Sets the unique ID of the associated project.
 void setSequenceNumber(int i)
          Sets the sequence number for sorting.
 void setStatus(ProjectStatus enm)
          Sets the WBS status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.
 void setUDFCost(ObjectId objId, Cost cost)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFDouble(ObjectId objId, java.lang.Double n)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFFinishDate(ObjectId objId, EndDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFIndicator(ObjectId objId, UDFIndicator ind)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFInteger(ObjectId objId, java.lang.Integer i)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFStartDate(ObjectId objId, BeginDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFText(ObjectId objId, java.lang.String s)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setWBSCategoryObjectId(ObjectId o)
          Sets the unique ID of the associated WBS category value.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this WBS object in the database.
static void update(Session session, WBS[] wbs)
          Updates multiple WBS objects in the database.
 void updateActivities(Activity[] activities)
          Updates multiple associated Activity objects in the database.
 void updateProjectBudgetChangeLogs(ProjectBudgetChangeLog[] projectbudgetchangelogs)
          Updates multiple associated ProjectBudgetChangeLog objects in the database.
 void updateProjectDocuments(ProjectDocument[] projectdocuments)
          Updates multiple associated ProjectDocument objects in the database.
 void updateProjectEstimates(ProjectEstimate[] projectestimates)
          Updates multiple associated ProjectEstimate objects in the database.
 void updateProjectIssues(ProjectIssue[] projectissues)
          Updates multiple associated ProjectIssue objects in the database.
 void updateProjectNotes(ProjectNote[] projectnotes)
          Updates multiple associated ProjectNote objects in the database.
 void updateProjectRisks(ProjectRisk[] projectrisks)
          Updates multiple associated ProjectRisk objects in the database.
 void updateProjectSpendingPlans(ProjectSpendingPlan[] projectspendingplans)
          Updates multiple associated ProjectSpendingPlan objects in the database.
 void updateProjectThresholds(ProjectThreshold[] projectthresholds)
          Updates multiple associated ProjectThreshold objects in the database.
 void updateWBSMilestones(WBSMilestone[] wbsmilestones)
          Updates multiple associated WBSMilestone objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WBS

public WBS(Session session)
Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.

Parameters:
session - the Session

WBS

public WBS(Session session,
           ObjectId objId)
    throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

WBS

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

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

create

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

Returns:
ObjectId the unique ID of the newly created WBS object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

create

public static ObjectId[] create(Session session,
                                WBS[] wbs)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple WBS objects in the database.

Parameters:
session - the Session object
wbs - array of WBS objects to create
Returns:
ObjectId[] the array of unique IDs of newly created WBS objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

load

public static WBS load(Session session,
                       java.lang.String[] fields,
                       ObjectId objId)
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Loads a single WBS object from the database.

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

loadWithSummarizedSpread

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

Parameters:
nonSpreadFields - fields to load
objId - unique ID of the WBS object
spreadFields - the fields to include in the spread object
periodType - the period of the spread data (hour, day, etc.)
startDate - the start date of the spread
endDate - the end date of the spread
bIncludeCumulative - indicates whether to include cumulative spread data
Returns:
WBS the WBS object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

load

public static BOIterator<WBS> load(Session session,
                                   java.lang.String[] fields,
                                   ObjectId[] objIds)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Loads multiple WBS objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the WBS objects
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadWithSummarizedSpread

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

Parameters:
nonSpreadFields - fields to load
objIds - object ids of the WBS objects
spreadFields - the fields to include in the spread object
periodType - the period of the spread data (hour, day, etc.)
startDate - the start date of the spread
endDate - the end date of the spread
bIncludeCumulative - indicates whether to include cumulative spread data
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

update

public void update()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this WBS object in the database.

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

update

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

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

delete

public void delete()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this WBS object from the database.

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

delete

public void delete(ObjectId replacementId)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this WBS object from the database.

Overrides:
delete in class BOBase
Parameters:
replacementId - unique ID of the new parent for all current child objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

delete

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

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

delete

public static void delete(Session session,
                          WBS[] wbs,
                          ObjectId replacementParent)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple wbs objects in a hierarchy from the database and set the new parent of all child objects.

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

loadProject

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

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

loadParentWBS

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

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

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-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - 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-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadWBSChildren

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

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

loadWBSChildrenWithSummarizedSpread

public BOIterator<WBS> loadWBSChildrenWithSummarizedSpread(java.lang.String[] nonSpreadFields,
                                                           java.lang.String sWhereClause,
                                                           java.lang.String sOrderBy,
                                                           java.lang.String[] spreadFields,
                                                           SpreadPeriodType periodType,
                                                           java.util.Date startDate,
                                                           java.util.Date endDate,
                                                           boolean bIncludeCumulative)
                                                    throws ServerException,
                                                           NetworkException,
                                                           BusinessObjectException
Loads multiple associated WBS objects with Summarized spreads from the database.

Parameters:
nonSpreadFields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
spreadFields - the fields to include in the spread object
periodType - the period of the spread data (hour, day, etc.)
startDate - the start date of the spread
endDate - the end date of the spread
bIncludeCumulative - indicates whether to include cumulative spread data
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createActivity

public ObjectId createActivity(Activity activity)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Creates an associated Activity object in the database.

Parameters:
activity - Activity object to create
Returns:
ObjectId unique ID of the newly created Activity object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createActivities

public ObjectId[] createActivities(Activity[] activities)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Creates multiple associated Activity objects in the database.

Parameters:
activities - array of Activity objects to create
Returns:
ObjectId[] array of object ids of newly created Activity objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadActivities

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

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

updateActivities

public void updateActivities(Activity[] activities)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Updates multiple associated Activity objects in the database.

Parameters:
activities - array of Activity objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

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-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadOBS

public OBS loadOBS(java.lang.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-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectBudgetChangeLog

public ObjectId createProjectBudgetChangeLog(ProjectBudgetChangeLog projectbudgetchangelog)
                                      throws ServerException,
                                             NetworkException,
                                             BusinessObjectException
Creates an associated ProjectBudgetChangeLog object in the database.

Parameters:
projectbudgetchangelog - ProjectBudgetChangeLog object to create
Returns:
ObjectId unique ID of the newly created ProjectBudgetChangeLog object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectBudgetChangeLogs

public ObjectId[] createProjectBudgetChangeLogs(ProjectBudgetChangeLog[] projectbudgetchangelogs)
                                         throws ServerException,
                                                NetworkException,
                                                BusinessObjectException
Creates multiple associated ProjectBudgetChangeLog objects in the database.

Parameters:
projectbudgetchangelogs - array of ProjectBudgetChangeLog objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectBudgetChangeLog objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectBudgetChangeLogs

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

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

updateProjectBudgetChangeLogs

public void updateProjectBudgetChangeLogs(ProjectBudgetChangeLog[] projectbudgetchangelogs)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Updates multiple associated ProjectBudgetChangeLog objects in the database.

Parameters:
projectbudgetchangelogs - array of ProjectBudgetChangeLog objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

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-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectIssue

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

Parameters:
projectissue - ProjectIssue object to create
Returns:
ObjectId unique ID of the newly created ProjectIssue object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectIssues

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

Parameters:
projectissues - array of ProjectIssue objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectIssue objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectIssues

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

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

updateProjectIssues

public void updateProjectIssues(ProjectIssue[] projectissues)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Updates multiple associated ProjectIssue objects in the database.

Parameters:
projectissues - array of ProjectIssue objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

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-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectSpendingPlan

public ObjectId createProjectSpendingPlan(ProjectSpendingPlan projectspendingplan)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Creates an associated ProjectSpendingPlan object in the database.

Parameters:
projectspendingplan - ProjectSpendingPlan object to create
Returns:
ObjectId unique ID of the newly created ProjectSpendingPlan object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectSpendingPlans

public ObjectId[] createProjectSpendingPlans(ProjectSpendingPlan[] projectspendingplans)
                                      throws ServerException,
                                             NetworkException,
                                             BusinessObjectException
Creates multiple associated ProjectSpendingPlan objects in the database.

Parameters:
projectspendingplans - array of ProjectSpendingPlan objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectSpendingPlan objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectSpendingPlans

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

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

updateProjectSpendingPlans

public void updateProjectSpendingPlans(ProjectSpendingPlan[] projectspendingplans)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Updates multiple associated ProjectSpendingPlan objects in the database.

Parameters:
projectspendingplans - array of ProjectSpendingPlan objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectRisk

public ObjectId createProjectRisk(ProjectRisk projectrisk)
                           throws ServerException,
                                  NetworkException,
                                  BusinessObjectException
Creates an associated ProjectRisk object in the database.

Parameters:
projectrisk - ProjectRisk object to create
Returns:
ObjectId unique ID of the newly created ProjectRisk object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectRisks

public ObjectId[] createProjectRisks(ProjectRisk[] projectrisks)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Creates multiple associated ProjectRisk objects in the database.

Parameters:
projectrisks - array of ProjectRisk objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectRisk objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectRisks

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

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

updateProjectRisks

public void updateProjectRisks(ProjectRisk[] projectrisks)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Updates multiple associated ProjectRisk objects in the database.

Parameters:
projectrisks - array of ProjectRisk objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

deleteProjectRisks

public void deleteProjectRisks(ProjectRisk[] projectrisks)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Deletes multiple associated ProjectRisk objects from the database.

Parameters:
projectrisks - array of ProjectRisk objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectNote

public ObjectId createProjectNote(ProjectNote projectnote)
                           throws ServerException,
                                  NetworkException,
                                  BusinessObjectException
Creates an associated ProjectNote object in the database.

Parameters:
projectnote - ProjectNote object to create
Returns:
ObjectId unique ID of the newly created ProjectNote object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectNotes

public ObjectId[] createProjectNotes(ProjectNote[] projectnotes)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Creates multiple associated ProjectNote objects in the database.

Parameters:
projectnotes - array of ProjectNote objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectNote objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectNotes

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

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

updateProjectNotes

public void updateProjectNotes(ProjectNote[] projectnotes)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Updates multiple associated ProjectNote objects in the database.

Parameters:
projectnotes - array of ProjectNote objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

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-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectResources

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

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

createWBSMilestone

public ObjectId createWBSMilestone(WBSMilestone wbsmilestone)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Creates an associated WBSMilestone object in the database.

Parameters:
wbsmilestone - WBSMilestone object to create
Returns:
ObjectId unique ID of the newly created WBSMilestone object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createWBSMilestones

public ObjectId[] createWBSMilestones(WBSMilestone[] wbsmilestones)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Creates multiple associated WBSMilestone objects in the database.

Parameters:
wbsmilestones - array of WBSMilestone objects to create
Returns:
ObjectId[] array of object ids of newly created WBSMilestone objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadWBSMilestones

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

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

updateWBSMilestones

public void updateWBSMilestones(WBSMilestone[] wbsmilestones)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Updates multiple associated WBSMilestone objects in the database.

Parameters:
wbsmilestones - array of WBSMilestone objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

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-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectDocument

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

Parameters:
projectdocument - ProjectDocument object to create
Returns:
ObjectId unique ID of the newly created ProjectDocument object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectDocuments

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

Parameters:
projectdocuments - array of ProjectDocument objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectDocument objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectDocuments

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

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

updateProjectDocuments

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

Parameters:
projectdocuments - array of ProjectDocument objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

deleteProjectDocuments

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

Parameters:
projectdocuments - array of ProjectDocument objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadWBSCategory

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

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

loadActivityNotes

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

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

loadActivitySteps

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

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

loadActivityExpenses

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

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

loadResourceAssignments

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

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

createProjectEstimate

public ObjectId createProjectEstimate(ProjectEstimate projectestimate)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Creates an associated ProjectEstimate object in the database.

Parameters:
projectestimate - ProjectEstimate object to create
Returns:
ObjectId unique ID of the newly created ProjectEstimate object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectEstimates

public ObjectId[] createProjectEstimates(ProjectEstimate[] projectestimates)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Creates multiple associated ProjectEstimate objects in the database.

Parameters:
projectestimates - array of ProjectEstimate objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectEstimate objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectEstimates

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

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

updateProjectEstimates

public void updateProjectEstimates(ProjectEstimate[] projectestimates)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Updates multiple associated ProjectEstimate objects in the database.

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

deleteProjectEstimates

public void deleteProjectEstimates(ProjectEstimate[] projectestimates)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Deletes multiple associated ProjectEstimate objects from the database.

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

createProjectThreshold

public ObjectId createProjectThreshold(ProjectThreshold projectthreshold)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Creates an associated ProjectThreshold object in the database.

Parameters:
projectthreshold - ProjectThreshold object to create
Returns:
ObjectId unique ID of the newly created ProjectThreshold object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectThresholds

public ObjectId[] createProjectThresholds(ProjectThreshold[] projectthresholds)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Creates multiple associated ProjectThreshold objects in the database.

Parameters:
projectthresholds - array of ProjectThreshold objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectThreshold objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectThresholds

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

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

updateProjectThresholds

public void updateProjectThresholds(ProjectThreshold[] projectthresholds)
                             throws ServerException,
                                    NetworkException,
                                    BusinessObjectException
Updates multiple associated ProjectThreshold objects in the database.

Parameters:
projectthresholds - array of ProjectThreshold objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

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-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadActivityPeriodActuals

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

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

loadResourceAssignmentPeriodActuals

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

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

loadActivityCodeAssignments

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

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

loadUDFValues

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

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

getUDFTypesAssigned

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

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

Overrides:
getUDFTypesAssigned in class com.primavera.integration.client.bo.base.WBSBase
Returns:
ObjectId array of UDFType
Throws:
BusinessObjectException

loadAllWBS

public BOIterator<WBS> loadAllWBS(java.lang.String[] fields,
                                  java.lang.String sWhereClause,
                                  java.lang.String sOrderBy)
                           throws ServerException,
                                  NetworkException,
                                  BusinessObjectException
Loads all child WBS objects under this WBS from the database.

Overrides:
loadAllWBS in class com.primavera.integration.client.bo.base.WBSBase
Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if something was wrong in this Business object

loadAllActivities

public BOIterator<Activity> loadAllActivities(java.lang.String[] fields,
                                              java.lang.String sWhereClause,
                                              java.lang.String sOrderBy)
                                       throws ServerException,
                                              NetworkException,
                                              BusinessObjectException
Loads the associated Activity objects with all child WBS under this WBS from the database.

Overrides:
loadAllActivities in class com.primavera.integration.client.bo.base.WBSBase
Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if something was wrong in this Business object

loadAllActivityExpenses

public BOIterator<ActivityExpense> loadAllActivityExpenses(java.lang.String[] fields,
                                                           java.lang.String sWhereClause,
                                                           java.lang.String sOrderBy)
                                                    throws ServerException,
                                                           NetworkException,
                                                           BusinessObjectException
Loads the associated ActivityExpense objects with all child WBS under this WBS from the database.

Overrides:
loadAllActivityExpenses in class com.primavera.integration.client.bo.base.WBSBase
Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if something was wrong in this Business object

loadAllResourceAssignments

public BOIterator<ResourceAssignment> loadAllResourceAssignments(java.lang.String[] fields,
                                                                 java.lang.String sWhereClause,
                                                                 java.lang.String sOrderBy)
                                                          throws ServerException,
                                                                 NetworkException,
                                                                 BusinessObjectException
Loads the associated ResourceAssignment objects with all child WBS under this WBS from the database.

Overrides:
loadAllResourceAssignments in class com.primavera.integration.client.bo.base.WBSBase
Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if something was wrong in this Business object

getProjectObjectId

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

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

setProjectObjectId

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

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

getObjectId

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

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

setObjectId

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

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

getParentObjectId

public ObjectId getParentObjectId()
                           throws BusinessObjectException
Gets the unique ID of the parent WBS of this WBS in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

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

setParentObjectId

public void setParentObjectId(ObjectId o)
                       throws BusinessObjectException
Sets the unique ID of the parent WBS of this WBS in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

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

getName

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

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

setName

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

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

getCode

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

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

setCode

public void setCode(java.lang.String s)
             throws BusinessObjectException
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

getProjectId

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

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

getOBSObjectId

public ObjectId getOBSObjectId()
                        throws BusinessObjectException
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

public void setOBSObjectId(ObjectId o)
                    throws BusinessObjectException
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

public java.lang.String getOBSName()
                            throws BusinessObjectException
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

getWBSCategoryObjectId

public ObjectId getWBSCategoryObjectId()
                                throws BusinessObjectException
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. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setWBSCategoryObjectId

public void setWBSCategoryObjectId(ObjectId o)
                            throws BusinessObjectException
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. 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

getSequenceNumber

public int getSequenceNumber()
                      throws BusinessObjectException
Gets the sequence number for sorting.

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

setSequenceNumber

public void setSequenceNumber(int i)
                       throws BusinessObjectException
Sets the sequence number for sorting.

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

getGUID

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

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

setGUID

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

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

getEstimatedWeight

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

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

setEstimatedWeight

public void setEstimatedWeight(Unit u)
                        throws BusinessObjectException
Sets the estimation weight for the WBS element, used for top-down estimation. Top-down estimation weights are used to calculate the proportion of units that each WBS element or activity receives in relation to its siblings in the WBS hierarchy. Top-down estimation distributes estimated units in a top-down manner to activities using the WBS hierarchy.

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

getContainsSummaryData

public boolean getContainsSummaryData()
                               throws BusinessObjectException
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

public ProjectStatus getStatus()
                        throws BusinessObjectException
Gets the WBS 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

public void setStatus(ProjectStatus enm)
               throws BusinessObjectException
Sets the WBS 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

getCurrentBudget

public Cost getCurrentBudget()
                      throws BusinessObjectException
Gets the current budget for this 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 CurrentBudget
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDistributedCurrentBudget

public Cost getDistributedCurrentBudget()
                                 throws BusinessObjectException
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

public Cost getIndependentETCTotalCost()
                                throws BusinessObjectException
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

public void setIndependentETCTotalCost(Cost c)
                                throws BusinessObjectException
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

public Unit getIndependentETCLaborUnits()
                                 throws BusinessObjectException
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

public void setIndependentETCLaborUnits(Unit u)
                                 throws BusinessObjectException
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

public Cost getOriginalBudget()
                       throws BusinessObjectException
Gets the original budget for the WBS element.

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

setOriginalBudget

public void setOriginalBudget(Cost c)
                       throws BusinessObjectException
Sets the original budget for the WBS element.

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

getTotalBenefitPlan

public Cost getTotalBenefitPlan()
                         throws BusinessObjectException
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

public Cost getTotalBenefitPlanTally()
                              throws BusinessObjectException
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

public Cost getTotalSpendingPlan()
                          throws BusinessObjectException
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

public Cost getTotalSpendingPlanTally()
                               throws BusinessObjectException
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

getWBSSpread

public WBSSpread getWBSSpread()
                       throws BusinessObjectException
Gets the field containing spread data for this WBS. If a WBS is attempted to be loaded with spread data, getWBSSpread will return null if no spread data was available for that 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 WBSSpread
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAnticipatedFinishDate

public EndDate getAnticipatedFinishDate()
                                 throws BusinessObjectException
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

public void setAnticipatedFinishDate(EndDate d)
                              throws BusinessObjectException
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

public BeginDate getAnticipatedStartDate()
                                  throws BusinessObjectException
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

public void setAnticipatedStartDate(BeginDate d)
                             throws BusinessObjectException
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

getEarnedValueComputeType

public EarnedValueComputeType getEarnedValueComputeType()
                                                 throws BusinessObjectException
Gets the technique used for computing earned-value percent complete for activities within the WBS. Valid values are 'Activity Percent Complete', '0 / 100', '50 / 50', 'Custom Percent Complete', 'WBS Milestones Percent Complete', and 'Activity Percent Complete Using Resource Curves'.

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

setEarnedValueComputeType

public void setEarnedValueComputeType(EarnedValueComputeType enm)
                               throws BusinessObjectException
Sets the technique used for computing earned-value percent complete for activities within the WBS. Valid values are 'Activity Percent Complete', '0 / 100', '50 / 50', 'Custom Percent Complete', 'WBS Milestones Percent Complete', and 'Activity Percent Complete Using Resource Curves'.

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

getEarnedValueETCComputeType

public EarnedValueETCComputeType getEarnedValueETCComputeType()
                                                       throws BusinessObjectException
Gets the technique for computing earned-value estimate-to-complete for activities within the WBS. Valid values are 'ETC = Remaining Cost for Activity', 'Performance Factor = 1', 'Performance Factor = Custom Value', 'Performance Factor = 1 / Cost Performance Index', and 'Performance Factor = 1 / (Cost Performance Index * Schedule Performance Index)'.

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

setEarnedValueETCComputeType

public void setEarnedValueETCComputeType(EarnedValueETCComputeType enm)
                                  throws BusinessObjectException
Sets the technique for computing earned-value estimate-to-complete for activities within the WBS. Valid values are 'ETC = Remaining Cost for Activity', 'Performance Factor = 1', 'Performance Factor = Custom Value', 'Performance Factor = 1 / Cost Performance Index', and 'Performance Factor = 1 / (Cost Performance Index * Schedule Performance Index)'.

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

getEarnedValueETCUserValue

public Unit getEarnedValueETCUserValue()
                                throws BusinessObjectException
Gets the user-defined performance factor, PF, for computing earned-value estimate-to-complete. ETC is computed as PF * ( BAC - BCWP).

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

setEarnedValueETCUserValue

public void setEarnedValueETCUserValue(Unit u)
                                throws BusinessObjectException
Sets the user-defined performance factor, PF, for computing earned-value estimate-to-complete. ETC is computed as PF * ( BAC - BCWP).

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

getEarnedValueUserPercent

public Percent getEarnedValueUserPercent()
                                  throws BusinessObjectException
Gets the user-defined percent complete for computing earned value for activities within the WBS. A value of, say, 25 means that 25% of the planned amount is earned when the activity is started and the remainder is earned when the activity is completed.

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

setEarnedValueUserPercent

public void setEarnedValueUserPercent(Percent p)
                               throws BusinessObjectException
Sets the user-defined percent complete for computing earned value for activities within the WBS. A value of, say, 25 means that 25% of the planned amount is earned when the activity is started and the remainder is earned when the activity is completed.

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

getCurrentVariance

public Cost getCurrentVariance()
                        throws BusinessObjectException
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

public Cost getUndistributedCurrentVariance()
                                     throws BusinessObjectException
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

public Cost getUnallocatedBudget()
                          throws BusinessObjectException
Gets the difference between the total current and distributed current budget. Calculated as total current budget - 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

public Cost getProposedBudget()
                       throws BusinessObjectException
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

getStartDate

public BeginDate getStartDate()
                       throws BusinessObjectException
Gets the start date of 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 StartDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getFinishDate

public EndDate getFinishDate()
                      throws BusinessObjectException
Gets the finish date of 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 FinishDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryActualValueByCost

public Cost getSummaryActualValueByCost()
                                 throws BusinessObjectException
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

getSummaryPlannedValueByCost

public Cost getSummaryPlannedValueByCost()
                                  throws BusinessObjectException
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

getSummaryEarnedValueByCost

public Cost getSummaryEarnedValueByCost()
                                 throws BusinessObjectException
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

getSummaryCostPerformanceIndexByCost

public double getSummaryCostPerformanceIndexByCost()
                                            throws BusinessObjectException
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

getSummaryActualFinishDate

public EndDate getSummaryActualFinishDate()
                                   throws BusinessObjectException
Gets the latest actual finish date of all 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 SummaryActualFinishDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryRemainingFinishDate

public EndDate getSummaryRemainingFinishDate()
                                      throws BusinessObjectException
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

getSummaryBaselineTotalCost

public Cost getSummaryBaselineTotalCost()
                                 throws BusinessObjectException
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

public Cost getSummaryBudgetAtCompletionByCost()
                                        throws BusinessObjectException
Gets the Planned Total Cost through activity completion. Computed as Planned Labor Cost + Planned Nonlabor Cost + Planned Expense Cost, same as the Planned Total Cost. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryEstimateToCompleteByCost

public Cost getSummaryEstimateToCompleteByCost()
                                        throws BusinessObjectException
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

getSummaryBaselineLaborUnits

public Unit getSummaryBaselineLaborUnits()
                                  throws BusinessObjectException
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

getSummaryPlannedValueByLaborUnits

public Unit getSummaryPlannedValueByLaborUnits()
                                        throws BusinessObjectException
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

getSummaryEarnedValueByLaborUnits

public Unit getSummaryEarnedValueByLaborUnits()
                                       throws BusinessObjectException
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

getSummaryActualLaborUnits

public Unit getSummaryActualLaborUnits()
                                throws BusinessObjectException
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

getSummaryAtCompletionLaborUnits

public Unit getSummaryAtCompletionLaborUnits()
                                      throws BusinessObjectException
Gets the sum of the actual plus remaining units for all labor resources assigned to the activity. Computed as actual labor units + remaining labor units. Same as the planned labor units if the activity is not started and the actual labor units once the activity is completed. This 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

getSummaryAtCompletionNonLaborUnits

public Unit getSummaryAtCompletionNonLaborUnits()
                                         throws BusinessObjectException
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

getSummaryBaselineNonLaborUnits

public Unit getSummaryBaselineNonLaborUnits()
                                     throws BusinessObjectException
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

getSummaryNonLaborUnitsVariance

public Unit getSummaryNonLaborUnitsVariance()
                                     throws BusinessObjectException
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

getSummaryLaborUnitsVariance

public Unit getSummaryLaborUnitsVariance()
                                  throws BusinessObjectException
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

getSummaryActualThisPeriodLaborCost

public Cost getSummaryActualThisPeriodLaborCost()
                                         throws BusinessObjectException
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

public Unit getSummaryActualThisPeriodLaborUnits()
                                          throws BusinessObjectException
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

getSummaryActualThisPeriodNonLaborCost

public Cost getSummaryActualThisPeriodNonLaborCost()
                                            throws BusinessObjectException
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

getSummaryActualThisPeriodMaterialCost

public Cost getSummaryActualThisPeriodMaterialCost()
                                            throws BusinessObjectException
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

getSummaryActualThisPeriodNonLaborUnits

public Unit getSummaryActualThisPeriodNonLaborUnits()
                                             throws BusinessObjectException
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

getSummaryActualThisPeriodCost

public Cost getSummaryActualThisPeriodCost()
                                    throws BusinessObjectException
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

getSummaryLaborUnitsPercentComplete

public Percent getSummaryLaborUnitsPercentComplete()
                                            throws BusinessObjectException
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

getSummaryCostPercentOfPlanned

public Percent getSummaryCostPercentOfPlanned()
                                       throws BusinessObjectException
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

getSummaryBaselineStartDate

public BeginDate getSummaryBaselineStartDate()
                                      throws BusinessObjectException
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

getSummaryBaselineFinishDate

public EndDate getSummaryBaselineFinishDate()
                                     throws BusinessObjectException
Gets the current latest finish 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 SummaryBaselineFinishDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryRemainingDuration

public Duration getSummaryRemainingDuration()
                                     throws BusinessObjectException
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

getSummaryFinishDateVariance

public Duration getSummaryFinishDateVariance()
                                      throws BusinessObjectException
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

getSummaryBaselineDuration

public Duration getSummaryBaselineDuration()
                                    throws BusinessObjectException
Gets the planned duration for the activity in the primary baseline. Planned duration is the total working time from the activity current start date to the current finish date. Same as the actual duration plus the remaining duration. The total working time is computed using the activity's calendar. This field 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

getSummaryDurationPercentComplete

public Percent getSummaryDurationPercentComplete()
                                          throws BusinessObjectException
Gets the activity actual duration percent of planned. Computed as actual duration / at completion duration * 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 SummaryDurationPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryProgressFinishDate

public EndDate getSummaryProgressFinishDate()
                                     throws BusinessObjectException
Gets the date the activity is expected to be finished according to the progress made on the activity's work products. The expected finish date is entered manually by people familiar with progress of the activity's work products. This 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

getSummaryEstimateToCompleteByLaborUnits

public Unit getSummaryEstimateToCompleteByLaborUnits()
                                              throws BusinessObjectException
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

getSummaryCostPerformanceIndexByLaborUnits

public double getSummaryCostPerformanceIndexByLaborUnits()
                                                  throws BusinessObjectException
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

getSummaryScheduleVarianceByCost

public Cost getSummaryScheduleVarianceByCost()
                                      throws BusinessObjectException
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

getSummaryScheduleVarianceIndexByCost

public Percent getSummaryScheduleVarianceIndexByCost()
                                              throws BusinessObjectException
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

public Unit getSummaryScheduleVarianceByLaborUnits()
                                            throws BusinessObjectException
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

getSummaryCostVarianceByCost

public Cost getSummaryCostVarianceByCost()
                                  throws BusinessObjectException
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

getSummaryCostVarianceIndexByCost

public Percent getSummaryCostVarianceIndexByCost()
                                          throws BusinessObjectException
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

getSummaryCostVarianceByLaborUnits

public Unit getSummaryCostVarianceByLaborUnits()
                                        throws BusinessObjectException
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

getSummarySchedulePerformanceIndexByCost

public double getSummarySchedulePerformanceIndexByCost()
                                                throws BusinessObjectException
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

public double getSummarySchedulePerformanceIndexByLaborUnits()
                                                      throws BusinessObjectException
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

getSummaryEstimateAtCompletionByCost

public Cost getSummaryEstimateAtCompletionByCost()
                                          throws BusinessObjectException
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

public Unit getSummaryEstimateAtCompletionByLaborUnits()
                                                throws BusinessObjectException
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

getSummaryToCompletePerformanceIndexByCost

public double getSummaryToCompletePerformanceIndexByCost()
                                                  throws BusinessObjectException
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

getSummaryVarianceAtCompletionByLaborUnits

public Unit getSummaryVarianceAtCompletionByLaborUnits()
                                                throws BusinessObjectException
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

getSummaryActualStartDate

public BeginDate getSummaryActualStartDate()
                                    throws BusinessObjectException
Gets the earliest actual start date of all 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 SummaryActualStartDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryRemainingStartDate

public BeginDate getSummaryRemainingStartDate()
                                       throws BusinessObjectException
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

getForecastStartDate

public BeginDate getForecastStartDate()
                               throws BusinessObjectException
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. This 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

public EndDate getForecastFinishDate()
                              throws BusinessObjectException
Gets the alternate end date to be optionally used by the scheduler. The user sets the alternate end date by dragging the project bar in the Gantt Chart while manually leveling the resource profile in a resource analysis layout. This 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

getSummaryActualNonLaborUnits

public Unit getSummaryActualNonLaborUnits()
                                   throws BusinessObjectException
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

getSummaryActualLaborCost

public Cost getSummaryActualLaborCost()
                               throws BusinessObjectException
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

getSummaryActualNonLaborCost

public Cost getSummaryActualNonLaborCost()
                                  throws BusinessObjectException
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

getSummaryActualMaterialCost

public Cost getSummaryActualMaterialCost()
                                  throws BusinessObjectException
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

getSummaryRemainingTotalCost

public Cost getSummaryRemainingTotalCost()
                                  throws BusinessObjectException
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

getSummaryRemainingNonLaborUnits

public Unit getSummaryRemainingNonLaborUnits()
                                      throws BusinessObjectException
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

getSummaryActualExpenseCost

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

getSummaryRemainingLaborUnits

public Unit getSummaryRemainingLaborUnits()
                                   throws BusinessObjectException
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

getSummaryAtCompletionTotalCost

public Cost getSummaryAtCompletionTotalCost()
                                     throws BusinessObjectException
Gets the estimated cost at completion for the activity. Computed as the actual total cost plus the estimate-to-complete cost; EAC = ACWP + ETC. Note that the method for computing ETC depends on the earned-value technique selected for the activity's WBS. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryRemainingLaborCost

public Cost getSummaryRemainingLaborCost()
                                  throws BusinessObjectException
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

getSummaryRemainingNonLaborCost

public Cost getSummaryRemainingNonLaborCost()
                                     throws BusinessObjectException
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

getSummaryRemainingMaterialCost

public Cost getSummaryRemainingMaterialCost()
                                     throws BusinessObjectException
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

getSummaryRemainingExpenseCost

public Cost getSummaryRemainingExpenseCost()
                                    throws BusinessObjectException
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

getSummaryBaselineExpenseCost

public Cost getSummaryBaselineExpenseCost()
                                   throws BusinessObjectException
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

getSummaryBaselineLaborCost

public Cost getSummaryBaselineLaborCost()
                                 throws BusinessObjectException
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

getSummaryBaselineNonLaborCost

public Cost getSummaryBaselineNonLaborCost()
                                    throws BusinessObjectException
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

getSummaryBaselineMaterialCost

public Cost getSummaryBaselineMaterialCost()
                                    throws BusinessObjectException
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

getSummaryAtCompletionDuration

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

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

getSummaryDurationVariance

public Duration getSummaryDurationVariance()
                                    throws BusinessObjectException
Gets the duration between the activity's baseline duration and the at complete duration. Computed as baseline duration - at completion duration. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryStartDateVariance

public Duration getSummaryStartDateVariance()
                                     throws BusinessObjectException
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

getSummaryActivityCount

public int getSummaryActivityCount()
                            throws BusinessObjectException
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

getSummaryCompletedActivityCount

public int getSummaryCompletedActivityCount()
                                     throws BusinessObjectException
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

getSummaryInProgressActivityCount

public int getSummaryInProgressActivityCount()
                                      throws BusinessObjectException
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

getSummaryNotStartedActivityCount

public int getSummaryNotStartedActivityCount()
                                      throws BusinessObjectException
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

getSummaryBaselineCompletedActivityCount

public int getSummaryBaselineCompletedActivityCount()
                                             throws BusinessObjectException
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

getSummaryBaselineInProgressActivityCount

public int getSummaryBaselineInProgressActivityCount()
                                              throws BusinessObjectException
Gets the number of activities that should be currently in progress, according to the primary baseline. Computed using the baseline start and finish dates and the current 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 SummaryBaselineInProgressActivityCount
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryBaselineNotStartedActivityCount

public int getSummaryBaselineNotStartedActivityCount()
                                              throws BusinessObjectException
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

getSummaryAtCompletionLaborCost

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

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

getSummaryAtCompletionNonLaborCost

public Cost getSummaryAtCompletionNonLaborCost()
                                        throws BusinessObjectException
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

getSummaryAtCompletionMaterialCost

public Cost getSummaryAtCompletionMaterialCost()
                                        throws BusinessObjectException
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

getSummaryTotalCostVariance

public Cost getSummaryTotalCostVariance()
                                 throws BusinessObjectException
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

public Duration getSummaryTotalFloat()
                              throws BusinessObjectException
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

getSummaryPerformancePercentCompleteByCost

public Percent getSummaryPerformancePercentCompleteByCost()
                                                   throws BusinessObjectException
Gets the percent complete of performance for all labor resources, nonlabor resources, and expenses. Computed as Earned Value / Budget At Completion * 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 SummaryPerformancePercentCompleteByCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummarySchedulePercentCompleteByCost

@Deprecated
public Percent getSummarySchedulePercentCompleteByCost()
                                                throws BusinessObjectException
Deprecated. As of release 6.1 SP2, the name has been changed to SummaryPerformancePercentCompleteByCost.

Gets the percent complete of performance for all labor resources, nonlabor resources, and expenses. Computed as Earned Value / Budget At Completion * 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

getSummarySchedulePercentComplete

public Percent getSummarySchedulePercentComplete()
                                          throws BusinessObjectException
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

getSummaryActualDuration

public Duration getSummaryActualDuration()
                                  throws BusinessObjectException
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

getSummaryNonLaborUnitsPercentComplete

public Percent getSummaryNonLaborUnitsPercentComplete()
                                               throws BusinessObjectException
Gets the percent complete of units for all nonlabor resources for the WBS. 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

getSummaryActualValueByLaborUnits

public Unit getSummaryActualValueByLaborUnits()
                                       throws BusinessObjectException
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

getSummaryAccountingVarianceByLaborUnits

public Unit getSummaryAccountingVarianceByLaborUnits()
                                              throws BusinessObjectException
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

getSummaryAccountingVarianceByCost

public Cost getSummaryAccountingVarianceByCost()
                                        throws BusinessObjectException
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

getSummaryBudgetAtCompletionByLaborUnits

public Unit getSummaryBudgetAtCompletionByLaborUnits()
                                              throws BusinessObjectException
Gets the Baseline 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 SummaryBudgetAtCompletionByLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryCostVarianceIndexByLaborUnits

public double getSummaryCostVarianceIndexByLaborUnits()
                                               throws BusinessObjectException
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

getSummaryScheduleVarianceIndexByLaborUnits

public double getSummaryScheduleVarianceIndexByLaborUnits()
                                                   throws BusinessObjectException
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

getSummaryEstimateAtCompletionLowPercentByLaborUnits

public Percent getSummaryEstimateAtCompletionLowPercentByLaborUnits()
                                                             throws BusinessObjectException
Gets 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

getSummaryEstimateAtCompletionHighPercentByLaborUnits

public Percent getSummaryEstimateAtCompletionHighPercentByLaborUnits()
                                                              throws BusinessObjectException
Gets 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

getSummaryPerformancePercentCompleteByLaborUnits

public Percent getSummaryPerformancePercentCompleteByLaborUnits()
                                                         throws BusinessObjectException
Gets the percent complete of performance for all labor resources. Computed as earned value labor units / baseline 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 SummaryPerformancePercentCompleteByLaborUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummarySchedulePercentCompleteByLaborUnits

public Percent getSummarySchedulePercentCompleteByLaborUnits()
                                                      throws BusinessObjectException
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

getSummaryActualTotalCost

public Cost getSummaryActualTotalCost()
                               throws BusinessObjectException
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

getSummaryAtCompletionExpenseCost

public Cost getSummaryAtCompletionExpenseCost()
                                       throws BusinessObjectException
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

getSummaryLaborCostVariance

public Cost getSummaryLaborCostVariance()
                                 throws BusinessObjectException
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

getSummaryNonLaborCostVariance

public Unit getSummaryNonLaborCostVariance()
                                    throws BusinessObjectException
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

getSummaryExpenseCostVariance

public Cost getSummaryExpenseCostVariance()
                                   throws BusinessObjectException
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

getSummaryAtCompletionTotalCostVariance

public Cost getSummaryAtCompletionTotalCostVariance()
                                             throws BusinessObjectException
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

getCreateDate

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

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

getLastUpdateDate

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

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

getCreateUser

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

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

getLastUpdateUser

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

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

getSummaryMaterialCostPercentComplete

public Percent getSummaryMaterialCostPercentComplete()
                                              throws BusinessObjectException
Gets the percent complete of cost for all material resources assigned to the WBS. 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

getSummaryNonLaborCostPercentComplete

public Percent getSummaryNonLaborCostPercentComplete()
                                              throws BusinessObjectException
Gets the percent complete of cost for all non-labor resources assigned to the WBS. 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

getSummaryDurationPercentOfPlanned

public Percent getSummaryDurationPercentOfPlanned()
                                           throws BusinessObjectException
Gets the summary actual duration percent of planned of all activities under this WBS. 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

getSummaryExpenseCostPercentComplete

public Percent getSummaryExpenseCostPercentComplete()
                                             throws BusinessObjectException
Gets the percent complete of cost for all expenses associated with the WBS. 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

getSummaryLaborCostPercentComplete

public Percent getSummaryLaborCostPercentComplete()
                                           throws BusinessObjectException
Gets the percent complete of cost for all labor resources assigned to the WBS. 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

getSummaryMaterialCostVariance

public Cost getSummaryMaterialCostVariance()
                                    throws BusinessObjectException
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

getSummaryCostPercentComplete

public Percent getSummaryCostPercentComplete()
                                      throws BusinessObjectException
Gets the percent complete of costs 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 SummaryCostPercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryCostVarianceIndex

public double getSummaryCostVarianceIndex()
                                   throws BusinessObjectException
Gets the value that is calcuated 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

getSummaryScheduleVarianceIndex

public double getSummaryScheduleVarianceIndex()
                                       throws BusinessObjectException
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

getSummaryUnitsPercentComplete

public Percent getSummaryUnitsPercentComplete()
                                       throws BusinessObjectException
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

getIsBaseline

public boolean getIsBaseline()
                      throws BusinessObjectException
Gets the boolean value indicating if this business object is related to a Project or Baseline.

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

getUDFCost

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

Gets the value of a particular Cost user defined field.

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

setUDFCost

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

Sets the value of a particular Cost user defined field.

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

getUDFDouble

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

Gets the value of a particular Double user defined field.

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

setUDFDouble

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

Sets the value of a particular Double user defined field.

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

getUDFFinishDate

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

Gets the value of a particular FinishDate user defined field.

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

setUDFFinishDate

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

Sets the value of a particular FinishDate user defined field.

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

getUDFIndicator

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

Gets the value of a particular Indicator user defined field.

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

setUDFIndicator

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

Sets the value of a particular Indicator user defined field.

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

getUDFInteger

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

Gets the value of a particular Integer user defined field.

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

setUDFInteger

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

Sets the value of a particular Integer user defined field.

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

getUDFStartDate

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

Gets the value of a particular StartDate user defined field.

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

setUDFStartDate

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

Sets the value of a particular StartDate user defined field.

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

getUDFText

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

Gets the value of a particular Text user defined field.

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

setUDFText

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

Sets the value of a particular Text user defined field.

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

getRequiredCreateFields

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

Returns:
String[] an array of required create fields

getFilterableFields

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

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

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

Returns:
String[] an internal array

getAllFields

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

Returns:
String[] an array of all fields

getInternalAllFields

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

Returns:
String[] an internal array

getInternalAllFieldsSet

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

Returns:
String[] an internal array

getMainFields

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

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

getSummaryFields

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

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

getSpreadFields

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

Returns:
String[] an array of all spread fields

getWritableFields

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

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

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

Returns:
String[] an array of field names

getMinimumXMLExportFields

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

Returns:
String[] an array of exported fields

toString

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

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

Primavera Integration API 7.0

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