Primavera Integration API 7.0

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

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.ProjectBase
              extended by com.primavera.integration.client.bo.object.Project

public class Project
extends com.primavera.integration.client.bo.base.ProjectBase

A project is a temporary endeavor undertaken to create a unique product, service, or result. Projects usually contain a work breakdown structure (WBS) and activities.

Objects that are children of projects can be accessed depending on where they are located in the WBS structure. Objects that are at the root WBS level can be accessed using "ProjectLevel" methods. Examples: createProjectLevelActivities(), loadProjectLevelIssues(), createProjectLevelRisk(), etc. Objects that are elsewhere in the WBS hierarchy can either be accessed from their parent WBS or by using the "All" methods in project: loadAllProjectRisks(), loadAllProjectNotes(), loadAllActivitySteps(), etc.

Projects may be loaded with summarized spreads (Project, ProjectResource, or ProjectRole) using the loadWithSummarizedSpread(), loadWithProjectResourceSpread(), or loadWithProjectRoleSpread() methods, respectively. The project must have been previously summarized using the summarizer job service for any type of summarized spreads to be accessible. After loading, call the appropriate method (getProjectSpread(), getProjectResourceSpreads(), or getProjectRoleSpreads()) 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 without summary, user-defined, or code assignment fields.

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

See Also:   Quick reference of Project fields


Constructor Summary
Project(Session session)
          Class constructor specifying the Session.
Project(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
Project(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId assignProjectAsBaseline(ObjectId projectId)
          Converts the provided project to be a baseline of this project.
 int calculateProjectScore(ObjectId[] aProjCodeTypeIds)
          Calculate the project score of this project based on a selected set of ProjectCodeType's.
 ObjectId convertToBaseline(ObjectId projectId)
          Converts this project to a baseline of the project provided.
 ObjectId copyBaseline(ObjectId baselineProjId)
          Creates a copy of the specified baseline project.
 ObjectId create()
          Creates this Project object in the database.
static ObjectId[] create(Session session, Project[] projects)
          Creates multiple Project objects in the database.
 ObjectId createCopy(ObjectId epsId, CopyProjectOptions projOpts, CopyWBSOptions wbsOpts, CopyActivityOptions actOpts)
          Creates a copy of the project.
 ObjectId createCopyAsBaseline()
          Copies a copy of the current project and makes the copy a baseline of the current project.
 ObjectId createCopyAsReflection()
          Copies a copy of the current project and makes the copy a reflection of the current project.
 ObjectId createProjectFunding(ProjectFunding projectfunding)
          Creates an associated ProjectFunding object in the database.
 ObjectId[] createProjectFundings(ProjectFunding[] projectfundings)
          Creates multiple associated ProjectFunding objects in the database.
 ObjectId[] createProjectLevelActivities(Activity[] projectlevelactivities)
          Creates multiple associated Activity objects in the database.
 ObjectId createProjectLevelActivity(Activity projectlevelactivity)
          Creates an associated Activity object in the database.
 ObjectId createProjectLevelBudgetChangeLog(ProjectBudgetChangeLog projectlevelbudgetchangelog)
          Creates an associated ProjectBudgetChangeLog object in the database.
 ObjectId[] createProjectLevelBudgetChangeLogs(ProjectBudgetChangeLog[] projectlevelbudgetchangelogs)
          Creates multiple associated ProjectBudgetChangeLog objects in the database.
 ObjectId createProjectLevelEstimate(ProjectEstimate projectlevelestimate)
          Creates an associated ProjectEstimate object in the database.
 ObjectId[] createProjectLevelEstimates(ProjectEstimate[] projectlevelestimates)
          Creates multiple associated ProjectEstimate objects in the database.
 ObjectId createProjectLevelIssue(ProjectIssue projectlevelissue)
          Creates an associated ProjectIssue object in the database.
 ObjectId[] createProjectLevelIssues(ProjectIssue[] projectlevelissues)
          Creates multiple associated ProjectIssue objects in the database.
 ObjectId createProjectLevelNote(ProjectNote projectlevelnote)
          Creates an associated ProjectNote object in the database.
 ObjectId[] createProjectLevelNotes(ProjectNote[] projectlevelnotes)
          Creates multiple associated ProjectNote objects in the database.
 ObjectId createProjectLevelRisk(ProjectRisk projectlevelrisk)
          Creates an associated ProjectRisk object in the database.
 ObjectId[] createProjectLevelRisks(ProjectRisk[] projectlevelrisks)
          Creates multiple associated ProjectRisk objects in the database.
 ObjectId createProjectLevelSpendingPlan(ProjectSpendingPlan projectlevelspendingplan)
          Creates an associated ProjectSpendingPlan object in the database.
 ObjectId[] createProjectLevelSpendingPlans(ProjectSpendingPlan[] projectlevelspendingplans)
          Creates multiple associated ProjectSpendingPlan objects in the database.
 ObjectId createProjectLevelThreshold(ProjectThreshold projectlevelthreshold)
          Creates an associated ProjectThreshold object in the database.
 ObjectId[] createProjectLevelThresholds(ProjectThreshold[] projectlevelthresholds)
          Creates multiple associated ProjectThreshold objects in the database.
 ObjectId createProjectLevelWBSMilestone(WBSMilestone projectlevelwbsmilestone)
          Creates an associated WBSMilestone object in the database.
 ObjectId[] createProjectLevelWBSMilestones(WBSMilestone[] projectlevelwbsmilestones)
          Creates multiple associated WBSMilestone 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.
 void delete()
          Deletes this Project object from the database.
static void delete(Session session, Project[] projects)
          Deletes multiple Project objects from the database.
 void deleteActivities(Activity[] activities)
          Deletes multiple associated Activity objects from the database.
 void deleteBaselineProjects(BaselineProject[] baselineprojects)
          Deletes multiple associated BaselineProject objects from the database.
 void deleteProjectBudgetChangeLogs(ProjectBudgetChangeLog[] projectbudgetchangelogs)
          Deletes multiple associated ProjectBudgetChangeLog objects from the database.
 void deleteProjectEstimates(ProjectEstimate[] projectestimates)
          Deletes multiple associated ProjectEstimate objects from the database.
 void deleteProjectFundings(ProjectFunding[] projectfundings)
          Deletes multiple associated ProjectFunding 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 deleteProjectSpendingPlans(ProjectSpendingPlan[] projectspendingplans)
          Deletes multiple associated ProjectSpendingPlan objects from the database.
 void deleteProjectThresholds(ProjectThreshold[] projectthresholds)
          Deletes multiple associated ProjectThreshold objects from the database.
 void deleteWBS(WBS[] wbs)
          Deletes multiple associated WBS objects from the database.
 void deleteWBSMilestones(WBSMilestone[] wbsmilestones)
          Deletes multiple associated WBSMilestone objects from the database.
 ObjectId[] getActivitiesWithCodeChanges(java.util.Date sinceDate)
          Deprecated. As of release 5.0 SP3, load the ActivityCodeAssignment objects to determine what changed. Use the timestamp fields in the where clause to see changes since a particular time.
 ObjectId[] getActivitiesWithUDFChanges(java.util.Date sinceDate)
          Deprecated. As of release 5.0 SP3, load the UDFValue objects to determine what changed. Use the timestamp fields in the where clause to see changes since a particular time.
 ObjectId[] getActivityCodeTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the activity code assignments using the ActivityCodeAssignment object.
 ActivityType getActivityDefaultActivityType()
          Gets the default type for activities.
 ObjectId getActivityDefaultCalendarObjectId()
          Gets the unique ID of the calendar assigned to new activities by default.
 ObjectId getActivityDefaultCostAccountObjectId()
          Gets the unique ID of the cost account assigned to new activities and project expenses by default.
 DurationType getActivityDefaultDurationType()
          Gets the duration type assigned to new activities by default.
 PercentCompleteType getActivityDefaultPercentCompleteType()
          Gets the percent complete type assigned to new activities by default.
 Cost getActivityDefaultPricePerUnit()
          Gets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments.
 boolean getActivityIdBasedOnSelectedActivity()
          Gets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix.
 int getActivityIdIncrement()
          Gets the increment used for auto-numbering of activity IDs.
 java.lang.String getActivityIdPrefix()
          Gets the prefix used for auto-numbering of activity IDs.
 int getActivityIdSuffix()
          Gets the suffix used for auto-numbering of activity IDs.
 boolean getActivityPercentCompleteBasedOnActivitySteps()
          Gets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.
 ObjectId[] getActivityUDFTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.
 boolean getAddActualToRemaining()
          Gets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated.
 java.lang.String getAddedBy()
          Gets the name of the user who added the project to the database.
static java.lang.String[] getAllFields()
          Gets all non-code fields for this business object.
 boolean getAllowNegativeActualUnitsFlag()
          Gets the flag that indicates whether the project can allow the negative valus for the actual units.
 double getAnnualDiscountRate()
          Gets the user-defined number field that identifies the discount rate for the project.
 EndDate getAnticipatedFinishDate()
          Gets the anticipated finish date of Project element.
 BeginDate getAnticipatedStartDate()
          Gets the anticipated start date of Project element.
 boolean getAssignmentDefaultDrivingFlag()
          Gets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.
 DefaultRateType getAssignmentDefaultRateType()
          Gets the default rate type when adding resource assignments to a project.
 java.util.Date getCheckOutDate()
          Gets the date on which the project was checked out of the Project Management database.
 boolean getCheckOutStatus()
          Gets the flag that indicates that the project is currently checked out to an external file or database and is being managed remotely.
 ObjectId getCheckOutUserObjectId()
          Gets the unique ID of the User that checked out this project.
 java.lang.String getCodeValue(ObjectId codeTypeObjectId)
          Deprecated. As of release 5.0 SP3, load project code assignments using the ProjectCodeAssignment business object.
 ObjectId getCodeValueObjectId(ObjectId codeTypeObjectId)
          Deprecated. As of release 5.0 SP3, load project code assignments using the ProjectCodeAssignment business object.
 boolean getContainsSummaryData()
          Gets the flag that indicates that the Project has been summarized.
 boolean getContainsSummaryDataOnly()
          Gets the flag that indicates that the project does not contain detail data and cannot be opened.
 boolean getCostQuantityRecalculateFlag()
          Gets the flag that, when costs and quantities are linked, indicates whether the quantities should be updated when costs are updated,.
 java.util.Date getCreateDate()
          Gets the date this project was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this project.
 Duration getCriticalActivityFloatLimit()
          Gets the duration used to determine if an activity is critical.
 CriticalActivityPathType getCriticalActivityPathType()
          Gets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.
 ObjectId getCurrentBaselineProjectObjectId()
          Gets the unique ID of the project's baseline to use for computing summaries.
 Cost getCurrentBudget()
          Gets the sum of the original budget plus the approved and pending budgets from the budget change log.
 Cost getCurrentVariance()
          Gets the difference between the current budget and the total spending plan.
 java.util.Date getDataDate()
          Gets the current data date for the project.
 java.util.Date getDateAdded()
          Gets the date on which the project was added to the Project Management database.
 UnitType getDefaultPriceTimeUnits()
          Gets the time units associated with the project's default price per time.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 DiscountApplicationPeriod getDiscountApplicationPeriod()
          Gets the timescale for entering ROI spending and benefit plan.
 Cost getDistributedCurrentBudget()
          Gets the current budget values from one level lower.
 EarnedValueComputeType getEarnedValueComputeType()
          Gets the technique used for computing earned-value percent complete for activities within the Project.
 EarnedValueETCComputeType getEarnedValueETCComputeType()
          Gets the technique for computing earned-value estimate-to-complete for activities within the Project.
 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 Project.
 boolean getEnableSummarization()
          Gets the option which, when true, directs the Summarizer service to automatically summarize the project.
 Unit getEstimatedWeight()
          Gets the estimation weight for the Project 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 project.
 int getFiscalYearStartMonth()
          Gets the month that marks the beginning of the fiscal year for the project.
 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.
 boolean getHasFutureBucketData()
          Gets the flag that indicates whether a resource assignment in the project has future bucket data.
 java.lang.String getId()
          Gets the short code assigned to each Project element for identification.
 Unit getIndependentETCLaborUnits()
          Gets the user-entered ETC total labor.
 Cost getIndependentETCTotalCost()
          Gets the user-entered ETC total cost.
 IntegratedProjectType getIntegratedType()
          Gets the flag indicating whether the project is integrated with an Enterprise Resource Planning (ERP) system.
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.
 java.util.Date getLastApplyActualsDate()
          Gets the last date Apply Actuals was run for this project.
 ObjectId getLastFinancialPeriodObjectId()
          Gets the unique ID of the last closed financial period for the project.
 java.util.Date getLastSummarizedDate()
          Gets the date the project was last summarized.
 java.util.Date getLastUpdateDate()
          Gets the date this project was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this project.
 int getLevelingPriority()
          Gets the priority for scheduling.
 boolean getLinkActualToActualThisPeriod()
          Gets the flag that indicates whether actual units and costs are linked to actual-this-period units and costs.
 boolean getLinkPercentCompleteWithActual()
          Gets the flag that indicates whether actual units and cost should be recalculated when percent complete changes.
 boolean getLinkPlannedAndAtCompletionFlag()
          Gets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities.
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
 boolean getMSProjectManagedFlag()
          Gets the flag indicating whether this is a Microsoft Project-managed project.
 EndDate getMustFinishByDate()
          Gets the date by which all project activities must finish.
 java.lang.String getName()
          Gets the name of the Project 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 Project.
 Cost getOriginalBudget()
          Gets the original budget for the project.
 int getOverallProjectScore()
          Gets the project score calculated based on all project code types assigned to this project.
 ObjectId getOwnerResourceObjectId()
          Gets the unique ID of the Owner Resource of this project.
 ObjectId getParentEPSObjectId()
          Gets the unique ID of the parent EPS of this project.
 BeginDate getPlannedStartDate()
          Gets the planned start date of the project.
 boolean getPrimaryResourcesCanMarkActivitiesAsCompleted()
          Gets the flag that indicates whether primary resources can mark the project activities as completed.
 ObjectId[] getProjectCodeTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the project code assignments using the ProjectCodeAssignment object.
 BeginDate getProjectForecastStartDate()
          Gets the alternate start date to be optionally used by the scheduler.
 ProjectResourceSpread[] getProjectResourceSpreads()
          Gets the field containing resource spread data for this project.
 ProjectRoleSpread[] getProjectRoleSpreads()
          Gets the field containing role spread data for this project.
 ProjectSpread getProjectSpread()
          Gets the field containing spread data for this project.
 Cost getProposedBudget()
          Gets the Proposed Budget, which is 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.
 boolean getResetPlannedToRemainingFlag()
          Gets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started.
 boolean getResourceCanBeAssignedToSameActivityMoreThanOnce()
          Gets the flag that indicates whether a resource can be assigned more than once to the same activity.
 boolean getResourcesCanAssignThemselvesToActivities()
          Gets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.
 boolean getResourcesCanEditAssignmentPercentComplete()
          Gets the flag that indicates whether the project's resource update the remaining units or the percent complete for their activities in the timesheet application.
 boolean getResourcesCanMarkAssignmentAsCompleted()
          Gets the flag that indicates whether timesheet resources can mark the assignment as complete.
 boolean getResourcesCanViewInactiveActivities()
          Gets the flag that indicates whether timesheet resources can view inactive project activities.
static java.lang.String[] getResourceSpreadFields()
          Gets all spread fields that can be specified in the spreadFields parameter of loadWithProjectResourceSpread methods for this business object.
 ProjectRiskLevel getRiskLevel()
          Gets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'.
static java.lang.String[] getRoleSpreadFields()
          Gets all spread fields that can be specified in the spreadFields parameter of loadWithProjectRoleSpread methods for this business object.
 EndDate getScheduledFinishDate()
          Gets the early finish date of the latest activity in the project, as computed by the project scheduler.
 ObjectId getSourceProjectObjectId()
          Gets the unique ID of the project from which the reflection project was created, if the current project is a reflection project.
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 project.
 ProjectStatus getStatus()
          Gets the project status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.
 int getStrategicPriority()
          Gets the project's priority.
 java.util.Date getSummarizedDataDate()
          Gets the data date of the project when it was last summarized-only updated by summarizer.
 int getSummarizeToWBSLevel()
          Gets the maximum level within the project's WBS to perform summarization - default to 2.
 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 project.
 EndDate getSummaryActualFinishDate()
          Gets the latest actual finish date of all activities in the project.
 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 project.
 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 duration at completion.
 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 project for the current baseline.
 int getSummaryBaselineInProgressActivityCount()
          Gets the number of in-progress activities in the 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 Project 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 Project.
 Percent getSummaryCostPercentComplete()
          Gets the percent complete of cost for all nonlabor resources assigned.
 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 calculated 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 project.
 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 project.
 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 project.
 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 Project.
 Unit getSummaryLaborUnitsVariance()
          Gets the difference between baseline labor units and at completion labor units.
 SummaryLevel getSummaryLevel()
          Gets the summary level for the project while performing project summarization.
 Percent getSummaryMaterialCostPercentComplete()
          Gets the percent complete of cost for all material resources assigned to the project.
 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 project.
 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 Project.
 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 Project remaining start date to the remaining finish date.
 Cost getSummaryRemainingExpenseCost()
          Gets the remaining costs for all project expenses associated with the activities in the Project.
 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 Project.
 Cost getSummaryRemainingNonLaborCost()
          Gets the remaining nonlabor costs for all project expenses associated with the activities in the Project.
 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 Project.
 Cost getSummaryRemainingTotalCost()
          Gets the sum of all remaining total costs in the Project.
 Percent getSummarySchedulePercentComplete()
          Gets the measure that indicates how much of the Project 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 Project can be delayed before delaying the project finish date.
 Percent getSummaryUnitsPercentComplete()
          Gets the percent complete of units for the resource assignments in the Project.
 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 getTotalFunding()
          Gets the total amount of funding contributed to the project by your funding sources.
 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 total current budget minus the distributed current budget.
 Cost getUndistributedCurrentVariance()
          Gets the total spending plan minus the total spending plan tally.
 boolean getUseProjectBaselineForEarnedValue()
          Gets the flag that indicates whether earned value should be calculated based on the project baseline or the user's primary baseline.
 java.lang.String getWBSCodeSeparator()
          Gets the character used to separate the concatenated code fields for the project's WBS tree.
 ObjectId getWBSObjectId()
          Gets the internal WBS ID of the project.
 java.lang.String getWebSiteRootDirectory()
          Gets the root directory for storing project Web site files before they are published to the Web server.
 java.lang.String getWebSiteURL()
          Gets the project Web site URL, which is the Web address of the project's website.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static Project load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single Project object from the database.
static BOIterator<Project> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple Project objects from the database.
 BOIterator<ActivityCodeType> loadActivityCodeTypes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityCodeType objects from the database.
 BOIterator<Activity> loadAllActivities(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Activity objects from the database.
 BOIterator<Activity> loadAllActivitiesWithLiveSpread(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 Activity objects with Live spreads from the database.
 BOIterator<ActivityCodeAssignment> loadAllActivityCodeAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityCodeAssignment objects from the database.
 BOIterator<ActivityExpense> loadAllActivityExpenses(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityExpense objects from the database.
 BOIterator<ActivityNote> loadAllActivityNotes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityNote objects from the database.
 BOIterator<ActivityOwner> loadAllActivityOwners(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityOwner objects from the database.
 BOIterator<ActivityPeriodActual> loadAllActivityPeriodActuals(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityPeriodActual objects from the database.
 BOIterator<ActivityStep> loadAllActivitySteps(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityStep objects from the database.
 BOIterator<BaselineProject> loadAllBaselineProjects(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated BaselineProject objects from the database.
 BOIterator<Initiation> loadAllInitiations(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Initiation objects from the database.
 BOIterator<ProjectBudgetChangeLog> loadAllProjectBudgetChangeLogs(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectBudgetChangeLog objects from the database.
 BOIterator<ProjectEstimate> loadAllProjectEstimates(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectEstimate objects from the database.
 BOIterator<ProjectIssue> loadAllProjectIssues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectIssue objects from the database.
 BOIterator<ProjectNote> loadAllProjectNotes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectNote objects from the database.
 BOIterator<ProjectResourceQuantity> loadAllProjectResourceQuantities(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectResourceQuantity objects from the database.
 BOIterator<ProjectResource> loadAllProjectResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectResource objects from the database.
 BOIterator<ProjectRisk> loadAllProjectRisks(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectRisk objects from the database.
 BOIterator<ProjectSpendingPlan> loadAllProjectSpendingPlans(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectSpendingPlan objects from the database.
 BOIterator<ProjectThreshold> loadAllProjectThresholds(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectThreshold objects from the database.
 BOIterator<ResourceAssignmentPeriodActual> loadAllResourceAssignmentPeriodActuals(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceAssignmentPeriodActual objects from the database.
 BOIterator<ResourceAssignment> loadAllResourceAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceAssignment objects from the database.
 BOIterator<ResourceAssignment> loadAllResourceAssignmentsWithLiveSpread(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 ResourceAssignment objects with Live spreads from the database.
 BOIterator<Resource> loadAllResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Resource objects from the database.
 BOIterator<UDFValue> loadAllUDFValues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UDFValue objects from the database.
 BOIterator<WBS> loadAllWBS(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated WBS objects from the database.
 BOIterator<WBSMilestone> loadAllWBSMilestones(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated WBSMilestone objects from the database.
 BOIterator<WBS> loadAllWBSWithSummarizedSpread(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<BatchReport> loadBatchReports(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated BatchReport objects from the database.
 BOIterator<UDFValue> loadCalculatedUDFValues(UDFType[] udfTypes)
          Loads multiple associated UDFValue objects
 BaselineProject loadCurrentBaselineProject(java.lang.String[] fields)
          Loads an associated BaselineProject object from the database.
 Calendar loadDefaultCalendar(java.lang.String[] fields)
          Loads an associated Calendar object from the database.
 BOIterator<Document> loadDocuments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Document objects from the database.
 BOIterator<IssueHistory> loadIssueHistories(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated IssueHistory objects from the database.
 OBS loadOBS(java.lang.String[] fields)
          Loads an associated OBS object from the database.
 EPS loadParentEPS(java.lang.String[] fields)
          Loads an associated EPS object from the database.
 BOIterator<Calendar> loadProjectCalendars(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Calendar objects from the database.
 BOIterator<ProjectCodeAssignment> loadProjectCodeAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectCodeAssignment 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<ProjectFunding> loadProjectFundings(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectFunding objects from the database.
 BOIterator<Activity> loadProjectLevelActivities(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Activity objects from the database.
 BOIterator<ProjectBudgetChangeLog> loadProjectLevelBudgetChangeLogs(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectBudgetChangeLog objects from the database.
 BOIterator<ProjectEstimate> loadProjectLevelEstimates(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectEstimate objects from the database.
 BOIterator<ProjectIssue> loadProjectLevelIssues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectIssue objects from the database.
 BOIterator<ProjectNote> loadProjectLevelNotes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectNote objects from the database.
 BOIterator<ProjectResource> loadProjectLevelResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectResource objects from the database.
 BOIterator<ProjectRisk> loadProjectLevelRisks(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectRisk objects from the database.
 BOIterator<ProjectSpendingPlan> loadProjectLevelSpendingPlans(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectSpendingPlan objects from the database.
 BOIterator<ProjectThreshold> loadProjectLevelThresholds(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectThreshold objects from the database.
 BOIterator<UDFValue> loadProjectLevelUDFValues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UDFValue objects from the database.
 BOIterator<WBSMilestone> loadProjectLevelWBSMilestones(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated WBSMilestone objects from the database.
 BOIterator<Relationship> loadRelationships(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Relationship objects from the database.
 BOIterator<ResourceHour> loadResourceHours(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceHour objects from the database.
 ScheduleOptions loadScheduleOptions(java.lang.String[] fields)
          Loads an associated ScheduleOptions 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.
static BOIterator<Project> loadWithProjectResourceSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId[] objIds, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative, ObjectId[] resourceObjectIds)
          Loads multiple Project objects with Resource spreads from the database.
static Project loadWithProjectResourceSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId objId, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative, ObjectId[] resourceObjectIds)
          Loads a Project object with Resource spreads from the database.
static BOIterator<Project> loadWithProjectRoleSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId[] objIds, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative, ObjectId[] roleObjectIds)
          Loads multiple Project objects with Role spreads from the database.
static Project loadWithProjectRoleSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId objId, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative, ObjectId[] roleObjectIds)
          Loads a Project object with Role spreads from the database.
static BOIterator<Project> 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 Project objects with summarized spreads from the database.
static Project 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 Project object with summarized spreads from the database.
 boolean lockProject()
          Locks the project in exclusive mode.
 void setActivityDefaultActivityType(ActivityType enm)
          Sets the default type for activities.
 void setActivityDefaultCalendarObjectId(ObjectId o)
          Sets the unique ID of the calendar assigned to new activities by default.
 void setActivityDefaultCostAccountObjectId(ObjectId o)
          Sets the unique ID of the cost account assigned to new activities and project expenses by default.
 void setActivityDefaultDurationType(DurationType enm)
          Sets the duration type assigned to new activities by default.
 void setActivityDefaultPercentCompleteType(PercentCompleteType enm)
          Sets the percent complete type assigned to new activities by default.
 void setActivityDefaultPricePerUnit(Cost c)
          Sets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments.
 void setActivityIdBasedOnSelectedActivity(boolean b)
          Sets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix.
 void setActivityIdIncrement(int i)
          Sets the increment used for auto-numbering of activity IDs.
 void setActivityIdPrefix(java.lang.String s)
          Sets the prefix used for auto-numbering of activity IDs.
 void setActivityIdSuffix(int i)
          Sets the suffix used for auto-numbering of activity IDs.
 void setActivityPercentCompleteBasedOnActivitySteps(boolean b)
          Sets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.
 void setAddActualToRemaining(boolean b)
          Sets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated.
 void setAddedBy(java.lang.String s)
          Sets the name of the user who added the project to the database.
 void setAllowNegativeActualUnitsFlag(boolean b)
          Sets the flag that indicates whether the project can allow the negative valus for the actual units.
 void setAnnualDiscountRate(double d)
          Sets the user-defined number field that identifies the discount rate for the project.
 void setAnticipatedFinishDate(EndDate d)
          Sets the anticipated finish date of Project element.
 void setAnticipatedStartDate(BeginDate d)
          Sets the anticipated start date of Project element.
 void setAssignmentDefaultDrivingFlag(boolean b)
          Sets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.
 void setAssignmentDefaultRateType(DefaultRateType enm)
          Sets the default rate type when adding resource assignments to a project.
 void setCheckOutStatus(boolean b)
          Sets the flag that indicates that the project is currently checked out to an external file or database and is being managed remotely.
 void setCodeValueObjectId(ObjectId codeTypeObjectId, ObjectId codeValueObjectId)
          Deprecated. As of release 5.0 SP3, create or update project code assignments using the ProjectCodeAssignment business object.
 void setContainsSummaryDataOnly(boolean b)
          Sets the flag that indicates that the project does not contain detail data and cannot be opened.
 void setCostQuantityRecalculateFlag(boolean b)
          Sets the flag that, when costs and quantities are linked, indicates whether the quantities should be updated when costs are updated,.
 void setCriticalActivityFloatLimit(Duration d)
          Sets the duration used to determine if an activity is critical.
 void setCriticalActivityPathType(CriticalActivityPathType enm)
          Sets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.
 void setCurrentBaselineProjectObjectId(ObjectId o)
          Sets the unique ID of the project's baseline to use for computing summaries.
 void setDataDate(java.util.Date d)
          Sets the current data date for the project.
 void setDateAdded(java.util.Date d)
          Sets the date on which the project was added to the Project Management database.
 void setDefaultPriceTimeUnits(UnitType enm)
          Sets the time units associated with the project's default price per time.
 void setDiscountApplicationPeriod(DiscountApplicationPeriod enm)
          Sets the timescale for entering ROI spending and benefit plan.
 void setEarnedValueComputeType(EarnedValueComputeType enm)
          Sets the technique used for computing earned-value percent complete for activities within the Project.
 void setEarnedValueETCComputeType(EarnedValueETCComputeType enm)
          Sets the technique for computing earned-value estimate-to-complete for activities within the Project.
 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 Project.
 void setEnableSummarization(boolean b)
          Sets the option which, when true, directs the Summarizer service to automatically summarize the project.
 void setEstimatedWeight(Unit u)
          Sets the estimation weight for the Project element, used for top-down estimation.
 void setFiscalYearStartMonth(int i)
          Sets the month that marks the beginning of the fiscal year for the project.
 void setGUID(java.lang.String s)
          Sets the globally unique ID generated by the system.
 void setId(java.lang.String s)
          Sets the short code assigned to each Project element for identification.
 void setIndependentETCLaborUnits(Unit u)
          Sets the user-entered ETC total labor.
 void setIndependentETCTotalCost(Cost c)
          Sets the user-entered ETC total cost.
 void setIntegratedType(IntegratedProjectType enm)
          Sets the flag indicating whether the project is integrated with an Enterprise Resource Planning (ERP) system.
 void setLastFinancialPeriodObjectId(ObjectId o)
          Sets the unique ID of the last closed financial period for the project.
 void setLevelingPriority(int i)
          Sets the priority for scheduling.
 void setLinkActualToActualThisPeriod(boolean b)
          Sets the flag that indicates whether actual units and costs are linked to actual-this-period units and costs.
 void setLinkPercentCompleteWithActual(boolean b)
          Sets the flag that indicates whether actual units and cost should be recalculated when percent complete changes.
 void setLinkPlannedAndAtCompletionFlag(boolean b)
          Sets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities.
 void setMustFinishByDate(EndDate d)
          Sets the date by which all project activities must finish.
 void setName(java.lang.String s)
          Sets the name of the Project 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 Project.
 void setOriginalBudget(Cost c)
          Sets the original budget for the project.
 void setOwnerResourceObjectId(ObjectId o)
          Sets the unique ID of the Owner Resource of this project.
 void setParentEPSObjectId(ObjectId o)
          Sets the unique ID of the parent EPS of this project.
 void setPlannedStartDate(BeginDate d)
          Sets the planned start date of the project.
 void setPrimaryResourcesCanMarkActivitiesAsCompleted(boolean b)
          Sets the flag that indicates whether primary resources can mark the project activities as completed.
 void setProjectForecastStartDate(BeginDate d)
          Sets the alternate start date to be optionally used by the scheduler.
 void setResetPlannedToRemainingFlag(boolean b)
          Sets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started.
 void setResourceCanBeAssignedToSameActivityMoreThanOnce(boolean b)
          Sets the flag that indicates whether a resource can be assigned more than once to the same activity.
 void setResourcesCanAssignThemselvesToActivities(boolean b)
          Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.
 void setResourcesCanEditAssignmentPercentComplete(boolean b)
          Sets the flag that indicates whether the project's resource update the remaining units or the percent complete for their activities in the timesheet application.
 void setResourcesCanMarkAssignmentAsCompleted(boolean b)
          Sets the flag that indicates whether timesheet resources can mark the assignment as complete.
 void setResourcesCanViewInactiveActivities(boolean b)
          Sets the flag that indicates whether timesheet resources can view inactive project activities.
 void setRiskLevel(ProjectRiskLevel enm)
          Sets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'.
 void setScheduledFinishDate(EndDate d)
          Sets the early finish date of the latest activity in the project, as computed by the project scheduler.
 void setStatus(ProjectStatus enm)
          Sets the project status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.
 void setStrategicPriority(int i)
          Sets the project's priority.
 void setSummarizedDataDate(java.util.Date d)
          Sets the data date of the project when it was last summarized-only updated by summarizer.
 void setSummarizeToWBSLevel(int i)
          Sets the maximum level within the project's WBS to perform summarization - default to 2.
 void setSummaryLevel(SummaryLevel enm)
          Sets the summary level for the project while performing project summarization.
 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 setUseProjectBaselineForEarnedValue(boolean b)
          Sets the flag that indicates whether earned value should be calculated based on the project baseline or the user's primary baseline.
 void setWBSCodeSeparator(java.lang.String s)
          Sets the character used to separate the concatenated code fields for the project's WBS tree.
 void setWebSiteRootDirectory(java.lang.String s)
          Sets the root directory for storing project Web site files before they are published to the Web server.
 void setWebSiteURL(java.lang.String s)
          Sets the project Web site URL, which is the Web address of the project's website.
 java.lang.String toString()
          Returns a string representation of the object.
 boolean unlockProject()
          Unlocks this project if it was previously exclusively locked by the current user.
 void update()
          Updates this Project object in the database.
static void update(Session session, Project[] projects)
          Updates multiple Project objects in the database.
 void updateAllActivities(Activity[] allactivities)
          Updates multiple associated Activity objects in the database.
 void updateAllWBS(WBS[] allwbs)
          Updates multiple associated WBS objects in the database.
 void updateProjectFundings(ProjectFunding[] projectfundings)
          Updates multiple associated ProjectFunding objects in the database.
 void updateProjectLevelBudgetChangeLogs(ProjectBudgetChangeLog[] projectlevelbudgetchangelogs)
          Updates multiple associated ProjectBudgetChangeLog objects in the database.
 void updateProjectLevelEstimates(ProjectEstimate[] projectlevelestimates)
          Updates multiple associated ProjectEstimate objects in the database.
 void updateProjectLevelIssues(ProjectIssue[] projectlevelissues)
          Updates multiple associated ProjectIssue objects in the database.
 void updateProjectLevelNotes(ProjectNote[] projectlevelnotes)
          Updates multiple associated ProjectNote objects in the database.
 void updateProjectLevelRisks(ProjectRisk[] projectlevelrisks)
          Updates multiple associated ProjectRisk objects in the database.
 void updateProjectLevelSpendingPlans(ProjectSpendingPlan[] projectlevelspendingplans)
          Updates multiple associated ProjectSpendingPlan objects in the database.
 void updateProjectLevelThresholds(ProjectThreshold[] projectlevelthresholds)
          Updates multiple associated ProjectThreshold objects in the database.
 void updateProjectLevelWBSMilestones(WBSMilestone[] projectlevelwbsmilestones)
          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

Project

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

Project

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

Project

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

Returns:
ObjectId the unique ID of the newly created 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

create

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

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

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

loadWithSummarizedSpread

public static Project 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 Project object with summarized spreads from the database.

Parameters:
nonSpreadFields - fields to load
objId - unique ID of the Project 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:
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

loadWithProjectResourceSpread

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

Parameters:
nonSpreadFields - fields to load
objId - unique ID of the Project 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
resourceObjectIds - indicates
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

loadWithProjectRoleSpread

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

Parameters:
nonSpreadFields - fields to load
objId - unique ID of the Project 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
roleObjectIds - indicates
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

load

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

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the Project 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<Project> 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 Project objects with summarized spreads from the database.

Parameters:
nonSpreadFields - fields to load
objIds - object ids of the Project 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

loadWithProjectResourceSpread

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

Parameters:
nonSpreadFields - fields to load
objIds - object ids of the Project 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

loadWithProjectRoleSpread

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

Parameters:
nonSpreadFields - fields to load
objIds - object ids of the Project 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 Project 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,
                          Project[] projects)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple Project objects in the database.

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

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

delete

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

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

loadParentEPS

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

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

loadAllBaselineProjects

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

deleteBaselineProjects

public void deleteBaselineProjects(BaselineProject[] baselineprojects)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Deletes multiple associated BaselineProject objects from the database.

Parameters:
baselineprojects - array of BaselineProject 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

loadCurrentBaselineProject

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

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

loadAllWBS

public BOIterator<WBS> loadAllWBS(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

loadAllWBSWithSummarizedSpread

public BOIterator<WBS> loadAllWBSWithSummarizedSpread(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

updateAllWBS

public void updateAllWBS(WBS[] allwbs)
                  throws ServerException,
                         NetworkException,
                         BusinessObjectException
Updates multiple associated WBS objects in the database.

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

deleteWBS

public void deleteWBS(WBS[] wbs)
               throws ServerException,
                      NetworkException,
                      BusinessObjectException
Deletes multiple associated WBS objects from the database.

Parameters:
wbs - array of WBS objects to delete
Throws:
ServerException - if a problem occurred on the server-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

loadAllProjectThresholds

public BOIterator<ProjectThreshold> loadAllProjectThresholds(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

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

createProjectLevelThreshold

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

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

createProjectLevelThresholds

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

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

loadProjectLevelThresholds

public BOIterator<ProjectThreshold> loadProjectLevelThresholds(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

updateProjectLevelThresholds

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

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

loadAllActivities

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

loadAllActivitiesWithLiveSpread

public BOIterator<Activity> loadAllActivitiesWithLiveSpread(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 Activity objects with Live 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

updateAllActivities

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

Parameters:
allactivities - array of Activity objects to update
Throws:
ServerException - if a problem occurred on the server-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

createProjectLevelActivity

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

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

createProjectLevelActivities

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

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

loadProjectLevelActivities

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

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

createProjectLevelIssue

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

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

createProjectLevelIssues

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

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

loadProjectLevelIssues

public BOIterator<ProjectIssue> loadProjectLevelIssues(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

updateProjectLevelIssues

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

Parameters:
projectlevelissues - array of ProjectIssue objects to update
Throws:
ServerException - if a problem occurred on the server-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

loadAllProjectIssues

public BOIterator<ProjectIssue> loadAllProjectIssues(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

createProjectLevelBudgetChangeLog

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

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

createProjectLevelBudgetChangeLogs

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

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

loadProjectLevelBudgetChangeLogs

public BOIterator<ProjectBudgetChangeLog> loadProjectLevelBudgetChangeLogs(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

updateProjectLevelBudgetChangeLogs

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

Parameters:
projectlevelbudgetchangelogs - array of ProjectBudgetChangeLog objects to update
Throws:
ServerException - if a problem occurred on the server-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

loadAllProjectBudgetChangeLogs

public BOIterator<ProjectBudgetChangeLog> loadAllProjectBudgetChangeLogs(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

createProjectLevelRisk

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

Parameters:
projectlevelrisk - ProjectLevelRisk 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

createProjectLevelRisks

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

Parameters:
projectlevelrisks - array of ProjectLevelRisk 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

loadProjectLevelRisks

public BOIterator<ProjectRisk> loadProjectLevelRisks(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

updateProjectLevelRisks

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

Parameters:
projectlevelrisks - 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

loadAllProjectRisks

public BOIterator<ProjectRisk> loadAllProjectRisks(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

createProjectFunding

public ObjectId createProjectFunding(ProjectFunding projectfunding)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Creates an associated ProjectFunding object in the database.

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

createProjectFundings

public ObjectId[] createProjectFundings(ProjectFunding[] projectfundings)
                                 throws ServerException,
                                        NetworkException,
                                        BusinessObjectException
Creates multiple associated ProjectFunding objects in the database.

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

loadProjectFundings

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

updateProjectFundings

public void updateProjectFundings(ProjectFunding[] projectfundings)
                           throws ServerException,
                                  NetworkException,
                                  BusinessObjectException
Updates multiple associated ProjectFunding objects in the database.

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

deleteProjectFundings

public void deleteProjectFundings(ProjectFunding[] projectfundings)
                           throws ServerException,
                                  NetworkException,
                                  BusinessObjectException
Deletes multiple associated ProjectFunding objects from the database.

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

createProjectLevelNote

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

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

createProjectLevelNotes

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

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

loadProjectLevelNotes

public BOIterator<ProjectNote> loadProjectLevelNotes(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

updateProjectLevelNotes

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

Parameters:
projectlevelnotes - array of ProjectNote objects to update
Throws:
ServerException - if a problem occurred on the server-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

loadAllProjectNotes

public BOIterator<ProjectNote> loadAllProjectNotes(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

loadProjectLevelResources

public BOIterator<ProjectResource> loadProjectLevelResources(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

loadAllProjectResources

public BOIterator<ProjectResource> loadAllProjectResources(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

loadAllProjectResourceQuantities

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

createProjectLevelWBSMilestone

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

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

createProjectLevelWBSMilestones

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

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

loadProjectLevelWBSMilestones

public BOIterator<WBSMilestone> loadProjectLevelWBSMilestones(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

updateProjectLevelWBSMilestones

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

Parameters:
projectlevelwbsmilestones - array of WBSMilestone objects to update
Throws:
ServerException - if a problem occurred on the server-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

loadAllWBSMilestones

public BOIterator<WBSMilestone> loadAllWBSMilestones(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

loadAllActivityExpenses

public BOIterator<ActivityExpense> loadAllActivityExpenses(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

loadAllActivityNotes

public BOIterator<ActivityNote> loadAllActivityNotes(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

loadAllActivitySteps

public BOIterator<ActivityStep> loadAllActivitySteps(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

loadAllActivityOwners

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

loadAllResourceAssignments

public BOIterator<ResourceAssignment> loadAllResourceAssignments(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

loadAllResourceAssignmentsWithLiveSpread

public BOIterator<ResourceAssignment> loadAllResourceAssignmentsWithLiveSpread(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 ResourceAssignment objects with Live 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

loadAllActivityPeriodActuals

public BOIterator<ActivityPeriodActual> loadAllActivityPeriodActuals(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

loadAllResourceAssignmentPeriodActuals

public BOIterator<ResourceAssignmentPeriodActual> loadAllResourceAssignmentPeriodActuals(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

loadAllActivityCodeAssignments

public BOIterator<ActivityCodeAssignment> loadAllActivityCodeAssignments(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

loadAllUDFValues

public BOIterator<UDFValue> loadAllUDFValues(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

loadProjectLevelUDFValues

public BOIterator<UDFValue> loadProjectLevelUDFValues(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

loadResourceHours

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

loadScheduleOptions

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

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

loadDefaultCalendar

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

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

loadProjectCalendars

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

loadActivityCodeTypes

public BOIterator<ActivityCodeType> loadActivityCodeTypes(java.lang.String[] fields,
                                                          java.lang.String sWhereClause,
                                                          java.lang.String sOrderBy)
                                                   throws ServerException,
                                                          NetworkException,
                                                          BusinessObjectException
Loads multiple associated ActivityCodeType objects from the database. Note: Only ActivityCodeTypes with a scope of Project are included.

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

loadBatchReports

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

loadIssueHistories

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

createProjectLevelSpendingPlan

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

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

createProjectLevelSpendingPlans

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

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

loadProjectLevelSpendingPlans

public BOIterator<ProjectSpendingPlan> loadProjectLevelSpendingPlans(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

updateProjectLevelSpendingPlans

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

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

loadAllProjectSpendingPlans

public BOIterator<ProjectSpendingPlan> loadAllProjectSpendingPlans(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

deleteProjectSpendingPlans

public void deleteProjectSpendingPlans(ProjectSpendingPlan[] projectspendingplans)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Deletes multiple associated ProjectSpendingPlan objects from the database.

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

createProjectLevelEstimate

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

Parameters:
projectlevelestimate - ProjectLevelEstimate 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

createProjectLevelEstimates

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

Parameters:
projectlevelestimates - array of ProjectLevelEstimate 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

loadProjectLevelEstimates

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

updateProjectLevelEstimates

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

Parameters:
projectlevelestimates - 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

loadAllProjectEstimates

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

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

loadDocuments

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

loadAllInitiations

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

loadProjectCodeAssignments

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

loadRelationships

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

Overrides:
loadRelationships in class com.primavera.integration.client.bo.base.ProjectBase
Parameters:
fields - array of field names
sWhereClause - where clause
sOrderBy - order by clause
Returns:
BOIterator that contains Relationships
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

loadAllResources

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

Overrides:
loadAllResources in class com.primavera.integration.client.bo.base.ProjectBase
Parameters:
fields - array of field names
sWhereClause - where clause
sOrderBy - order by clause
Returns:
BOIterator that contains Resources
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

setCodeValueObjectId

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

Assigns or changes the assignment of a ProjectCode to this Project.

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

getCodeValueObjectId

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

Gets the unique ID of a ProjectCode that is assigned to this Project.

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

getCodeValue

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

Gets the name of a ProjectCode that is assigned to this Project.

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

getActivityCodeTypesAssigned

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

Gets the ObjectIds of all ActivityCodeTypes for which ActivityCodes are assigned to Activities in this Project.

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

getProjectCodeTypesAssigned

@Deprecated
public ObjectId[] getProjectCodeTypesAssigned()
                                       throws BusinessObjectException
Deprecated. As of release 5.0 SP3, determine the project code assignments using the ProjectCodeAssignment object.

Gets the ObjectIds of all ProjectCodeTypes for which ProjectCodes are assigned to this Project.

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

calculateProjectScore

public int calculateProjectScore(ObjectId[] aProjCodeTypeIds)
                          throws ServerException,
                                 NetworkException,
                                 BusinessObjectException
Calculate the project score of this project based on a selected set of ProjectCodeType's.

Overrides:
calculateProjectScore in class com.primavera.integration.client.bo.base.ProjectBase
Parameters:
aProjCodeTypeIds - array of ObjectId's of selected ProjectCodeType's
Returns:
project score
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 Project.

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

getActivityUDFTypesAssigned

@Deprecated
public ObjectId[] getActivityUDFTypesAssigned()
                                       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 Activities of this project.

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

convertToBaseline

public ObjectId convertToBaseline(ObjectId projectId)
                           throws ServerException,
                                  NetworkException,
                                  BusinessObjectException
Converts this project to a baseline of the project provided. The current Project object will become invalid, since it will no longer be a Project, but a BaselineProject.

Overrides:
convertToBaseline in class com.primavera.integration.client.bo.base.ProjectBase
Parameters:
projectId - unique ID of a Project which this project will become a baseline of
Returns:
ObjectId unique identifier for the BaselineProject (which is the same as this object's current ID)
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

assignProjectAsBaseline

public ObjectId assignProjectAsBaseline(ObjectId projectId)
                                 throws ServerException,
                                        NetworkException,
                                        BusinessObjectException
Converts the provided project to be a baseline of this project. The project provided as a parameter will become a BaselineProject.

Overrides:
assignProjectAsBaseline in class com.primavera.integration.client.bo.base.ProjectBase
Parameters:
projectId - unique ID of a Project which will become a baseline of this project
Returns:
ObjectId unique identifier for the BaselineProject (which is the same as the ID as passed to the method)
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

createCopy

public ObjectId createCopy(ObjectId epsId,
                           CopyProjectOptions projOpts,
                           CopyWBSOptions wbsOpts,
                           CopyActivityOptions actOpts)
                    throws ServerException,
                           NetworkException,
                           BusinessObjectException
Creates a copy of the project. Note: The execution time of this project depends on the number of associated objects of this project. The more business objects that are associated to this Project (e.g Activities), the longer the copy will take.

Overrides:
createCopy in class com.primavera.integration.client.bo.base.ProjectBase
Parameters:
epsId - the EPS Id to use as the EPS of the new project. If null, the EPS of the current project is used
projOpts - the copy project options. If null, the default options will be used
wbsOpts - the copy WBS options. If null, the default options will be used
actOpts - the copy activity options. If null, the default options will be used
Returns:
ObjectId unique identifier for the new Project that was created
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

createCopyAsBaseline

public ObjectId createCopyAsBaseline()
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Copies a copy of the current project and makes the copy a baseline of the current project. The ParentEPSObjectId is required as a loaded field for this process to be successful. This method invokes the copy() method on Project, which can take a long time to process if the Project is very large.

Overrides:
createCopyAsBaseline in class com.primavera.integration.client.bo.base.ProjectBase
Returns:
ObjectId unique identifier for the new BaselineProject that was created
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

createCopyAsReflection

public ObjectId createCopyAsReflection()
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Copies a copy of the current project and makes the copy a reflection of the current project. The ParentEPSObjectId is required as a loaded field for this process to be successful. This method invokes the copy() method on Project, which can take a long time to process if the Project is very large.

Overrides:
createCopyAsReflection in class com.primavera.integration.client.bo.base.ProjectBase
Returns:
ObjectId unique identifier for the new reflection Project that was created
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

getActivitiesWithCodeChanges

@Deprecated
public ObjectId[] getActivitiesWithCodeChanges(java.util.Date sinceDate)
                                        throws BusinessObjectException,
                                               ServerException,
                                               NetworkException
Deprecated. As of release 5.0 SP3, load the ActivityCodeAssignment objects to determine what changed. Use the timestamp fields in the where clause to see changes since a particular time.

Gets the activities that have had new or changed code assignments since a particular date. Deleted code assignments are not included.

Overrides:
getActivitiesWithCodeChanges in class com.primavera.integration.client.bo.base.ProjectBase
Parameters:
sinceDate - the date after which changes should be checked. If null, all activities with code assignments are returned.
Returns:
ObjectId[] the ObjectIds of activities with code changes
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer

getActivitiesWithUDFChanges

@Deprecated
public ObjectId[] getActivitiesWithUDFChanges(java.util.Date sinceDate)
                                       throws BusinessObjectException,
                                              ServerException,
                                              NetworkException
Deprecated. As of release 5.0 SP3, load the UDFValue objects to determine what changed. Use the timestamp fields in the where clause to see changes since a particular time.

Gets the activities that have had new or changed UDF assignments since a particular date. Deleted UDF assignments are not included.

Overrides:
getActivitiesWithUDFChanges in class com.primavera.integration.client.bo.base.ProjectBase
Parameters:
sinceDate - the date after which changes should be checked. If null, all activities with UDF assignments are returned.
Returns:
ObjectId[] the ObjectIds of activities with UDF changes
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer

lockProject

public boolean lockProject()
                    throws BusinessObjectException,
                           ServerException,
                           NetworkException
Locks the project in exclusive mode.

Overrides:
lockProject in class com.primavera.integration.client.bo.base.ProjectBase
Returns:
boolean true if successful, otherwise false.
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer

unlockProject

public boolean unlockProject()
                      throws BusinessObjectException,
                             ServerException,
                             NetworkException
Unlocks this project if it was previously exclusively locked by the current user.

Overrides:
unlockProject in class com.primavera.integration.client.bo.base.ProjectBase
Returns:
boolean true if successful, otherwise false.
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer

copyBaseline

public ObjectId copyBaseline(ObjectId baselineProjId)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Creates a copy of the specified baseline project.

Overrides:
copyBaseline in class com.primavera.integration.client.bo.base.ProjectBase
Parameters:
baselineProjId - the unique ID of the baseline project to copy..
Returns:
ObjectId unique identifier of baseline project that was created.
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

getObjectId

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

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

setObjectId

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

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

getWBSObjectId

public ObjectId getWBSObjectId()
                        throws BusinessObjectException
Gets the internal WBS ID of the project. This ID cannot be used to load a WBS object directly. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getParentEPSObjectId

public ObjectId getParentEPSObjectId()
                              throws BusinessObjectException
Gets the unique ID of the parent EPS of this project. 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 ParentEPSObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setParentEPSObjectId

public void setParentEPSObjectId(ObjectId o)
                          throws BusinessObjectException
Sets the unique ID of the parent EPS of this project. 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

getOwnerResourceObjectId

public ObjectId getOwnerResourceObjectId()
                                  throws BusinessObjectException
Gets the unique ID of the Owner Resource of this project.

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

setOwnerResourceObjectId

public void setOwnerResourceObjectId(ObjectId o)
                              throws BusinessObjectException
Sets the unique ID of the Owner Resource of this project.

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

getLinkPlannedAndAtCompletionFlag

public boolean getLinkPlannedAndAtCompletionFlag()
                                          throws BusinessObjectException
Gets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities. Default = 'true'.

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

setLinkPlannedAndAtCompletionFlag

public void setLinkPlannedAndAtCompletionFlag(boolean b)
                                       throws BusinessObjectException
Sets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities. Default = 'true'.

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

getResetPlannedToRemainingFlag

public boolean getResetPlannedToRemainingFlag()
                                       throws BusinessObjectException
Gets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started. Default = 'true'.

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

setResetPlannedToRemainingFlag

public void setResetPlannedToRemainingFlag(boolean b)
                                    throws BusinessObjectException
Sets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started. Default = 'true'.

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

getAssignmentDefaultDrivingFlag

public boolean getAssignmentDefaultDrivingFlag()
                                        throws BusinessObjectException
Gets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.

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

setAssignmentDefaultDrivingFlag

public void setAssignmentDefaultDrivingFlag(boolean b)
                                     throws BusinessObjectException
Sets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.

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

getCurrentBaselineProjectObjectId

public ObjectId getCurrentBaselineProjectObjectId()
                                           throws BusinessObjectException
Gets the unique ID of the project's baseline to use for computing summaries. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setCurrentBaselineProjectObjectId

public void setCurrentBaselineProjectObjectId(ObjectId o)
                                       throws BusinessObjectException
Sets the unique ID of the project's baseline to use for computing summaries. 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

getSourceProjectObjectId

public ObjectId getSourceProjectObjectId()
                                  throws BusinessObjectException
Gets the unique ID of the project from which the reflection project was created, if the current project is a reflection project.

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

getActivityDefaultCalendarObjectId

public ObjectId getActivityDefaultCalendarObjectId()
                                            throws BusinessObjectException
Gets the unique ID of the calendar assigned to new activities by default. Can be null for baselines. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setActivityDefaultCalendarObjectId

public void setActivityDefaultCalendarObjectId(ObjectId o)
                                        throws BusinessObjectException
Sets the unique ID of the calendar assigned to new activities by default. Can be null for baselines. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getActivityDefaultCostAccountObjectId

public ObjectId getActivityDefaultCostAccountObjectId()
                                               throws BusinessObjectException
Gets the unique ID of the cost account assigned to new activities and project expenses by default.

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

setActivityDefaultCostAccountObjectId

public void setActivityDefaultCostAccountObjectId(ObjectId o)
                                           throws BusinessObjectException
Sets the unique ID of the cost account assigned to new activities and project expenses by default.

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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the Project 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 Project element.

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

getId

public java.lang.String getId()
                       throws BusinessObjectException
Gets the short code assigned to each Project element for identification. Each Project element is uniquely identified by this short code.

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

setId

public void setId(java.lang.String s)
           throws BusinessObjectException
Sets the short code assigned to each Project element for identification. Each Project element is uniquely identified by this short code.

Parameters:
s - the value to set this field to
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 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 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 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

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

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 Project 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 Project 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 Project has been summarized.

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

getContainsSummaryDataOnly

public boolean getContainsSummaryDataOnly()
                                   throws BusinessObjectException
Gets the flag that indicates that the project does not contain detail data and cannot be opened. Projects that have been consolidated from another location have this set to Y.

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

setContainsSummaryDataOnly

public void setContainsSummaryDataOnly(boolean b)
                                throws BusinessObjectException
Sets the flag that indicates that the project does not contain detail data and cannot be opened. Projects that have been consolidated from another location have this set to Y.

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

getStatus

public ProjectStatus getStatus()
                        throws BusinessObjectException
Gets the project status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.

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

setStatus

public void setStatus(ProjectStatus enm)
               throws BusinessObjectException
Sets the project status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'.

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

getDefaultPriceTimeUnits

public UnitType getDefaultPriceTimeUnits()
                                  throws BusinessObjectException
Gets the time units associated with the project's default price per time. Valid values are 'Hour', 'Day', 'Week', 'Month', and 'Year'.

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

setDefaultPriceTimeUnits

public void setDefaultPriceTimeUnits(UnitType enm)
                              throws BusinessObjectException
Sets the time units associated with the project's default price per time. Valid values are 'Hour', 'Day', 'Week', 'Month', and 'Year'.

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

getCurrentBudget

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

getDistributedCurrentBudget

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

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

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

getStartDate

public BeginDate getStartDate()
                       throws BusinessObjectException
Gets the start date of the project. This is a summary method calculated from fields populated by the Summarizer job service. This 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 project. This is a summary method calculated from fields populated by the Summarizer job service. This 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

getOverallProjectScore

public int getOverallProjectScore()
                           throws BusinessObjectException
Gets the project score calculated based on all project code types assigned to this project. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getProjectSpread

public ProjectSpread getProjectSpread()
                               throws BusinessObjectException
Gets the field containing spread data for this project. If a project is attempted to be loaded with spread data, getProjectSpread will return null if no spread data was available for that project. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getProjectResourceSpreads

public ProjectResourceSpread[] getProjectResourceSpreads()
                                                  throws BusinessObjectException
Gets the field containing resource spread data for this project. If a project is attempted to be loaded with resource spread data, getProjectResourceSpread will return null if no spread data was available for that project. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getProjectRoleSpreads

public ProjectRoleSpread[] getProjectRoleSpreads()
                                          throws BusinessObjectException
Gets the field containing role spread data for this project. If a project is attempted to be loaded with role spread data, getProjectRoleSpread will return null if no spread data was available for that project. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getAnticipatedFinishDate

public EndDate getAnticipatedFinishDate()
                                 throws BusinessObjectException
Gets the anticipated finish date of Project element. 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 Project element. 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 Project element. 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 Project element. 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 Project. 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 Project. 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 Project. 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 Project. 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 - earned value).

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 - earned value).

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

getDataDate

public java.util.Date getDataDate()
                           throws BusinessObjectException
Gets the current data date for the project. The project status is up to date as of the data date. The data date is modified when project actuals are applied. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setDataDate

public void setDataDate(java.util.Date d)
                 throws BusinessObjectException
Sets the current data date for the project. The project status is up to date as of the data date. The data date is modified when project actuals are applied. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getPlannedStartDate

public BeginDate getPlannedStartDate()
                              throws BusinessObjectException
Gets the planned start date of the project. Used by the project scheduler.

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

setPlannedStartDate

public void setPlannedStartDate(BeginDate d)
                         throws BusinessObjectException
Sets the planned start date of the project. Used by the project scheduler.

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

getMustFinishByDate

public EndDate getMustFinishByDate()
                            throws BusinessObjectException
Gets the date by which all project activities must finish. If entered, it is used as the project late finish date by the project scheduler.

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

setMustFinishByDate

public void setMustFinishByDate(EndDate d)
                         throws BusinessObjectException
Sets the date by which all project activities must finish. If entered, it is used as the project late finish date by the project scheduler.

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

getProjectForecastStartDate

public BeginDate getProjectForecastStartDate()
                                      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 around while manually leveling the resource profile in a resource analysis layout.

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

setProjectForecastStartDate

public void setProjectForecastStartDate(BeginDate d)
                                 throws BusinessObjectException
Sets the alternate start date to be optionally used by the scheduler. The user sets the alternate start date by dragging the project bar in the Gantt Chart around while manually leveling the resource profile in a resource analysis layout.

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

getScheduledFinishDate

public EndDate getScheduledFinishDate()
                               throws BusinessObjectException
Gets the early finish date of the latest activity in the project, as computed by the project scheduler.

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

setScheduledFinishDate

public void setScheduledFinishDate(EndDate d)
                            throws BusinessObjectException
Sets the early finish date of the latest activity in the project, as computed by the project scheduler.

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

getActivityIdBasedOnSelectedActivity

public boolean getActivityIdBasedOnSelectedActivity()
                                             throws BusinessObjectException
Gets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix. Default = 'false'.

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

setActivityIdBasedOnSelectedActivity

public void setActivityIdBasedOnSelectedActivity(boolean b)
                                          throws BusinessObjectException
Sets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix. Default = 'false'.

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

getAddedBy

public java.lang.String getAddedBy()
                            throws BusinessObjectException
Gets the name of the user who added the project to the database.

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

setAddedBy

public void setAddedBy(java.lang.String s)
                throws BusinessObjectException
Sets the name of the user who added the project to the database.

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

getDateAdded

public java.util.Date getDateAdded()
                            throws BusinessObjectException
Gets the date on which the project was added to the Project Management database.

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

setDateAdded

public void setDateAdded(java.util.Date d)
                  throws BusinessObjectException
Sets the date on which the project was added to the Project Management database.

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

getCostQuantityRecalculateFlag

public boolean getCostQuantityRecalculateFlag()
                                       throws BusinessObjectException
Gets the flag that, when costs and quantities are linked, indicates whether the quantities should be updated when costs are updated,.

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

setCostQuantityRecalculateFlag

public void setCostQuantityRecalculateFlag(boolean b)
                                    throws BusinessObjectException
Sets the flag that, when costs and quantities are linked, indicates whether the quantities should be updated when costs are updated,.

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

getLinkPercentCompleteWithActual

public boolean getLinkPercentCompleteWithActual()
                                         throws BusinessObjectException
Gets the flag that indicates whether actual units and cost should be recalculated when percent complete changes. Default = 'false'.

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

setLinkPercentCompleteWithActual

public void setLinkPercentCompleteWithActual(boolean b)
                                      throws BusinessObjectException
Sets the flag that indicates whether actual units and cost should be recalculated when percent complete changes. Default = 'false'.

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

getLevelingPriority

public int getLevelingPriority()
                        throws BusinessObjectException
Gets the priority for scheduling.

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

setLevelingPriority

public void setLevelingPriority(int i)
                         throws BusinessObjectException
Sets the priority for scheduling.

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

getWebSiteURL

public java.lang.String getWebSiteURL()
                               throws BusinessObjectException
Gets the project Web site URL, which is the Web address of the project's website.

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

setWebSiteURL

public void setWebSiteURL(java.lang.String s)
                   throws BusinessObjectException
Sets the project Web site URL, which is the Web address of the project's website.

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

getAssignmentDefaultRateType

public DefaultRateType getAssignmentDefaultRateType()
                                             throws BusinessObjectException
Gets the default rate type when adding resource assignments to a project. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', and 'Price / Unit5'.

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

setAssignmentDefaultRateType

public void setAssignmentDefaultRateType(DefaultRateType enm)
                                  throws BusinessObjectException
Sets the default rate type when adding resource assignments to a project. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', and 'Price / Unit5'.

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

getRiskLevel

public ProjectRiskLevel getRiskLevel()
                              throws BusinessObjectException
Gets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setRiskLevel

public void setRiskLevel(ProjectRiskLevel enm)
                  throws BusinessObjectException
Sets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getStrategicPriority

public int getStrategicPriority()
                         throws BusinessObjectException
Gets the project's priority. The range is from 1 to 10,000.

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

setStrategicPriority

public void setStrategicPriority(int i)
                          throws BusinessObjectException
Sets the project's priority. The range is from 1 to 10,000.

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

getWebSiteRootDirectory

public java.lang.String getWebSiteRootDirectory()
                                         throws BusinessObjectException
Gets the root directory for storing project Web site files before they are published to the Web server.

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

setWebSiteRootDirectory

public void setWebSiteRootDirectory(java.lang.String s)
                             throws BusinessObjectException
Sets the root directory for storing project Web site files before they are published to the Web server.

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

getLastSummarizedDate

public java.util.Date getLastSummarizedDate()
                                     throws BusinessObjectException
Gets the date the project was last summarized.

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

getSummarizedDataDate

public java.util.Date getSummarizedDataDate()
                                     throws BusinessObjectException
Gets the data date of the project when it was last summarized-only updated by summarizer.

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

setSummarizedDataDate

public void setSummarizedDataDate(java.util.Date d)
                           throws BusinessObjectException
Sets the data date of the project when it was last summarized-only updated by summarizer.

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

getEnableSummarization

public boolean getEnableSummarization()
                               throws BusinessObjectException
Gets the option which, when true, directs the Summarizer service to automatically summarize the project. If this is false, the project will be skipped during the summary run.

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

setEnableSummarization

public void setEnableSummarization(boolean b)
                            throws BusinessObjectException
Sets the option which, when true, directs the Summarizer service to automatically summarize the project. If this is false, the project will be skipped during the summary run.

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

getCheckOutStatus

public boolean getCheckOutStatus()
                          throws BusinessObjectException
Gets the flag that indicates that the project is currently checked out to an external file or database and is being managed remotely.

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

setCheckOutStatus

public void setCheckOutStatus(boolean b)
                       throws BusinessObjectException
Sets the flag that indicates that the project is currently checked out to an external file or database and is being managed remotely.

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

getActivityDefaultDurationType

public DurationType getActivityDefaultDurationType()
                                            throws BusinessObjectException
Gets the duration type assigned to new activities by default. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'.

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

setActivityDefaultDurationType

public void setActivityDefaultDurationType(DurationType enm)
                                    throws BusinessObjectException
Sets the duration type assigned to new activities by default. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'.

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

getActivityDefaultPercentCompleteType

public PercentCompleteType getActivityDefaultPercentCompleteType()
                                                          throws BusinessObjectException
Gets the percent complete type assigned to new activities by default. Valid values are 'Physical', 'Duration', and 'Units'.

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

setActivityDefaultPercentCompleteType

public void setActivityDefaultPercentCompleteType(PercentCompleteType enm)
                                           throws BusinessObjectException
Sets the percent complete type assigned to new activities by default. Valid values are 'Physical', 'Duration', and 'Units'.

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

getActivityDefaultActivityType

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

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

setActivityDefaultActivityType

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

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

getActivityIdPrefix

public java.lang.String getActivityIdPrefix()
                                     throws BusinessObjectException
Gets the prefix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.

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

setActivityIdPrefix

public void setActivityIdPrefix(java.lang.String s)
                         throws BusinessObjectException
Sets the prefix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.

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

getActivityIdSuffix

public int getActivityIdSuffix()
                        throws BusinessObjectException
Gets the suffix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.

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

setActivityIdSuffix

public void setActivityIdSuffix(int i)
                         throws BusinessObjectException
Sets the suffix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.

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

getActivityIdIncrement

public int getActivityIdIncrement()
                           throws BusinessObjectException
Gets the increment used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.

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

setActivityIdIncrement

public void setActivityIdIncrement(int i)
                            throws BusinessObjectException
Sets the increment used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.

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

getResourceCanBeAssignedToSameActivityMoreThanOnce

public boolean getResourceCanBeAssignedToSameActivityMoreThanOnce()
                                                           throws BusinessObjectException
Gets the flag that indicates whether a resource can be assigned more than once to the same activity. This is useful when the resource is expected to perform more than one role on an activity, for example, documentation plus QA.

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

setResourceCanBeAssignedToSameActivityMoreThanOnce

public void setResourceCanBeAssignedToSameActivityMoreThanOnce(boolean b)
                                                        throws BusinessObjectException
Sets the flag that indicates whether a resource can be assigned more than once to the same activity. This is useful when the resource is expected to perform more than one role on an activity, for example, documentation plus QA.

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

getPrimaryResourcesCanMarkActivitiesAsCompleted

public boolean getPrimaryResourcesCanMarkActivitiesAsCompleted()
                                                        throws BusinessObjectException
Gets the flag that indicates whether primary resources can mark the project activities as completed. If not selected, a primary resource can only mark an activity as For Review. In this case the project manager reviews the activity and marks it as either Rejected or completed.

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

setPrimaryResourcesCanMarkActivitiesAsCompleted

public void setPrimaryResourcesCanMarkActivitiesAsCompleted(boolean b)
                                                     throws BusinessObjectException
Sets the flag that indicates whether primary resources can mark the project activities as completed. If not selected, a primary resource can only mark an activity as For Review. In this case the project manager reviews the activity and marks it as either Rejected or completed.

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

getResourcesCanAssignThemselvesToActivities

public boolean getResourcesCanAssignThemselvesToActivities()
                                                    throws BusinessObjectException
Gets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.

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

setResourcesCanAssignThemselvesToActivities

public void setResourcesCanAssignThemselvesToActivities(boolean b)
                                                 throws BusinessObjectException
Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.

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

getResourcesCanEditAssignmentPercentComplete

public boolean getResourcesCanEditAssignmentPercentComplete()
                                                     throws BusinessObjectException
Gets the flag that indicates whether the project's resource update the remaining units or the percent complete for their activities in the timesheet application.

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

setResourcesCanEditAssignmentPercentComplete

public void setResourcesCanEditAssignmentPercentComplete(boolean b)
                                                  throws BusinessObjectException
Sets the flag that indicates whether the project's resource update the remaining units or the percent complete for their activities in the timesheet application.

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

getResourcesCanMarkAssignmentAsCompleted

public boolean getResourcesCanMarkAssignmentAsCompleted()
                                                 throws BusinessObjectException
Gets the flag that indicates whether timesheet resources can mark the assignment as complete.

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

setResourcesCanMarkAssignmentAsCompleted

public void setResourcesCanMarkAssignmentAsCompleted(boolean b)
                                              throws BusinessObjectException
Sets the flag that indicates whether timesheet resources can mark the assignment as complete.

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

getResourcesCanViewInactiveActivities

public boolean getResourcesCanViewInactiveActivities()
                                              throws BusinessObjectException
Gets the flag that indicates whether timesheet resources can view inactive project activities.

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

setResourcesCanViewInactiveActivities

public void setResourcesCanViewInactiveActivities(boolean b)
                                           throws BusinessObjectException
Sets the flag that indicates whether timesheet resources can view inactive project activities.

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

getAnnualDiscountRate

public double getAnnualDiscountRate()
                             throws BusinessObjectException
Gets the user-defined number field that identifies the discount rate for the project.

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

setAnnualDiscountRate

public void setAnnualDiscountRate(double d)
                           throws BusinessObjectException
Sets the user-defined number field that identifies the discount rate for the project.

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

getDiscountApplicationPeriod

public DiscountApplicationPeriod getDiscountApplicationPeriod()
                                                       throws BusinessObjectException
Gets the timescale for entering ROI spending and benefit plan. Valid values are 'Month', 'Quarter', or 'Year'.

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

setDiscountApplicationPeriod

public void setDiscountApplicationPeriod(DiscountApplicationPeriod enm)
                                  throws BusinessObjectException
Sets the timescale for entering ROI spending and benefit plan. Valid values are 'Month', 'Quarter', or 'Year'.

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

getSummarizeToWBSLevel

public int getSummarizeToWBSLevel()
                           throws BusinessObjectException
Gets the maximum level within the project's WBS to perform summarization - default to 2.

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

setSummarizeToWBSLevel

public void setSummarizeToWBSLevel(int i)
                            throws BusinessObjectException
Sets the maximum level within the project's WBS to perform summarization - default to 2.

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

getSummaryLevel

public SummaryLevel getSummaryLevel()
                             throws BusinessObjectException
Gets the summary level for the project while performing project summarization.

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

setSummaryLevel

public void setSummaryLevel(SummaryLevel enm)
                     throws BusinessObjectException
Sets the summary level for the project while performing project summarization.

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

getWBSCodeSeparator

public java.lang.String getWBSCodeSeparator()
                                     throws BusinessObjectException
Gets the character used to separate the concatenated code fields for the project's WBS tree.

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

setWBSCodeSeparator

public void setWBSCodeSeparator(java.lang.String s)
                         throws BusinessObjectException
Sets the character used to separate the concatenated code fields for the project's WBS tree.

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

getFiscalYearStartMonth

public int getFiscalYearStartMonth()
                            throws BusinessObjectException
Gets the month that marks the beginning of the fiscal year for the project.

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

setFiscalYearStartMonth

public void setFiscalYearStartMonth(int i)
                             throws BusinessObjectException
Sets the month that marks the beginning of the fiscal year for the project.

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

getCriticalActivityFloatLimit

public Duration getCriticalActivityFloatLimit()
                                       throws BusinessObjectException
Gets the duration used to determine if an activity is critical. When an activity has total float that is less than or equal to this duration, the activity is marked as critical.

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

setCriticalActivityFloatLimit

public void setCriticalActivityFloatLimit(Duration d)
                                   throws BusinessObjectException
Sets the duration used to determine if an activity is critical. When an activity has total float that is less than or equal to this duration, the activity is marked as critical.

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

getCriticalActivityPathType

public CriticalActivityPathType getCriticalActivityPathType()
                                                     throws BusinessObjectException
Gets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.

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

setCriticalActivityPathType

public void setCriticalActivityPathType(CriticalActivityPathType enm)
                                 throws BusinessObjectException
Sets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.

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

getActivityPercentCompleteBasedOnActivitySteps

public boolean getActivityPercentCompleteBasedOnActivitySteps()
                                                       throws BusinessObjectException
Gets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.

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

setActivityPercentCompleteBasedOnActivitySteps

public void setActivityPercentCompleteBasedOnActivitySteps(boolean b)
                                                    throws BusinessObjectException
Sets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.

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

getActivityDefaultPricePerUnit

public Cost getActivityDefaultPricePerUnit()
                                    throws BusinessObjectException
Gets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments. This price is also used to compute costs for activities in cases where resources are assigned but the resources have no prices. Resource cost is computed as the resource units multiplied by the price per time.

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

setActivityDefaultPricePerUnit

public void setActivityDefaultPricePerUnit(Cost c)
                                    throws BusinessObjectException
Sets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments. This price is also used to compute costs for activities in cases where resources are assigned but the resources have no prices. Resource cost is computed as the resource units multiplied by the price per time.

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

getAddActualToRemaining

public boolean getAddActualToRemaining()
                                throws BusinessObjectException
Gets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated. Default = 'true'.

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

setAddActualToRemaining

public void setAddActualToRemaining(boolean b)
                             throws BusinessObjectException
Sets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated. Default = 'true'.

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

getLinkActualToActualThisPeriod

public boolean getLinkActualToActualThisPeriod()
                                        throws BusinessObjectException
Gets the flag that indicates whether actual units and costs are linked to actual-this-period units and costs. Setting this field to true asynchronously causes all actual-this-period values to be recalculated for the project via a job service. Default = 'true'.

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

setLinkActualToActualThisPeriod

public void setLinkActualToActualThisPeriod(boolean b)
                                     throws BusinessObjectException
Sets the flag that indicates whether actual units and costs are linked to actual-this-period units and costs. Setting this field to true asynchronously causes all actual-this-period values to be recalculated for the project via a job service. Default = 'true'.

Parameters:
b - 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 difference between the current budget and the total spending plan. Calculated as current budget - total spending plan. Not rolled up. This 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 total current budget minus the distributed current budget. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getProposedBudget

public Cost getProposedBudget()
                       throws BusinessObjectException
Gets the Proposed Budget, which is 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

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 project. This field may not be included in the where clause or order by clause specified when loading business objects.

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

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 Project. 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 Project for the current baseline. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 project for the current baseline. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryRemainingDuration

public Duration getSummaryRemainingDuration()
                                     throws BusinessObjectException
Gets the total working time from the Project 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 / baseline planned duration * 100. The value can exceed 100. The baseline planned duration is the activity's at complete duration from the primary baseline. This field may not be included in the where clause or order by clause specified when loading business objects.

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

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 Project.). This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 project. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryRemainingStartDate

public BeginDate getSummaryRemainingStartDate()
                                       throws BusinessObjectException
Gets the earliest remaining start of all activities assigned to the Project. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 around 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 Project. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 Project. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 project. This field may not be included in the where clause or order by clause specified when loading business objects.

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

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 Project. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 Project. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 Project. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 Project. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 Project. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 duration at completion. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryDurationVariance

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

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

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 Project. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 in-progress activities in the baseline. This field may not be included in the where clause or order by clause specified when loading business objects.

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

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 Project 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 Project 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 Project 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

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

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

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

getSummaryNonLaborUnitsPercentComplete

public Percent getSummaryNonLaborUnitsPercentComplete()
                                               throws BusinessObjectException
Gets the percent complete of units for all nonlabor resources for the Project. Computed as Actual Nonlabor Cost / At Completion Nonlabor Cost * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getMSProjectManagedFlag

public boolean getMSProjectManagedFlag()
                                throws BusinessObjectException
Gets the flag indicating whether this is a Microsoft Project-managed project.

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

getCheckOutDate

public java.util.Date getCheckOutDate()
                               throws BusinessObjectException
Gets the date on which the project was checked out of the Project Management database.

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

getCheckOutUserObjectId

public ObjectId getCheckOutUserObjectId()
                                 throws BusinessObjectException
Gets the unique ID of the User that checked out this project.

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

getLastFinancialPeriodObjectId

public ObjectId getLastFinancialPeriodObjectId()
                                        throws BusinessObjectException
Gets the unique ID of the last closed financial period for the project.

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

setLastFinancialPeriodObjectId

public void setLastFinancialPeriodObjectId(ObjectId o)
                                    throws BusinessObjectException
Sets the unique ID of the last closed financial period for the project.

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

getCreateDate

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

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

getLastUpdateDate

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

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

getCreateUser

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

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

getLastUpdateUser

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

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

getUseProjectBaselineForEarnedValue

public boolean getUseProjectBaselineForEarnedValue()
                                            throws BusinessObjectException
Gets the flag that indicates whether earned value should be calculated based on the project baseline or the user's primary baseline. This setting only affects Project Management, not the Integration API or Primavera's Web application.

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

setUseProjectBaselineForEarnedValue

public void setUseProjectBaselineForEarnedValue(boolean b)
                                         throws BusinessObjectException
Sets the flag that indicates whether earned value should be calculated based on the project baseline or the user's primary baseline. This setting only affects Project Management, not the Integration API or Primavera's Web application.

Parameters:
b - the value to set this field to
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 project. It is computed as Actual Material Cost / At Complete Material Cost * 100, and it is always in the range of 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryNonLaborCostPercentComplete

public Percent getSummaryNonLaborCostPercentComplete()
                                              throws BusinessObjectException
Gets the percent complete of cost for all non-labor resources assigned to the project. It is computed as Actual Nonlabor Cost / At Complete Nonlabor Cost * 100, and it is always in the range of 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryDurationPercentOfPlanned

public Percent getSummaryDurationPercentOfPlanned()
                                           throws BusinessObjectException
Gets the summary actual duration percent of planned of all activities under this project. Computed as actual duration / baseline duration * 100. The value can exceed 100. The Baseline duration is the activity's at complete duration from the current baseline. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryExpenseCostPercentComplete

public Percent getSummaryExpenseCostPercentComplete()
                                             throws BusinessObjectException
Gets the percent complete of cost for all expenses associated with the project. It is computed as Actual Expense Cost / At Complete Expense Cost * 100, and it is always in the range of 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryLaborCostPercentComplete

public Percent getSummaryLaborCostPercentComplete()
                                           throws BusinessObjectException
Gets the percent complete of cost for all labor resources assigned to the project. It is computed as Actual Labor Cost / At Complete Labor Cost * 100, and it is always in the range of 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getAllowNegativeActualUnitsFlag

public boolean getAllowNegativeActualUnitsFlag()
                                        throws BusinessObjectException
Gets the flag that indicates whether the project can allow the negative valus for the actual units.

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

setAllowNegativeActualUnitsFlag

public void setAllowNegativeActualUnitsFlag(boolean b)
                                     throws BusinessObjectException
Sets the flag that indicates whether the project can allow the negative valus for the actual units.

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

getLastApplyActualsDate

public java.util.Date getLastApplyActualsDate()
                                       throws BusinessObjectException
Gets the last date Apply Actuals was run for this project.

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

getSummaryCostPercentComplete

public Percent getSummaryCostPercentComplete()
                                      throws BusinessObjectException
Gets the percent complete of cost for all nonlabor resources assigned. Computed as Actual Nonlabor Cost / At Completion Nonlabor Cost * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getSummaryCostVarianceIndex

public double getSummaryCostVarianceIndex()
                                   throws BusinessObjectException
Gets the value that is calculated as the Cost Variance divided by Earned Value. This field may not be included in the where clause or order by clause specified when loading business objects.

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

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

getTotalFunding

public Cost getTotalFunding()
                     throws BusinessObjectException
Gets the total amount of funding contributed to the project by your funding sources. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field TotalFunding
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 Project. 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

getHasFutureBucketData

public boolean getHasFutureBucketData()
                               throws BusinessObjectException
Gets the flag that indicates whether a resource assignment in the project has future bucket data. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getIntegratedType

public IntegratedProjectType getIntegratedType()
                                        throws BusinessObjectException
Gets the flag indicating whether the project is integrated with an Enterprise Resource Planning (ERP) system. 'Fusion' indicates the project is integrated with Oracle Fusion. 'ERP' indicates the project is integrated with another ERP system.

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

setIntegratedType

public void setIntegratedType(IntegratedProjectType enm)
                       throws BusinessObjectException
Sets the flag indicating whether the project is integrated with an Enterprise Resource Planning (ERP) system. 'Fusion' indicates the project is integrated with Oracle Fusion. 'ERP' indicates the project is integrated with another ERP system.

Parameters:
enm - the value to set this field to
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

loadCalculatedUDFValues

public BOIterator<UDFValue> loadCalculatedUDFValues(UDFType[] udfTypes)
                                             throws ServerException,
                                                    NetworkException,
                                                    BusinessObjectException
Loads multiple associated UDFValue objects

Parameters:
udfTypes - the udf types to load UDFValue objects for
Throws:
ServerException
NetworkException
BusinessObjectException

getRequiredCreateFields

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

Returns:
String[] an array of required create fields

getFilterableFields

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

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

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

Returns:
String[] an internal array

getAllFields

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

Returns:
String[] an array of all fields

getInternalAllFields

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

Returns:
String[] an internal array

getInternalAllFieldsSet

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

Returns:
String[] an internal array

getMainFields

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

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

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

getResourceSpreadFields

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

Returns:
String[] an array of all spread fields

getRoleSpreadFields

public static java.lang.String[] getRoleSpreadFields()
Gets all spread fields that can be specified in the spreadFields parameter of loadWithProjectRoleSpread 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.