Package com.primavera.integration.client.bo.object

Class ResourceAssignment

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ResourceAssignment
public class ResourceAssignment extends BusinessObject

Resource assignments track the work of resources or roles that are performing various activities. A resource may be assigned to the same activity more than once, but performing in different roles.

Resource assignments may be loaded with live spreads using the loadWithLiveSpreads() methods. It is not necessary to have run the Summarizer job service in order to use live resource assignment spreads. After loading, call getResourceAssignmentSpread() to access the spread data. Resource assignment spreads support future bucket planning in their calculations. To edit future bucket planning data, set values using the ResourceAssignmentSpread value object, then call ResourceAssignment.setResourceAssignmentSpread().

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

See Also:   Quick reference of ResourceAssignment fields

  • Constructor Details

    • ResourceAssignment

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

    • ResourceAssignment

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

    • ResourceAssignment

      public ResourceAssignment(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 Details

    • loadActivity

      public Activity loadActivity(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Activity object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Activity the Activity object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadProject

      public Project loadProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Project object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadResource

      public Resource loadResource(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Resource object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Resource the Resource 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

    • loadRole

      public Role loadRole(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Role object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Role the Role 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

    • loadCostAccount

      public CostAccount loadCostAccount(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated CostAccount object from the database.
      Parameters:
      fields - fields to load
      Returns:
      CostAccount the CostAccount 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

    • loadResourceAssignmentPeriodActuals

      public BOIterator<ResourceAssignmentPeriodActual> loadResourceAssignmentPeriodActuals(String[] fields, String sWhereClause, 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

    • loadResourceHours

      public BOIterator<ResourceHour> loadResourceHours(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ResourceHour objects from the database.
      Parameters:
      fields - fields to 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

    • loadResourceCurve

      public ResourceCurve loadResourceCurve(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated ResourceCurve object from the database.
      Parameters:
      fields - fields to load
      Returns:
      ResourceCurve the ResourceCurve 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

    • loadUDFValues

      public BOIterator<UDFValue> loadUDFValues(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated UDFValue objects from the database.
      Parameters:
      fields - fields to 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

    • loadResourceAssignmentCodeAssignments

      public BOIterator<ResourceAssignmentCodeAssignment> loadResourceAssignmentCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ResourceAssignmentCodeAssignment 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

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      the value in the field ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setObjectId

      public void setObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      setObjectId in class BusinessObject
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityObjectId

      public ObjectId getActivityObjectId() throws BusinessObjectException
      Gets the unique ID of the activity to which the resource is assigned. 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 ActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityObjectId

      public void setActivityObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the activity to which the resource is assigned. 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

    • getProjectObjectId

      public ObjectId getProjectObjectId() throws BusinessObjectException
      Gets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field ProjectObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectName

      public String getProjectName() throws BusinessObjectException
      Gets the name of the associated project.
      Returns:
      the value in the field ProjectName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceCurveObjectId

      public ObjectId getResourceCurveObjectId() throws BusinessObjectException
      Gets the unique ID of the resource curve. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field ResourceCurveObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResourceCurveObjectId

      public void setResourceCurveObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the resource curve. 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

    • getResourceCurveName

      public String getResourceCurveName() throws BusinessObjectException
      Gets the name of the resource curve that determines how resources and costs are distributed over time for this activity.
      Returns:
      the value in the field ResourceCurveName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectId

      public String getProjectId() throws BusinessObjectException
      Gets the short code that uniquely identifies the project.
      Returns:
      the value in the field ProjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceObjectId

      public ObjectId getResourceObjectId() throws BusinessObjectException
      Gets the unique ID of the associated resource. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field ResourceObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResourceObjectId

      public void setResourceObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated resource. 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

    • getIsActive

      public boolean getIsActive() throws BusinessObjectException
      Gets the flag that indicates whether this resource assignment is active.
      Returns:
      the value in the field IsActive
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsPrimaryResource

      public boolean getIsPrimaryResource() throws BusinessObjectException
      Gets the flag that indicates whether this resource is the activity's primary resource. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field IsPrimaryResource
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIsPrimaryResource

      public void setIsPrimaryResource(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether this resource is the activity's primary resource. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPercentCompleteType

      public PercentCompleteType getPercentCompleteType() throws BusinessObjectException
      Gets the activity percent complete type: 'Physical', 'Duration', or 'Units'.
      Returns:
      the value in the field PercentCompleteType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPercentCompleteType

      public void setPercentCompleteType(PercentCompleteType enm) throws BusinessObjectException
      Sets the activity percent complete type: 'Physical', 'Duration', or 'Units'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDurationPercentComplete

      public Percent getDurationPercentComplete() throws BusinessObjectException
      Gets the percent complete of the activity duration. Computed as (planned duration - remaining duration) / planned duration * 100. Always in the range 0 to 100. The planned duration is taken from the current plan, not from the baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DurationPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDurationPercentComplete

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

    • getPercentComplete

      public Percent getPercentComplete() throws BusinessObjectException
      Gets the activity percent complete. This value is tied to the activity duration % complete, units % complete, or physical % complete, depending on the setting for the activity's percent complete type, which is one of Duration, Units, or Physical. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPercentComplete

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

    • getAssignmentPercentComplete

      public Percent getAssignmentPercentComplete() throws BusinessObjectException
      Gets the Assignment percent complete. This value is tied to the Assignment duration % complete, units % complete, or physical % complete, depending on the setting for the activity's percent complete type, which is one of Duration, Units, or Physical. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field AssignmentPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAssignmentPercentComplete

      public void setAssignmentPercentComplete(Percent p) throws BusinessObjectException
      Sets the Assignment percent complete. This value is tied to the Assignment duration % complete, units % complete, or physical % complete, depending on the setting for the activity's percent complete type, which is one of Duration, Units, or Physical. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      p - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCBSId

      public ObjectId getCBSId() throws BusinessObjectException
      Gets the unique Id of CBS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field CBSId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCBSId

      public void setCBSId(ObjectId o) throws BusinessObjectException
      Sets the unique Id of CBS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCalendarObjectId

      public ObjectId getCalendarObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system for the calendar associated with the resource assignment.
      Returns:
      the value in the field CalendarObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCalendarName

      public String getCalendarName() throws BusinessObjectException
      Gets the name of the 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 CalendarName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceCalendarName

      public String getResourceCalendarName() throws BusinessObjectException
      Gets the name of the calendar for the resource.
      Returns:
      the value in the field ResourceCalendarName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRoleObjectId

      public ObjectId getRoleObjectId() throws BusinessObjectException
      Gets the unique ID of the role the resource is performing on this activity. A resource may be assigned to the same activity more than once, performing different roles. The project manager controls whether the same resource can be assigned to an activity more than once. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field RoleObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRoleObjectId

      public void setRoleObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the role the resource is performing on this activity. A resource may be assigned to the same activity more than once, performing different roles. The project manager controls whether the same resource can be assigned to an activity more than once. 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

    • getRoleName

      public String getRoleName() throws BusinessObjectException
      Gets the name of the role. The role name uniquely identifies the role.
      Returns:
      the value in the field RoleName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRoleShortName

      public String getRoleShortName() throws BusinessObjectException
      Gets the shorthand name for the role.
      Returns:
      the value in the field RoleShortName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityId

      public String getActivityId() throws BusinessObjectException
      Gets the short ID that uniquely identifies the activity within the project.
      Returns:
      the value in the field ActivityId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceId

      public String getResourceId() throws BusinessObjectException
      Gets the short code that uniquely identifies the resource.
      Returns:
      the value in the field ResourceId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityName

      public String getActivityName() throws BusinessObjectException
      Gets the name of the activity. The activity name does not have to be unique.
      Returns:
      the value in the field ActivityName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAutoComputeActuals

      public boolean getAutoComputeActuals() throws BusinessObjectException
      Gets the option that determines whether the activity's actual and remaining units, start date, finish date, and percent complete are computed automatically using the planned dates, planned units and the schedule percent complete. If this option is selected, the actual/remaining units and actual dates are automatically updated when project actuals are applied. Use this option to assume that all work for the activity proceeds according to plan.
      Returns:
      the value in the field AutoComputeActuals
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getWBSNamePath

      public String getWBSNamePath() throws BusinessObjectException
      Gets the WBS name hierarchy of the Activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field WBSNamePath
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedStartDate

      public BeginDate getPlannedStartDate() throws BusinessObjectException
      Gets the date the resource is scheduled to begin working on the activity. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started. This is the start date that Timesheets users follow and schedule variance is measured against.
      Returns:
      the value in the field PlannedStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedStartDate

      public void setPlannedStartDate(BeginDate d) throws BusinessObjectException
      Sets the date the resource is scheduled to begin working on the activity. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started. This is the start date that Timesheets users follow and schedule variance is measured against.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedFinishDate

      public EndDate getPlannedFinishDate() throws BusinessObjectException
      Gets the date the resource is scheduled to finish working on the activity. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started. This is the finish date that Timesheets users follow and schedule variance is measured against.
      Returns:
      the value in the field PlannedFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedFinishDate

      public void setPlannedFinishDate(EndDate d) throws BusinessObjectException
      Sets the date the resource is scheduled to finish working on the activity. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started. This is the finish date that Timesheets users follow and schedule variance is measured against.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedUnits

      public Unit getPlannedUnits() throws BusinessObjectException
      Gets the planned units of work for the resource assignment on the activity. This field is named BudgetedUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
      Returns:
      the value in the field PlannedUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedUnits

      public void setPlannedUnits(Unit u) throws BusinessObjectException
      Sets the planned units of work for the resource assignment on the activity. This field is named BudgetedUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedUnitsPerTime

      public UnitsPerTime getPlannedUnitsPerTime() throws BusinessObjectException
      Gets the planned units per time at which the resource is to perform work on this activity. For example, a person assigned full time would perform 8 hours of work per day. A department of five people may perform at 5 days per day. This field is named BudgetedUnitsPerTime in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
      Returns:
      the value in the field PlannedUnitsPerTime
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedUnitsPerTime

      public void setPlannedUnitsPerTime(UnitsPerTime d) throws BusinessObjectException
      Sets the planned units per time at which the resource is to perform work on this activity. For example, a person assigned full time would perform 8 hours of work per day. A department of five people may perform at 5 days per day. This field is named BudgetedUnitsPerTime in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedDuration

      public Duration getPlannedDuration() throws BusinessObjectException
      Gets the planned working time for the resource assignment on the activity, from the resource's planned start date to the planned finish date. This field is named BudgetedDuration 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 PlannedDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedDuration

      public void setPlannedDuration(Duration d) throws BusinessObjectException
      Sets the planned working time for the resource assignment on the activity, from the resource's planned start date to the planned finish date. This field is named BudgetedDuration in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedLag

      public Duration getPlannedLag() throws BusinessObjectException
      Gets the planned time lag between the activity's planned start date and the resource's planned start date on the activity. If the resource is planned to start work when the activity is planned to start, the planned lag is zero. This field is named BudgetedLag in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
      Returns:
      the value in the field PlannedLag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedLag

      public void setPlannedLag(Duration d) throws BusinessObjectException
      Sets the planned time lag between the activity's planned start date and the resource's planned start date on the activity. If the resource is planned to start work when the activity is planned to start, the planned lag is zero. This field is named BudgetedLag in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPendingRemainingUnits

      public Unit getPendingRemainingUnits() throws BusinessObjectException
      Gets the estimate of the resource's remaining units on this activity. The pending remaining units is entered by each resource using Timesheets. This value is copied to the resource's remaining units for the activity when project actuals are applied. The project manager specifies whether resources update their percent complete or remaining units for each project.
      Returns:
      the value in the field PendingRemainingUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPendingRemainingUnits

      public void setPendingRemainingUnits(Unit u) throws BusinessObjectException
      Sets the estimate of the resource's remaining units on this activity. The pending remaining units is entered by each resource using Timesheets. This value is copied to the resource's remaining units for the activity when project actuals are applied. The project manager specifies whether resources update their percent complete or remaining units for each project.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedCost

      public Cost getPlannedCost() throws BusinessObjectException
      Gets the planned cost for the resource assignment on the activity. Computed as planned cost = planned units * price per time. This field is named BudgetedCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
      Returns:
      the value in the field PlannedCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedCost

      public void setPlannedCost(Cost c) throws BusinessObjectException
      Sets the planned cost for the resource assignment on the activity. Computed as planned cost = planned units * price per time. This field is named BudgetedCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualStartDate

      public BeginDate getActualStartDate() throws BusinessObjectException
      Gets the date the resource actually started working on the activity.
      Returns:
      the value in the field ActualStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualStartDate

      public void setActualStartDate(BeginDate d) throws BusinessObjectException
      Sets the date the resource actually started working on the activity.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStartDate

      public BeginDate getStartDate() throws BusinessObjectException
      Gets the start date of the resource assignment on the activity. Set to the remaining start date until the activity is started, then set to the actual start date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field StartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStartDate

      public void setStartDate(BeginDate d) throws BusinessObjectException
      Sets the start date of the resource assignment on the activity. Set to the remaining start date until the activity is started, then set to the actual start date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFinishDate

      public EndDate getFinishDate() throws BusinessObjectException
      Gets the finish date of the resource assignment on the activity. Set to the remaining finish date until the activity is completed, then set to the actual 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 FinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFinishDate

      public void setFinishDate(EndDate d) throws BusinessObjectException
      Sets the finish date of the resource assignment on the activity. Set to the remaining finish date until the activity is completed, then set to the actual finish date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualDuration

      public Duration getActualDuration() throws BusinessObjectException
      Gets the actual duration for the resource assignment on the activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field ActualDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAtCompletionDuration

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

    • getStaffedRemainingUnits

      public Unit getStaffedRemainingUnits() throws BusinessObjectException
      Gets the time distribution of the resource's remaining units for resource assignments that have filled a role. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field StaffedRemainingUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStaffedRemainingCost

      public Cost getStaffedRemainingCost() throws BusinessObjectException
      Gets the time distribution of the resource's remaining cost for resource assignments that have filled a role. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field StaffedRemainingCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUnstaffedRemainingUnits

      public Unit getUnstaffedRemainingUnits() throws BusinessObjectException
      Gets the time distribution of the resource's remaining units for resource assignments that have not filled a role. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field UnstaffedRemainingUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUnstaffedRemainingCost

      public Cost getUnstaffedRemainingCost() throws BusinessObjectException
      Gets the time distribution of the resource's remaining cost for resource assignments that have not filled a role. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field UnstaffedRemainingCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualFinishDate

      public EndDate getActualFinishDate() throws BusinessObjectException
      Gets the date the resource actually finished working on the activity.
      Returns:
      the value in the field ActualFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualFinishDate

      public void setActualFinishDate(EndDate d) throws BusinessObjectException
      Sets the date the resource actually finished working on the activity.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualRegularUnits

      public Unit getActualRegularUnits() throws BusinessObjectException
      Gets the actual non-overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager.
      Returns:
      the value in the field ActualRegularUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualRegularUnits

      public void setActualRegularUnits(Unit u) throws BusinessObjectException
      Sets the actual non-overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualOvertimeUnits

      public Unit getActualOvertimeUnits() throws BusinessObjectException
      Gets the actual overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager.
      Returns:
      the value in the field ActualOvertimeUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualOvertimeUnits

      public void setActualOvertimeUnits(Unit u) throws BusinessObjectException
      Sets the actual overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualUnits

      public Unit getActualUnits() throws BusinessObjectException
      Gets the actual non-overtime plus overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager. Computed as actual units = actual regular units + actual overtime units.
      Returns:
      the value in the field ActualUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualUnits

      public void setActualUnits(Unit u) throws BusinessObjectException
      Sets the actual non-overtime plus overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager. Computed as actual units = actual regular units + actual overtime units.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualRegularCost

      public Cost getActualRegularCost() throws BusinessObjectException
      Gets the actual non-overtime cost for the resource assignment on the activity. Computed as actual regular cost = actual regular units * cost per time.
      Returns:
      the value in the field ActualRegularCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualRegularCost

      public void setActualRegularCost(Cost c) throws BusinessObjectException
      Sets the actual non-overtime cost for the resource assignment on the activity. Computed as actual regular cost = actual regular units * cost per time.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualOvertimeCost

      public Cost getActualOvertimeCost() throws BusinessObjectException
      Gets the actual overtime cost for the resource assignment on the activity. Computed as actual overtime cost = actual overtime units * cost per time * overtime factor.
      Returns:
      the value in the field ActualOvertimeCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualOvertimeCost

      public void setActualOvertimeCost(Cost c) throws BusinessObjectException
      Sets the actual overtime cost for the resource assignment on the activity. Computed as actual overtime cost = actual overtime units * cost per time * overtime factor.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualCost

      public Cost getActualCost() throws BusinessObjectException
      Gets the actual non-overtime plus overtime cost for the resource assignment on the activity. Computed as actual cost = actual regular cost + actual overtime cost.
      Returns:
      the value in the field ActualCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualCost

      public void setActualCost(Cost c) throws BusinessObjectException
      Sets the actual non-overtime plus overtime cost for the resource assignment on the activity. Computed as actual cost = actual regular cost + actual overtime cost.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingStartDate

      public BeginDate getRemainingStartDate() throws BusinessObjectException
      Gets the date the resource is scheduled to begin 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 start date is the same as the planned start date.
      Returns:
      the value in the field RemainingStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingStartDate

      public void setRemainingStartDate(BeginDate d) throws BusinessObjectException
      Sets the date the resource is scheduled to begin 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 start date is the same as the planned start date.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingFinishDate

      public EndDate getRemainingFinishDate() 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.
      Returns:
      the value in the field RemainingFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingFinishDate

      public void setRemainingFinishDate(EndDate d) throws BusinessObjectException
      Sets 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.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingLateStartDate

      public BeginDate getRemainingLateStartDate() throws BusinessObjectException
      Gets the remaining late start date calculated by the scheduler.
      Returns:
      the value in the field RemainingLateStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingLateFinishDate

      public EndDate getRemainingLateFinishDate() throws BusinessObjectException
      Gets the remaining late finish date calculated by the scheduler.
      Returns:
      the value in the field RemainingLateFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingLag

      public Duration getRemainingLag() throws BusinessObjectException
      Gets the time lag between the activity's remaining start date and the resource's remaining start date on the activity. If the resource's remaining work starts on the activity's remaining start date, the lag is zero. Before the activity is started, the remaining lag is the same as the planned lag. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field RemainingLag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingLag

      public void setRemainingLag(Duration d) throws BusinessObjectException
      Sets the time lag between the activity's remaining start date and the resource's remaining start date on the activity. If the resource's remaining work starts on the activity's remaining start date, the lag is zero. Before the activity is started, the remaining lag is the same as the planned lag. 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

    • getRemainingUnits

      public Unit getRemainingUnits() throws BusinessObjectException
      Gets the remaining units of work to be performed by this resource on this activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.
      Returns:
      the value in the field RemainingUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingUnits

      public void setRemainingUnits(Unit u) throws BusinessObjectException
      Sets the remaining units of work to be performed by this resource on this activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingUnitsPerTime

      public UnitsPerTime getRemainingUnitsPerTime() throws BusinessObjectException
      Gets the units per time at which the resource will be performing work on the remaining portion of this activity. For example, a person assigned full time would perform 8 hours of work per day. A department of five people may perform at 5 days per day.
      Returns:
      the value in the field RemainingUnitsPerTime
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingUnitsPerTime

      public void setRemainingUnitsPerTime(UnitsPerTime d) throws BusinessObjectException
      Sets the units per time at which the resource will be performing work on the remaining portion of this activity. For example, a person assigned full time would perform 8 hours of work per day. A department of five people may perform at 5 days per day.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceName

      public String getResourceName() throws BusinessObjectException
      Gets the name of the resource.
      Returns:
      the value in the field ResourceName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCBSCode

      public String getCBSCode() throws BusinessObjectException
      Gets cBS Code. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field CBSCode
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCBSCode

      public void setCBSCode(String s) throws BusinessObjectException
      Sets cBS Code. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingCost

      public Cost getRemainingCost() throws BusinessObjectException
      Gets the remaining cost for the resource assignment on the activity. Computed as remaining cost = remaining units * cost per time.
      Returns:
      the value in the field RemainingCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingCost

      public void setRemainingCost(Cost c) throws BusinessObjectException
      Sets the remaining cost for the resource assignment on the activity. Computed as remaining cost = remaining units * cost per time.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingDuration

      public Duration getRemainingDuration() throws BusinessObjectException
      Gets the remaining duration of the resource assignment. The remaining duration is the remaining working time for the resource assignment on the activity, from the resource's remaining start date to the remaining finish date. The remaining working time is computed using the calendar determined by the activity Type. Resource Dependent activities use the resource's calendar, other activity types use the activity's calendar. Before the activity is started, the remaining duration is the same as the Original duration. After the activity is completed, the remaining duration is zero. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field RemainingDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingDuration

      public void setRemainingDuration(Duration d) throws BusinessObjectException
      Sets the remaining duration of the resource assignment. The remaining duration is the remaining working time for the resource assignment on the activity, from the resource's remaining start date to the remaining finish date. The remaining working time is computed using the calendar determined by the activity Type. Resource Dependent activities use the resource's calendar, other activity types use the activity's calendar. Before the activity is started, the remaining duration is the same as the Original duration. After the activity is completed, the remaining duration is zero. 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

    • getAtCompletionUnits

      public Unit getAtCompletionUnits() throws BusinessObjectException
      Gets the sum of the actual plus remaining units for the resource assignment on the activity.
      Returns:
      the value in the field AtCompletionUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAtCompletionUnits

      public void setAtCompletionUnits(Unit u) throws BusinessObjectException
      Sets the sum of the actual plus remaining units for the resource assignment on the activity.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAtCompletionCost

      public Cost getAtCompletionCost() throws BusinessObjectException
      Gets the sum of the actual plus remaining costs for the resource assignment on the activity.
      Returns:
      the value in the field AtCompletionCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAtCompletionCost

      public void setAtCompletionCost(Cost c) throws BusinessObjectException
      Sets the sum of the actual plus remaining costs for the resource assignment on the activity.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDrivingActivityDatesFlag

      public boolean getDrivingActivityDatesFlag() throws BusinessObjectException
      Gets the flag indicating whether new resource/role assignments drive activity dates, by default.
      Returns:
      the value in the field DrivingActivityDatesFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDrivingActivityDatesFlag

      public void setDrivingActivityDatesFlag(boolean b) throws BusinessObjectException
      Sets the flag indicating whether new resource/role assignments drive activity dates, by default.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceType

      public ResourceType getResourceType() throws BusinessObjectException
      Gets the resource type: "Labor", "Nonlabor", or "Material".
      Returns:
      the value in the field ResourceType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResourceType

      public void setResourceType(ResourceType enm) throws BusinessObjectException
      Sets the resource type: "Labor", "Nonlabor", or "Material".
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsCostUnitsLinked

      public boolean getIsCostUnitsLinked() throws BusinessObjectException
      Gets the flag that determines whether or not cost should be calculated based on units.
      Returns:
      the value in the field IsCostUnitsLinked
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIsCostUnitsLinked

      public void setIsCostUnitsLinked(boolean b) throws BusinessObjectException
      Sets the flag that determines whether or not cost should be calculated based on units.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProficiency

      public Proficiency getProficiency() throws BusinessObjectException
      Gets the skill level that is associated with the role. The values are 'Master', 'Expert', 'Skilled', 'Proficient', and 'Inexperienced'. If the current user does not have the ViewResourceRoleProficiency global security privilege, this field may not be accessed. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field Proficiency
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setProficiency

      public void setProficiency(Proficiency enm) throws BusinessObjectException
      Sets the skill level that is associated with the role. The values are 'Master', 'Expert', 'Skilled', 'Proficient', and 'Inexperienced'. If the current user does not have the ViewResourceRoleProficiency global security privilege, this field may not be accessed. 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

    • getIsOvertimeAllowed

      public boolean getIsOvertimeAllowed() throws BusinessObjectException
      Gets the flag that indicates whether the resource is allowed to log overtime hours.
      Returns:
      the value in the field IsOvertimeAllowed
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getOvertimeFactor

      public double getOvertimeFactor() throws BusinessObjectException
      Gets the overtime factor used to compute the overtime price for the resource assignment on this activity. Overtime price = standard price * overtime factor. When the resource is assigned to the activity, the resource's overtime factor is copied to the assignment. The assignment overtime factor is refreshed from the resource value when resource prices are synchronized for the project.
      Returns:
      the value in the field OvertimeFactor
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setOvertimeFactor

      public void setOvertimeFactor(double d) throws BusinessObjectException
      Sets the overtime factor used to compute the overtime price for the resource assignment on this activity. Overtime price = standard price * overtime factor. When the resource is assigned to the activity, the resource's overtime factor is copied to the assignment. The assignment overtime factor is refreshed from the resource value when resource prices are synchronized for the project.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPricePerUnit

      public Cost getPricePerUnit() throws BusinessObjectException
      Gets the price per time for the resource on this activity. This price is used to compute the resource's cost for the activity. When the resource is assigned to the activity, the resource's price is copied to the assignment based on the effective date of the price and the activity start date. The assignment price is refreshed whenever resource prices are synchronized 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 PricePerUnit
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPricePerUnit

      public void setPricePerUnit(Cost c) throws BusinessObjectException
      Sets the price per time for the resource on this activity. This price is used to compute the resource's cost for the activity. When the resource is assigned to the activity, the resource's price is copied to the assignment based on the effective date of the price and the activity start date. The assignment price is refreshed whenever resource prices are synchronized for the project. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getGUID

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

    • getUnitsPercentComplete

      public Percent getUnitsPercentComplete() throws BusinessObjectException
      Gets the percent complete of units for the resource assignment on the activity. Computed as actual units / at completion units * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field UnitsPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUnitsPercentComplete

      public void setUnitsPercentComplete(Percent p) throws BusinessObjectException
      Sets the percent complete of units for the resource assignment on the activity. Computed as actual units / at completion units * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      p - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityType

      public ActivityType getActivityType() throws BusinessObjectException
      Gets the type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', 'Start Milestone', 'Finish Milestone', or 'WBS Summary'. A 'Task Dependent' activity is scheduled using the activity's calendar rather than the calendars of the assigned resources. A 'Resource Dependent' activity is scheduled using the calendars of the assigned resources. This type is used when several resources are assigned to the activity, but they may work separately. A 'Start Milestone' or 'Finish Milestone' is a zero-duration activity without resources, marking a significant project event. A 'Level of Effort' activity has a duration that is determined by its dependent activities. Administration-type activities are typically 'Level of Effort'. A 'WBS Summary' comprises a group of activities that share a common WBS level. For example, all activities whose WBS codes start with A (A.1, A.1.1, A.1.1.2, A.2, A.3 and so forth) can be part of one WBS activity whose WBS code is A.
      Returns:
      the value in the field ActivityType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRoleId

      public String getRoleId() throws BusinessObjectException
      Gets the short code that uniquely identifies the role.
      Returns:
      the value in the field RoleId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCostAccountObjectId

      public ObjectId getCostAccountObjectId() throws BusinessObjectException
      Gets the unique ID of the cost account associated with this resource assignment. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field CostAccountObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCostAccountObjectId

      public void setCostAccountObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the cost account associated with this resource assignment. 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

    • getWBSObjectId

      public ObjectId getWBSObjectId() throws BusinessObjectException
      Gets the unique ID of the WBS for the activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field WBSObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCostAccountName

      public String getCostAccountName() throws BusinessObjectException
      Gets the name of the associated cost account.
      Returns:
      the value in the field CostAccountName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCostAccountId

      public String getCostAccountId() throws BusinessObjectException
      Gets the id of associated cost account.
      Returns:
      the value in the field CostAccountId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceRequest

      public ResourceRequest getResourceRequest() throws BusinessObjectException
      Gets the resource request used as a search template to search for a qualified resource. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field ResourceRequest
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResourceRequest

      public void setResourceRequest(ResourceRequest r) throws BusinessObjectException
      Sets the resource request used as a search template to search for a qualified resource. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      r - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRateType

      public RateType getRateType() throws BusinessObjectException
      Gets the rate type that determines which of the five prices specified for the resource will be used to calculate the cost for the resource assignment. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', 'Price / Unit5', and 'None'.
      Returns:
      the value in the field RateType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRateType

      public void setRateType(RateType enm) throws BusinessObjectException
      Sets the rate type that determines which of the five prices specified for the resource will be used to calculate the cost for the resource assignment. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', 'Price / Unit5', and 'None'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRateSource

      public RateSource getRateSource() throws BusinessObjectException
      Gets the value that indicates which price/unit will be used to calculate costs for the assignment, such as 'Resource', 'Role', and 'Override'. When a resource and only a resource is assigned to an activity, the rate source will automatically equal 'Resource'. When a role and only a role is assigned to an activity, the rate source will automatically equal 'Role'. When both a resource and role are assigned to the activity, the rate source can be either 'Resource' or 'Role' determined by the RateSourcePreference. In any case, the 'Override' value allows you to specify any other price/unit.
      Returns:
      the value in the field RateSource
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRateSource

      public void setRateSource(RateSource enm) throws BusinessObjectException
      Sets the value that indicates which price/unit will be used to calculate costs for the assignment, such as 'Resource', 'Role', and 'Override'. When a resource and only a resource is assigned to an activity, the rate source will automatically equal 'Resource'. When a role and only a role is assigned to an activity, the rate source will automatically equal 'Role'. When both a resource and role are assigned to the activity, the rate source can be either 'Resource' or 'Role' determined by the RateSourcePreference. In any case, the 'Override' value allows you to specify any other price/unit.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualThisPeriodUnits

      public Unit getActualThisPeriodUnits() throws BusinessObjectException
      Gets the actual this period units (hours) (will be labor or nonlabor).
      Returns:
      the value in the field ActualThisPeriodUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualThisPeriodUnits

      public void setActualThisPeriodUnits(Unit u) throws BusinessObjectException
      Sets the actual this period units (hours) (will be labor or nonlabor).
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualThisPeriodCost

      public Cost getActualThisPeriodCost() throws BusinessObjectException
      Gets the actual this period cost (will be labor or nonlabor).
      Returns:
      the value in the field ActualThisPeriodCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualThisPeriodCost

      public void setActualThisPeriodCost(Cost c) throws BusinessObjectException
      Sets the actual this period cost (will be labor or nonlabor).
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityActualFinish

      public EndDate getActivityActualFinish() throws BusinessObjectException
      Gets the date on which the activity is actually finished.
      Returns:
      the value in the field ActivityActualFinish
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceAssignmentSpread

      public ResourceAssignmentSpread getResourceAssignmentSpread() throws BusinessObjectException
      Gets the live resource assignment spread data. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field ResourceAssignmentSpread
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResourceAssignmentSpread

      public void setResourceAssignmentSpread(ResourceAssignmentSpread bs) throws BusinessObjectException
      Sets the live resource assignment spread data. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      bs - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPeriodPerformanceSpread

      public com.primavera.common.value.spread.PeriodPerformanceSpread getPeriodPerformanceSpread() throws BusinessObjectException
      Gets the live resource assignment period spread data. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PeriodPerformanceSpread
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPendingActualOvertimeUnits

      public Unit getPendingActualOvertimeUnits() throws BusinessObjectException
      Gets the actual overtime units worked by the resource on this activity. This value is computed from values entered by a user in the Progress Reporter application and is applied to the resource assignment when the Apply Actuals service is invoked.
      Returns:
      the value in the field PendingActualOvertimeUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPendingActualRegularUnits

      public Unit getPendingActualRegularUnits() throws BusinessObjectException
      Gets the actual nonovertime units worked by the resource on this activity. This value is computed from values entered by a user in the Progress Reporter application and is applied to the resource assignment when the Apply Actuals service is invoked.
      Returns:
      the value in the field PendingActualRegularUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPendingPercentComplete

      public Percent getPendingPercentComplete() throws BusinessObjectException
      Gets the estimate of the percentage of the resource's units of work completed on this activity. The pending percent complete is entered by each resource using Timesheets. This value is used to compute the resource's remaining units for the activity when project actuals are applied. The project manager specifies whether resources update their percent complete or remaining units for each project.
      Returns:
      the value in the field PendingPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPendingPercentComplete

      public void setPendingPercentComplete(Percent p) throws BusinessObjectException
      Sets the estimate of the percentage of the resource's units of work completed on this activity. The pending percent complete is entered by each resource using Timesheets. This value is used to compute the resource's remaining units for the activity when project actuals are applied. The project manager specifies whether resources update their percent complete or remaining units for each project.
      Parameters:
      p - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getTotalPastPeriodUnits

      public Unit getTotalPastPeriodUnits() throws BusinessObjectException
      Gets the total stored period units for each assignment. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TotalPastPeriodUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setTotalPastPeriodUnits

      public void setTotalPastPeriodUnits(Unit u) throws BusinessObjectException
      Sets the total stored period units for each assignment. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getTotalPastPeriodCost

      public Cost getTotalPastPeriodCost() throws BusinessObjectException
      Gets the total stored period cost for each assignment. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TotalPastPeriodCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setTotalPastPeriodCost

      public void setTotalPastPeriodCost(Cost c) throws BusinessObjectException
      Sets the total stored period cost for each assignment. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this assignment was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this assignment was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateUser

      public String getCreateUser() throws BusinessObjectException
      Gets the name of the user that created this assignment.
      Returns:
      the value in the field CreateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateUser

      public String getLastUpdateUser() throws BusinessObjectException
      Gets the name of the user that last updated this assignment.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectFlag

      public String getProjectFlag() throws BusinessObjectException
      Gets indicates if this WBS node a Project/EPS node?.
      Returns:
      the value in the field ProjectFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectProjectFlag

      public String getProjectProjectFlag() throws BusinessObjectException
      Gets indicates if this Project/EPS node a Project or EPS?.
      Returns:
      the value in the field ProjectProjectFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsBaseline

      public boolean getIsBaseline() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a Project or Baseline.
      Returns:
      the value in the field IsBaseline
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsTemplate

      public boolean getIsTemplate() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a template Project.
      Returns:
      the value in the field IsTemplate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStatusCode

      public ProjectStatus getStatusCode() throws BusinessObjectException
      Gets the project status: 'Planned', 'Active', 'Inactive', 'What-If', 'Requested', or 'Template'.
      Returns:
      the value in the field StatusCode
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getHasFutureBucketData

      public boolean getHasFutureBucketData() throws BusinessObjectException
      Gets the flag that indicates whether the assignment has future bucket data.
      Returns:
      the value in the field HasFutureBucketData
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedCurve

      public String getPlannedCurve() throws BusinessObjectException
      Gets internal profile data for planned values.
      Returns:
      the value in the field PlannedCurve
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedCurve

      public void setPlannedCurve(String s) throws BusinessObjectException
      Sets internal profile data for planned values.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualCurve

      public String getActualCurve() throws BusinessObjectException
      Gets internal profile data for actual values.
      Returns:
      the value in the field ActualCurve
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualCurve

      public void setActualCurve(String s) throws BusinessObjectException
      Sets internal profile data for actual values.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingCurve

      public String getRemainingCurve() throws BusinessObjectException
      Gets internal profile data for remaining values.
      Returns:
      the value in the field RemainingCurve
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingCurve

      public void setRemainingCurve(String s) throws BusinessObjectException
      Sets internal profile data for remaining values.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPriorActualRegularUnits

      public Unit getPriorActualRegularUnits() throws BusinessObjectException
      Gets the difference between the pending quantity value and the actual quantity value before applying the new actual value.
      Returns:
      the value in the field PriorActualRegularUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPriorActualOvertimeUnits

      public Unit getPriorActualOvertimeUnits() throws BusinessObjectException
      Gets the difference between the pending quantity value and the actual quantity value for overtime before applying the new actual value.
      Returns:
      the value in the field PriorActualOvertimeUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getReviewRequired

      public boolean getReviewRequired() throws BusinessObjectException
      Gets the indicator that determines whether the activity status updates made in Team Member applications must be approved before commiting changes.
      Returns:
      the value in the field ReviewRequired
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsActivityFlagged

      public boolean getIsActivityFlagged() throws BusinessObjectException
      Gets the flag that indicates whether the resource who is assigned to the activity assignment has flagged the activity as important to the resource.
      Returns:
      the value in the field IsActivityFlagged
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIsActivityFlagged

      public void setIsActivityFlagged(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether the resource who is assigned to the activity assignment has flagged the activity as important to the resource.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUnreadCommentCount

      public int getUnreadCommentCount() throws BusinessObjectException
      Gets the total number of unread comments on this activity for a user. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field UnreadCommentCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFinancialPeriodTmplId

      public ObjectId getFinancialPeriodTmplId() throws BusinessObjectException
      Gets financial Period Template Id.
      Returns:
      the value in the field FinancialPeriodTmplId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getBudgetAtCompletionUnits

      public Unit getBudgetAtCompletionUnits() throws BusinessObjectException
      Gets the total number of unread comments on this activity for a user. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field BudgetAtCompletionUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setBudgetAtCompletionUnits

      public void setBudgetAtCompletionUnits(Unit u) throws BusinessObjectException
      Sets the total number of unread comments on this activity for a user. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getBudgetAtCompletionCosts

      public Cost getBudgetAtCompletionCosts() throws BusinessObjectException
      Gets the total number of unread comments on this activity for a user. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field BudgetAtCompletionCosts
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setBudgetAtCompletionCosts

      public void setBudgetAtCompletionCosts(Cost c) throws BusinessObjectException
      Sets the total number of unread comments on this activity for a user. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getEstimateTimeToComplete

      public Duration getEstimateTimeToComplete() throws BusinessObjectException
      Gets displays the projected duration required to complete an activity based on schedule performance to date. Calculated as Original Duration divided by Schedule Performance Index (SPI). This field provides an estimate of the remaining time assuming current performance trends continue. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field EstimateTimeToComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getEstimateTimeToCompleteUnits

      public Unit getEstimateTimeToCompleteUnits() throws BusinessObjectException
      Gets displays the projected labor effort needed to complete the remaining scope of work, based on labor efficiency to date. Calculated as Remaining Labor Units divided by SPI (Labor). Provides a forward-looking view of labor resource demand aligned with current productivity levels. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field EstimateTimeToCompleteUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getEstimateToCompletionUnits

      public Unit getEstimateToCompletionUnits() throws BusinessObjectException
      Gets the estimated quantity to complete the activity. Computed as either the remaining total units for the activity (remaining total units), or as PF * (BL units - earned value), depending on the earned-value technique selected for the activity's WBS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field EstimateToCompletionUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getEstimateToCompletionCosts

      public Cost getEstimateToCompletionCosts() throws BusinessObjectException
      Gets the estimated cost to complete the activity. Computed as either the remaining total cost for the activity (remaining total cost), or as PF * (BAC - earned value), depending on the earned-value technique selected for the activity's WBS. BAC is computed from the project baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field EstimateToCompletionCosts
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static 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 String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields

    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getMainFields

      public static String[] getMainFields()
      Gets all fields in the main group for this business object.
      Returns:
      String[] an array of fields in this group

    • getSpreadFields

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

    • getBaseSpreadFields

      public static String[] getBaseSpreadFields()
      Gets all spread fields that can be specified in the spreadFields parameter of loadWithBaseSpread methods for this business object.
      Returns:
      String[] an array of all spread fields

    • getWritableFields

      public static String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields

    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names

    • getMinimumXMLExportFields

      public static 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 String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this ResourceAssignment object in the database.
      Returns:
      ObjectId the unique ID of the newly created ResourceAssignment object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • create

      public static ObjectId[] create(Session session, ResourceAssignment[] resourceassignments) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple ResourceAssignment objects in the database.
      Parameters:
      session - the Session object
      resourceassignments - array of ResourceAssignment objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created ResourceAssignment objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static ResourceAssignment load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single ResourceAssignment object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the ResourceAssignment object
      Returns:
      ResourceAssignment the ResourceAssignment object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static BOIterator<ResourceAssignment> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ResourceAssignment objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the ResourceAssignment objects
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadWithLiveSpread

      public static ResourceAssignment loadWithLiveSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads a ResourceAssignment object with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objId - unique ID of the ResourceAssignment 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:
      ResourceAssignment the ResourceAssignment object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadWithLiveSpread

      public static BOIterator<ResourceAssignment> loadWithLiveSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ResourceAssignment objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the ResourceAssignment 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

    • loadWithLiveSpreadActivityOrAssignment

      public static BOIterator<ResourceAssignment> loadWithLiveSpreadActivityOrAssignment(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ResourceAssignment objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the ResourceAssignment 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

    • loadWithPeriodPerformanceSpread

      public static ResourceAssignment loadWithPeriodPerformanceSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads a ResourceAssignment object with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objId - unique ID of the ResourceAssignment 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:
      ResourceAssignment the ResourceAssignment object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadWithPeriodPerformanceSpread

      public static BOIterator<ResourceAssignment> loadWithPeriodPerformanceSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ResourceAssignment objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the ResourceAssignment 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

    • loadWithPeriodPerformanceSpreadActivityOrAssignment

      public static BOIterator<ResourceAssignment> loadWithPeriodPerformanceSpreadActivityOrAssignment(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ResourceAssignment objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the ResourceAssignment 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 ResourceAssignment object in the database.
      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, ResourceAssignment[] resourceassignments) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple ResourceAssignment objects in the database.
      Parameters:
      session - the Session object
      resourceassignments - array of ResourceAssignment objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public void delete() throws ServerException, NetworkException, BusinessObjectException
      Deletes this ResourceAssignment object from the database.
      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, ResourceAssignment[] resourceassignments) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple ResourceAssignment objects from the database.
      Parameters:
      session - the Session object
      resourceassignments - array of ResourceAssignment objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects