Primavera Integration API 7.0

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

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.base.ResourceAssignmentBase
              extended by com.primavera.integration.client.bo.object.ResourceAssignment

public class ResourceAssignment
extends com.primavera.integration.client.bo.base.ResourceAssignmentBase

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 Summary
ResourceAssignment(Session session)
          Class constructor specifying the Session.
ResourceAssignment(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ResourceAssignment(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this ResourceAssignment object in the database.
static ObjectId[] create(Session session, ResourceAssignment[] resourceassignments)
          Creates multiple ResourceAssignment objects in the database.
 void delete()
          Deletes this ResourceAssignment object from the database.
static void delete(Session session, ResourceAssignment[] resourceassignments)
          Deletes multiple ResourceAssignment objects from the database.
 java.lang.String getActivityId()
          Gets the short ID that uniquely identifies the activity within the project.
 java.lang.String getActivityName()
          Gets the name of the activity.
 ObjectId getActivityObjectId()
          Gets the unique ID of the activity to which the resource is assigned.
 Cost getActualCost()
          Gets the actual non-overtime plus overtime cost for the resource assignment on the activity.
 Duration getActualDuration()
          Gets the actual duration for the resource assignment on the activity.
 EndDate getActualFinishDate()
          Gets the date the resource actually finished working on the activity.
 Cost getActualOvertimeCost()
          Gets the actual overtime cost for the resource assignment on the activity.
 Unit getActualOvertimeUnits()
          Gets the actual overtime units worked by the resource on this activity.
 Cost getActualRegularCost()
          Gets the actual non-overtime cost for the resource assignment on the activity.
 Unit getActualRegularUnits()
          Gets the actual non-overtime units worked by the resource on this activity.
 BeginDate getActualStartDate()
          Gets the date the resource actually started working on the activity.
 Cost getActualThisPeriodCost()
          Gets the actual this period cost (will be labor or nonlabor).
 Unit getActualThisPeriodUnits()
          Gets the actual this period units (hours) (will be labor or nonlabor).
 Unit getActualUnits()
          Gets the actual non-overtime plus overtime units worked by the resource on this activity.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 Cost getAtCompletionCost()
          Gets the sum of the actual plus remaining costs for the resource assignment on the activity.
 Duration getAtCompletionDuration()
          Gets the total working time from the activity's current start date to the current finish date.
 Unit getAtCompletionUnits()
          Gets the sum of the actual plus remaining units for the resource assignment on the activity.
 boolean getAutoComputeActuals()
          Gets the option that determines whether the activity's actual and remaining units, start date, finish date, and percent complete are computed automatically using the planned dates, planned units and the schedule percent complete.
 java.lang.String getCalendarName()
          Gets the name of the calendar.
 ObjectId getCalendarObjectId()
          Gets the unique ID generated by the system for the calendar associated with the resource assignment.
 java.lang.String getCostAccountId()
          Gets the id of associated cost account.
 java.lang.String getCostAccountName()
          Gets the name of the associated cost account.
 ObjectId getCostAccountObjectId()
          Gets the unique ID of the cost account associated with this resource assignment.
 java.util.Date getCreateDate()
          Gets the date this assignment was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this assignment.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 boolean getDrivingActivityDatesFlag()
          Gets the flag indicating whether new resource/role assignments drive activity dates, by default.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 EndDate getFinishDate()
          Gets the finish date of the resource assignment on the activity.
 java.lang.String getGUID()
          Gets the globally unique ID generated by the system.
 boolean getHasFutureBucketData()
          Gets the flag that indicates whether the assignment has future bucket data.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 boolean getIsActive()
          Gets the flag that indicates whether this resource assignment is active.
 boolean getIsBaseline()
          Gets the boolean value indicating if this business object is related to a Project or Baseline.
 boolean getIsCostUnitsLinked()
          Gets the flag that determines whether or not cost should be calculated based on units.
 boolean getIsOvertimeAllowed()
          Gets the flag that indicates whether the resource is allowed to log overtime hours.
 boolean getIsPrimaryResource()
          Gets the flag that indicates whether this resource is the activity's primary resource.
 java.util.Date getLastUpdateDate()
          Gets the date this assignment was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this assignment.
static java.lang.String[] getMainFields()
          Gets all fields in the main group for this business object.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 double getOvertimeFactor()
          Gets the overtime factor used to compute the overtime price for the resource assignment on this activity.
 Unit getPendingActualOvertimeUnits()
          Gets the actual overtime units worked by the resource on this activity.
 Unit getPendingActualRegularUnits()
          Gets the actual nonovertime units worked by the resource on this activity.
 Percent getPendingPercentComplete()
          Gets the estimate of the percentage of the resource's units of work completed on this activity.
 double getPendingRemainingUnits()
          Gets the estimate of the resource's remaining units on this activity.
 Cost getPlannedCost()
          Gets the planned cost for the resource assignment on the activity.
 Duration getPlannedDuration()
          Gets the planned working time for the resource assignment on the activity, from the resource's planned start date to the planned finish date.
 EndDate getPlannedFinishDate()
          Gets the date the resource is scheduled to finish working on the activity.
 Duration getPlannedLag()
          Gets the planned time lag between the activity's planned start date and the resource's planned start date on the activity.
 BeginDate getPlannedStartDate()
          Gets the date the resource is scheduled to begin working on the activity.
 Unit getPlannedUnits()
          Gets the planned units of work for the resource assignment on the activity.
 UnitsPerTime getPlannedUnitsPerTime()
          Gets the planned units per time at which the resource is to perform work on this activity.
 Cost getPricePerUnit()
          Gets the price per time for the resource on this activity.
 Unit getPriorActualOvertimeUnits()
          Gets the difference between the pending quantity value and the actual quantity value for overtime before applying the new actual value.
 Unit getPriorActualRegularUnits()
          Gets the difference between the pending quantity value and the actual quantity value before applying the new actual value.
 Proficiency getProficiency()
          Gets the skill level that is associated with the role.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
 RateSource getRateSource()
          Gets the value that indicates which price/unit will be used to calculate costs for the assignment, such as 'Resource', 'Role', and 'Override'.
 RateType getRateType()
          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.
 Cost getRemainingCost()
          Gets the remaining cost for the resource assignment on the activity.
 Duration getRemainingDuration()
          Gets the remaining duration of the resource assignment.
 EndDate getRemainingFinishDate()
          Gets the date the resource is scheduled to finish the remaining work for the activity.
 Duration getRemainingLag()
          Gets the time lag between the activity's remaining start date and the resource's remaining start date on the activity.
 EndDate getRemainingLateFinishDate()
          Gets the remaining late finish date calculated by the scheduler.
 BeginDate getRemainingLateStartDate()
          Gets the remaining late start date calculated by the scheduler.
 BeginDate getRemainingStartDate()
          Gets the date the resource is scheduled to begin the remaining work for the activity.
 Unit getRemainingUnits()
          Gets the remaining units of work to be performed by this resource on this activity.
 UnitsPerTime getRemainingUnitsPerTime()
          Gets the units per time at which the resource will be performing work on the remaining portion of this activity.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 ResourceAssignmentSpread getResourceAssignmentSpread()
          Gets the live resource assignment spread data.
 java.lang.String getResourceCalendarName()
          Gets the name of the calendar for the resource.
 java.lang.String getResourceCurveName()
          Gets the name of the resource curve that determines how resources and costs are distributed over time for this activity.
 ObjectId getResourceCurveObjectId()
          Gets the unique ID of the resource curve.
 java.lang.String getResourceId()
          Gets the short code that uniquely identifies the resource.
 java.lang.String getResourceName()
          Gets the name of the resource.
 ObjectId getResourceObjectId()
          Gets the unique ID of the associated resource.
 com.primavera.integration.common.value.ResourceRequest getResourceRequest()
          Gets the resource request used as a search template to search for a qualified resource.
 ResourceType getResourceType()
          Gets the resource type: "Labor", "Nonlabor", or "Material".
 java.lang.String getRoleId()
          Gets the short code that uniquely identifies the role.
 java.lang.String getRoleName()
          Gets the name of the role.
 ObjectId getRoleObjectId()
          Gets the unique ID of the role the resource is performing on this activity.
static java.lang.String[] getSpreadFields()
          Gets all spread fields that can be specified in the spreadFields parameter of loadWithLiveSpread methods for this business object.
 Cost getStaffedRemainingCost()
          Gets the time distribution of the resource's remaining cost for resource assignments that have filled a role.
 Unit getStaffedRemainingUnits()
          Gets the time distribution of the resource's remaining units for resource assignments that have filled a role.
 BeginDate getStartDate()
          Gets the start date of the resource assignment on the activity.
 Cost getUDFCost(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Double getUDFDouble(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 EndDate getUDFFinishDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 UDFIndicator getUDFIndicator(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Integer getUDFInteger(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 BeginDate getUDFStartDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.String getUDFText(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 ObjectId[] getUDFTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.
 Percent getUnitsPercentComplete()
          Gets the percent complete of units for the resource assignment on the activity.
 Cost getUnstaffedRemainingCost()
          Gets the time distribution of the resource's remaining cost for resource assignments that have not filled a role.
 Unit getUnstaffedRemainingUnits()
          Gets the time distribution of the resource's remaining units for resource assignments that have not filled a role.
 ObjectId getWBSObjectId()
          Gets the unique ID of the WBS for the activity.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ResourceAssignment load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ResourceAssignment object from the database.
static BOIterator<ResourceAssignment> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ResourceAssignment objects from the database.
 Activity loadActivity(java.lang.String[] fields)
          Loads an associated Activity object from the database.
 CostAccount loadCostAccount(java.lang.String[] fields)
          Loads an associated CostAccount object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 Resource loadResource(java.lang.String[] fields)
          Loads an associated Resource object from the database.
 BOIterator<ResourceAssignmentPeriodActual> loadResourceAssignmentPeriodActuals(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceAssignmentPeriodActual objects from the database.
 ResourceCurve loadResourceCurve(java.lang.String[] fields)
          Loads an associated ResourceCurve object from the database.
 BOIterator<ResourceHour> loadResourceHours(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceHour objects from the database.
 Role loadRole(java.lang.String[] fields)
          Loads an associated Role object from the database.
 BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UDFValue objects from the database.
static BOIterator<ResourceAssignment> loadWithLiveSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId[] objIds, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative)
          Loads multiple ResourceAssignment objects with live spreads from the database.
static ResourceAssignment loadWithLiveSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId objId, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative)
          Loads a ResourceAssignment object with live spreads from the database.
 void setActivityObjectId(ObjectId o)
          Sets the unique ID of the activity to which the resource is assigned.
 void setActualCost(Cost c)
          Sets the actual non-overtime plus overtime cost for the resource assignment on the activity.
 void setActualFinishDate(EndDate d)
          Sets the date the resource actually finished working on the activity.
 void setActualOvertimeCost(Cost c)
          Sets the actual overtime cost for the resource assignment on the activity.
 void setActualOvertimeUnits(Unit u)
          Sets the actual overtime units worked by the resource on this activity.
 void setActualRegularCost(Cost c)
          Sets the actual non-overtime cost for the resource assignment on the activity.
 void setActualRegularUnits(Unit u)
          Sets the actual non-overtime units worked by the resource on this activity.
 void setActualStartDate(BeginDate d)
          Sets the date the resource actually started working on the activity.
 void setActualThisPeriodCost(Cost c)
          Sets the actual this period cost (will be labor or nonlabor).
 void setActualThisPeriodUnits(Unit u)
          Sets the actual this period units (hours) (will be labor or nonlabor).
 void setActualUnits(Unit u)
          Sets the actual non-overtime plus overtime units worked by the resource on this activity.
 void setAtCompletionCost(Cost c)
          Sets the sum of the actual plus remaining costs for the resource assignment on the activity.
 void setAtCompletionUnits(Unit u)
          Sets the sum of the actual plus remaining units for the resource assignment on the activity.
 void setCostAccountObjectId(ObjectId o)
          Sets the unique ID of the cost account associated with this resource assignment.
 void setDrivingActivityDatesFlag(boolean b)
          Sets the flag indicating whether new resource/role assignments drive activity dates, by default.
 void setFinishDate(EndDate d)
          Sets the finish date of the resource assignment on the activity.
 void setGUID(java.lang.String s)
          Sets the globally unique ID generated by the system.
 void setIsCostUnitsLinked(boolean b)
          Sets the flag that determines whether or not cost should be calculated based on units.
 void setIsPrimaryResource(boolean b)
          Sets the flag that indicates whether this resource is the activity's primary resource.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setOvertimeFactor(double d)
          Sets the overtime factor used to compute the overtime price for the resource assignment on this activity.
 void setPendingPercentComplete(Percent p)
          Sets the estimate of the percentage of the resource's units of work completed on this activity.
 void setPendingRemainingUnits(double d)
          Sets the estimate of the resource's remaining units on this activity.
 void setPlannedCost(Cost c)
          Sets the planned cost for the resource assignment on the activity.
 void setPlannedDuration(Duration d)
          Sets the planned working time for the resource assignment on the activity, from the resource's planned start date to the planned finish date.
 void setPlannedFinishDate(EndDate d)
          Sets the date the resource is scheduled to finish working on the activity.
 void setPlannedLag(Duration d)
          Sets the planned time lag between the activity's planned start date and the resource's planned start date on the activity.
 void setPlannedStartDate(BeginDate d)
          Sets the date the resource is scheduled to begin working on the activity.
 void setPlannedUnits(Unit u)
          Sets the planned units of work for the resource assignment on the activity.
 void setPlannedUnitsPerTime(UnitsPerTime d)
          Sets the planned units per time at which the resource is to perform work on this activity.
 void setPricePerUnit(Cost c)
          Sets the price per time for the resource on this activity.
 void setProficiency(Proficiency enm)
          Sets the skill level that is associated with the role.
 void setRateSource(RateSource enm)
          Sets the value that indicates which price/unit will be used to calculate costs for the assignment, such as 'Resource', 'Role', and 'Override'.
 void setRateType(RateType enm)
          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.
 void setRemainingCost(Cost c)
          Sets the remaining cost for the resource assignment on the activity.
 void setRemainingDuration(Duration d)
          Sets the remaining duration of the resource assignment.
 void setRemainingFinishDate(EndDate d)
          Sets the date the resource is scheduled to finish the remaining work for the activity.
 void setRemainingLag(Duration d)
          Sets the time lag between the activity's remaining start date and the resource's remaining start date on the activity.
 void setRemainingStartDate(BeginDate d)
          Sets the date the resource is scheduled to begin the remaining work for the activity.
 void setRemainingUnits(Unit u)
          Sets the remaining units of work to be performed by this resource on this activity.
 void setRemainingUnitsPerTime(UnitsPerTime d)
          Sets the units per time at which the resource will be performing work on the remaining portion of this activity.
 void setResourceAssignmentSpread(ResourceAssignmentSpread bs)
          Sets the live resource assignment spread data.
 void setResourceCurveObjectId(ObjectId o)
          Sets the unique ID of the resource curve.
 void setResourceObjectId(ObjectId o)
          Sets the unique ID of the associated resource.
 void setResourceRequest(com.primavera.integration.common.value.ResourceRequest r)
          Sets the resource request used as a search template to search for a qualified resource.
 void setResourceType(ResourceType enm)
          Sets the resource type: "Labor", "Nonlabor", or "Material".
 void setRoleObjectId(ObjectId o)
          Sets the unique ID of the role the resource is performing on this activity.
 void setStartDate(BeginDate d)
          Sets the start date of the resource assignment on the activity.
 void setUDFCost(ObjectId objId, Cost cost)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFDouble(ObjectId objId, java.lang.Double n)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFFinishDate(ObjectId objId, EndDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFIndicator(ObjectId objId, UDFIndicator ind)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFInteger(ObjectId objId, java.lang.Integer i)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFStartDate(ObjectId objId, BeginDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFText(ObjectId objId, java.lang.String s)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUnitsPercentComplete(Percent p)
          Sets the percent complete of units for the resource assignment on the activity.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ResourceAssignment object in the database.
static void update(Session session, ResourceAssignment[] resourceassignments)
          Updates multiple ResourceAssignment objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

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 Detail

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,
                                      java.lang.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

loadWithLiveSpread

public static ResourceAssignment loadWithLiveSpread(Session session,
                                                    java.lang.String[] nonSpreadFields,
                                                    ObjectId objId,
                                                    java.lang.String[] spreadFields,
                                                    SpreadPeriodType periodType,
                                                    java.util.Date startDate,
                                                    java.util.Date endDate,
                                                    boolean bIncludeCumulative)
                                             throws ServerException,
                                                    NetworkException,
                                                    BusinessObjectException
Loads a ResourceAssignment object with live 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

load

public static BOIterator<ResourceAssignment> load(Session session,
                                                  java.lang.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 BOIterator<ResourceAssignment> loadWithLiveSpread(Session session,
                                                                java.lang.String[] nonSpreadFields,
                                                                ObjectId[] objIds,
                                                                java.lang.String[] spreadFields,
                                                                SpreadPeriodType periodType,
                                                                java.util.Date startDate,
                                                                java.util.Date endDate,
                                                                boolean bIncludeCumulative)
                                                         throws ServerException,
                                                                NetworkException,
                                                                BusinessObjectException
Loads multiple ResourceAssignment objects with live 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.

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

update

public static void update(Session session,
                          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.

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

delete

public static void delete(Session session,
                          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

loadActivity

public Activity loadActivity(java.lang.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(java.lang.String[] fields)
                    throws ServerException,
                           NetworkException,
                           BusinessObjectException
Loads an associated Project object from the database.

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

loadResource

public Resource loadResource(java.lang.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(java.lang.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(java.lang.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(java.lang.String[] fields,
                                                                                      java.lang.String sWhereClause,
                                                                                      java.lang.String sOrderBy)
                                                                               throws ServerException,
                                                                                      NetworkException,
                                                                                      BusinessObjectException
Loads multiple associated ResourceAssignmentPeriodActual objects from the database.

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

loadResourceHours

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

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

loadResourceCurve

public ResourceCurve loadResourceCurve(java.lang.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(java.lang.String[] fields,
                                          java.lang.String sWhereClause,
                                          java.lang.String sOrderBy)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Loads multiple associated UDFValue objects from the database.

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

getUDFTypesAssigned

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

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

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

getObjectId

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

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

setObjectId

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

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

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

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 java.lang.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 java.lang.String getProjectId()
                              throws BusinessObjectException
Gets the short code that uniquely identifies the project.

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

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

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 java.lang.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 java.lang.String getResourceCalendarName()
                                         throws BusinessObjectException
Gets the name of the calendar for the resource. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field 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 java.lang.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

getActivityId

public java.lang.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 java.lang.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 java.lang.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

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 double 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(double d)
                              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:
d - 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 java.lang.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

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 java.lang.String getGUID()
                         throws BusinessObjectException
Gets the globally unique ID generated by the system.

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

setGUID

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

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

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

getRoleId

public java.lang.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 java.lang.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 java.lang.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 com.primavera.integration.common.value.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(com.primavera.integration.common.value.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

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

getPendingActualOvertimeUnits

public Unit getPendingActualOvertimeUnits()
                                   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 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 timesheets when project actuals are applied or may be entered directly by the project manager.

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

getCreateDate

public java.util.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 java.util.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 java.lang.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 java.lang.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

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

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

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

getUDFCost

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

Gets the value of a particular Cost user defined field.

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

setUDFCost

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

Sets the value of a particular Cost user defined field.

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

getUDFDouble

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

Gets the value of a particular Double user defined field.

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

setUDFDouble

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

Sets the value of a particular Double user defined field.

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

getUDFFinishDate

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

Gets the value of a particular FinishDate user defined field.

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

setUDFFinishDate

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

Sets the value of a particular FinishDate user defined field.

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

getUDFIndicator

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

Gets the value of a particular Indicator user defined field.

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

setUDFIndicator

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

Sets the value of a particular Indicator user defined field.

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

getUDFInteger

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

Gets the value of a particular Integer user defined field.

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

setUDFInteger

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

Sets the value of a particular Integer user defined field.

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

getUDFStartDate

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

Gets the value of a particular StartDate user defined field.

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

setUDFStartDate

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

Sets the value of a particular StartDate user defined field.

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

getUDFText

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

Gets the value of a particular Text user defined field.

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

setUDFText

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

Sets the value of a particular Text user defined field.

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

getRequiredCreateFields

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

Returns:
String[] an array of required create fields

getFilterableFields

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

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

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

Returns:
String[] an internal array

getAllFields

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

Returns:
String[] an array of all fields

getInternalAllFields

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

Returns:
String[] an internal array

getInternalAllFieldsSet

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

Returns:
String[] an internal array

getMainFields

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

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

getSpreadFields

public static java.lang.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

getWritableFields

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

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

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

Returns:
String[] an array of field names

getMinimumXMLExportFields

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

Returns:
String[] an array of exported fields

toString

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

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

Primavera Integration API 7.0

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