Resource (MPXJ 13.6.0 API)

java.lang.Object
- net.sf.mpxj.AbstractFieldContainer<Resource>
- - net.sf.mpxj.Resource

All Implemented Interfaces:

Comparable<Resource>, ChildResourceContainer, FieldContainer, ProjectEntityWithID, ProjectEntityWithMutableUniqueID, ProjectEntityWithUniqueID
```
public final class Resource
extends AbstractFieldContainer<Resource>
implements Comparable<Resource>, ProjectEntityWithID, ChildResourceContainer
```
This class represents a resource used in a project.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProjectCalendar`	`addCalendar()` This method allows a calendar to be added to a resource.
`void`	`addChildResource(Resource child)` Add an existing resource as a child of the current resource.
`Resource`	`addResource()` Creates and adds a resource to the list of resources held by this object.
`void`	`addResourceAssignment(ResourceAssignment assignment)` This method is used internally within MPXJ to track tasks which are assigned to a particular resource.
`void`	`addRoleAssignment(Resource role, SkillLevel skillLevel)` Add a role assignment, and a skill level for the role, to this resource.
`int`	`compareTo(Resource o)` This method implements the only method in the Comparable interface.
`boolean`	`equals(Object o)`
`AccrueType`	`getAccrueAt()` Gets the Accrue at type.The Accrue At field provides choices for how and when resource standard and overtime costs are to be charged, or accrued, to the cost of a task.
`boolean`	`getActive()` Retrieves the active flag.
`String`	`getActiveDirectoryGUID()` Retrieves the active directory GUID for this resource.
`Number`	`getActualCost()` Retrieves the actual cost for the work already performed by this resource.
`Number`	`getActualOvertimeCost()` Retrieve actual overtime cost.
`Duration`	`getActualOvertimeWork()` Retrieve the value of the actual overtime work field.
`Duration`	`getActualOvertimeWorkProtected()` Retrieves the actual overtime work protected duration.
`Duration`	`getActualWork()` Retrieves the Actual Work field contains the amount of work that has already been done for all assignments assigned to a resource.
`Duration`	`getActualWorkProtected()` Retrieves the actual work protected duration.
`Number`	`getACWP()` Set the actual cost of work performed.
`protected boolean`	`getAlwaysCalculatedField(FieldType field)` Determine if the supplied field is always calculated.
`AvailabilityTable`	`getAvailability()` Retrieve the availability table for this resource.
`LocalDateTime`	`getAvailableFrom()` Retrieves the "available from" date.
`LocalDateTime`	`getAvailableTo()` Retrieves the "available to" date.
`String`	`getBaseCalendar()` Retrieves Base Calendar name associated with this resource.
`Number`	`getBaselineBudgetCost()` Retrieve the baseline budget cost.
`Number`	`getBaselineBudgetCost(int baselineNumber)` Retrieve a baseline budget cost.
`Duration`	`getBaselineBudgetWork()` Retrieve the baseline budget work.
`Duration`	`getBaselineBudgetWork(int baselineNumber)` Retrieve a baseline budget work.
`Number`	`getBaselineCost()` Retrieves the Baseline Cost value.
`Number`	`getBaselineCost(int baselineNumber)` Retrieve a baseline value.
`Duration`	`getBaselineWork()` Retrieves the Baseline Work value.
`Duration`	`getBaselineWork(int baselineNumber)` Retrieve a baseline value.
`Number`	`getBCWP()` Retrieves the budgeted cost of work performed.
`Number`	`getBCWS()` Retrieves the budgeted cost of work scheduled.
`BookingType`	`getBookingType()` Retrieves the booking type.
`boolean`	`getBudget()` Retrieve the budget flag.
`Number`	`getBudgetCost()` Retrieve the budget cost.
`Duration`	`getBudgetWork()` Retrieve the budget work.
`boolean`	`getCalculateCostsFromUnits()` Retrieve the calculate costs from units flag.
`protected Function<Resource,Object>`	`getCalculationMethod(FieldType field)` Retrieve the method used to calculate the value of the supplied field.
`ProjectCalendar`	`getCalendar()` This method retrieves the calendar associated with this resource.
`Integer`	`getCalendarUniqueID()` Retrieve the calendar unique ID.
`boolean`	`getCanLevel()` Retrieves the flag indicating if the resource levelling can be applied to this resource.
`List<Resource>`	`getChildResources()` Retrieve a list of child resources held by this object.
`String`	`getCode()` Gets code field value.
`Number`	`getCost()` Retrieves the cost field value.
`Number`	`getCost(int index)` Retrieve a cost value.
`String`	`getCostCenter()` Retrieve the cost center.
`Number`	`getCostPerUse()` Retrieve the cost per use.
`CostRateTable`	`getCostRateTable(int index)` Retrieves a cost rate table associated with a resource.
`Number`	`getCostVariance()` Retrieves the cost variance.
`LocalDateTime`	`getCreationDate()` Retrieves the creation date.
`Availability`	`getCurrentAvailabilityTableEntry()` Retrieve the availability table entry effective for the current date.
`CostRateTableEntry`	`getCurrentCostRateTableEntry(int costRateTable)` Retrieve the cost rate table entry effective for the current date.
`Number`	`getCV()` Retrieve the cost variance.
`LocalDateTime`	`getDate(int index)` Retrieve a date value.
`Number`	`getDefaultUnits()` Retrieves the default availability of a resource.
`String`	`getDescription()` Retrieve the description field.
`Duration`	`getDuration(int index)` Retrieve a duration value.
`String`	`getEmailAddress()` Retrieves the resource's email address.
`boolean`	`getEnterprise()` Retrieves a flag indicating that a resource is an enterprise resource.
`Number`	`getEnterpriseCost(int index)` Retrieve an enterprise field value.
`LocalDateTime`	`getEnterpriseDate(int index)` Retrieve an enterprise field value.
`Duration`	`getEnterpriseDuration(int index)` Retrieve an enterprise field value.
`boolean`	`getEnterpriseFlag(int index)` Retrieve an enterprise field value.
`Number`	`getEnterpriseNumber(int index)` Retrieve an enterprise field value.
`String`	`getEnterpriseText(int index)` Retrieve an enterprise field value.
`boolean`	`getExpensesOnly()` Retrieve the expenses only field.
`Object`	`getFieldByAlias(String alias)` Retrieve the value of a field using its alias.
`LocalDateTime`	`getFinish()` Retrieves the latest finish date for all assigned tasks.
`LocalDateTime`	`getFinish(int index)` Retrieve a finish value.
`boolean`	`getFlag(int index)` Retrieve a flag value.
`boolean`	`getGeneric()` Retrieves the generic flag.
`String`	`getGroup()` Gets Group field value.
`UUID`	`getGUID()` Retrieves the resource GUID.
`String`	`getHyperlink()` Retrieves the hyperlink text.
`String`	`getHyperlinkAddress()` Retrieves the hyperlink address.
`String`	`getHyperlinkScreenTip()` Retrieves the hyperlink screen tip attribute.
`String`	`getHyperlinkSubAddress()` Retrieves the hyperlink sub-address.
`Integer`	`getID()` Gets ID field value.
`String`	`getInitials()` Gets Initials of name field value.
`boolean`	`getLinkedFields()` Gets Linked Fields field value.
`Location`	`getLocation()` Retrieves the location.
`Integer`	`getLocationUniqueID()` Retrieves the location unique ID.
`String`	`getMaterialLabel()` Retrieves the units label for a material resource.
`Number`	`getMaxUnits()` Retrieves the maximum availability of a resource on the current date.
`boolean`	`getModifyOnIntegrate()` Retrieve the modify on integrate value.
`String`	`getName()` Gets Resource Name field value.
`String`	`getNotes()` Retrieve the plain text representation of the resource notes.
`Notes`	`getNotesObject()` Retrieve an object which contains both the plain text notes and, if relevant, the original formatted version of the notes.
`String`	`getNtAccount()` Retrieves the Windows account name for a resource.
`boolean`	`getNull()` Retrieve a flag indicating if this is a null resource.
`Number`	`getNumber(int index)` Retrieve a number value.
`Integer`	`getObjects()` Gets objects field value.
`String`	`getOutlineCode(int index)` Retrieve an outline code value.
`boolean`	`getOverAllocated()` Retrieves the overallocated flag.
`Number`	`getOvertimeCost()` Retrieve the value of the overtime cost field.
`Rate`	`getOvertimeRate()` Retrieves the overtime rate for this resource.
`Duration`	`getOvertimeWork()` Retrieves the amount of overtime work.
`ProjectFile`	`getParentFile()` Accessor method allowing retrieval of ProjectFile reference.
`Resource`	`getParentResource()` Retrieve the parent resource.
`Integer`	`getParentResourceUniqueID()` Retrieve the parent resource's Unique ID.
`Number`	`getPeakUnits()` Retrieves the peak resource utilisation.
`Number`	`getPercentWorkComplete()` Retrieves the value of the percent work complete field.
`Number`	`getPerDay()` Retrieve the per day field.
`Number`	`getPeriodDur()` Retrieve the period dur field.
`String`	`getPhone()` Retrieve the phone field.
`String`	`getPhonetics()` Retrieves phonetic information for the Japanese version of MS Project.
`Number`	`getPool()` Retrieve the pool field.
`Resource`	`getPrimaryRole()` Retrieves the primary role.
`Integer`	`getPrimaryRoleUniqueID()` Retrieves the primary role unique ID.
`Number`	`getPriority()` Retrieve the priority field.
`Number`	`getRate()` Retrieve the rate field.
`Duration`	`getRegularWork()` Retrieve the value of the regular work field.
`Number`	`getRemainingCost()` Retrieves the remaining cost for this resource.
`Number`	`getRemainingOvertimeCost()` Retrieve the remaining overtime cost.
`Duration`	`getRemainingOvertimeWork()` Retrieve the value of the remaining overtime work field.
`Duration`	`getRemainingWork()` Gets Remaining Work field value.
`String`	`getResourceID()` Retrieve the resource ID field.
`boolean`	`getRole()` Retrieve the role field.
`Map<Resource,SkillLevel>`	`getRoleAssignments()` Retrieve a map of the roles assigned to this resource.
`Integer`	`getSequenceNumber()` Retrieve this resource's sequence number.
`Shift`	`getShift()` Retrieves the shift.
`Integer`	`getShiftUniqueID()` Retrieves the shift unique ID.
`Rate`	`getStandardRate()` Gets Standard Rate field value.
`LocalDateTime`	`getStart()` Retrieves the earliest start date for all assigned tasks.
`LocalDateTime`	`getStart(int index)` Retrieve a start value.
`Integer`	`getSubprojectResourceUniqueID()` Where a resource in an MPP file represents a resource from a subproject, this value will be non-zero.
`String`	`getSupplyReference()` Retrieve the supply reference field.
`Number`	`getSV()` Retrieve the schedule variance.
`List<ResourceAssignment>`	`getTaskAssignments()` Retrieve a list of tasks assigned to this resource.
`String`	`getText(int index)` Retrieve a text value.
`ResourceType`	`getType()` Retrieves the resource type.
`Integer`	`getUniqueID()` Gets Unique ID field value.
`String`	`getUnit()` Retrieve the unit field.
`UnitOfMeasure`	`getUnitOfMeasure()` Retrieves the unit of measure for this resource.
`Integer`	`getUnitOfMeasureUniqueID()` Retrieve the unit of measure unique ID.
`Duration`	`getWork()` Gets Work field value.
`WorkGroup`	`getWorkGroup()` Retrieve the messaging method used to communicate with a project team.
`Duration`	`getWorkVariance()` Retrieves the work variance.
`protected void`	`handleFieldChange(FieldType field, Object oldValue, Object newValue)` Clear any cached calculated values which will be affected by this change.
`int`	`hashCode()`
`void`	`remove()` Removes this resource from the project.
`void`	`removeChildResource(Resource child)` Removes a child resource.
`void`	`removeRoleAssignment(Resource role)` Remove a role assignment from this resource.
`void`	`setAccrueAt(AccrueType type)` Sets the Accrue at type.The Accrue At field provides choices for how and when resource standard and overtime costs are to be charged, or accrued, to the cost of a task.
`void`	`setActive(boolean value)` Sets the active flag.
`void`	`setActiveDirectoryGUID(String guid)` Sets the active directory GUID for this resource.
`void`	`setActualCost(Number actualCost)` Set the actual cost for the work already performed by this resource.
`void`	`setActualOvertimeCost(Number actualOvertimeCost)` Sets the actual overtime cost.
`void`	`setActualOvertimeWork(Duration duration)` Sets the value of the actual overtime work field.
`void`	`setActualOvertimeWorkProtected(Duration duration)` Sets the actual overtime work protected duration.
`void`	`setActualWork(Duration val)` Sets the Actual Work field contains the amount of work that has already been done for all assignments assigned to a resource.
`void`	`setActualWorkProtected(Duration duration)` Sets the actual work protected duration.
`void`	`setACWP(Number acwp)` Set the actual cost of work performed.
`void`	`setBaseCalendar(String val)` Sets the Base Calendar field indicates which calendar is the base calendar for a resource calendar.
`void`	`setBaselineBudgetCost(int baselineNumber, Number value)` Set a baseline budget cost.
`void`	`setBaselineBudgetCost(Number value)` Set the baseline budget cost.
`void`	`setBaselineBudgetWork(Duration value)` Set the baseline budget work.
`void`	`setBaselineBudgetWork(int baselineNumber, Duration value)` Set a baseline budget work.
`void`	`setBaselineCost(int baselineNumber, Number value)` Set a baseline value.
`void`	`setBaselineCost(Number val)` Sets the baseline cost.
`void`	`setBaselineWork(Duration val)` Sets the baseline work duration.
`void`	`setBaselineWork(int baselineNumber, Duration value)` Set a baseline value.
`void`	`setBCWP(Number bcwp)` Sets the budgeted cost of work performed.
`void`	`setBCWS(Number bcws)` Sets the budgeted cost of work scheduled.
`void`	`setBookingType(BookingType bookingType)` Sets the booking type.
`void`	`setBudget(boolean budget)` Set the budget flag.
`void`	`setBudgetCost(Number value)` Set the budget cost.
`void`	`setBudgetWork(Duration value)` Set the budget work.
`void`	`setCalculateCostsFromUnits(boolean calculateCostsFromUnits)` Set the calculate costs from units flag.
`void`	`setCalendar(ProjectCalendar calendar)` This method allows a pre-existing resource calendar to be attached to a resource.
`void`	`setCalendarUniqueID(Integer id)` Set the calendar unique ID.
`void`	`setCanLevel(boolean canLevel)` Sets the flag indicating if the resource levelling can be applied to this resource.
`void`	`setCode(String val)` Sets code field value.
`void`	`setCost(int index, Number value)` Set a cost value.
`void`	`setCost(Number cost)` Sets the cost field value.
`void`	`setCostCenter(String value)` Set the cost center.
`void`	`setCostRateTable(int index, CostRateTable crt)` Associates a complete cost rate table with the current resource.
`void`	`setCostVariance(Number costVariance)` Sets the cost variance.
`void`	`setCreationDate(LocalDateTime creationDate)` Sets the creation date.
`void`	`setCV(Number cv)` Set the cost variance.
`void`	`setDate(int index, LocalDateTime value)` Set a date value.
`void`	`setDefaultUnits(Number defaultUnits)` Sets the default availability of a resource.
`void`	`setDescription(String value)` Set the description field.
`void`	`setDuration(int index, Duration value)` Set a duration value.
`void`	`setEmailAddress(String emailAddress)` Set the resource's email address.
`void`	`setEnterprise(boolean enterprise)` Sets a flag indicating that a resource is an enterprise resource.
`void`	`setEnterpriseCost(int index, Number value)` Set an enterprise field value.
`void`	`setEnterpriseDate(int index, LocalDateTime value)` Set an enterprise field value.
`void`	`setEnterpriseDuration(int index, Duration value)` Set an enterprise field value.
`void`	`setEnterpriseFlag(int index, boolean value)` Set an enterprise field value.
`void`	`setEnterpriseNumber(int index, Number value)` Set an enterprise field value.
`void`	`setEnterpriseText(int index, String value)` Set an enterprise field value.
`void`	`setExpensesOnly(boolean value)` Set the expenses only field.
`void`	`setFieldByAlias(String alias, Object value)` Set the value of a field using its alias.
`void`	`setFinish(int index, LocalDateTime value)` Set a finish value.
`void`	`setFlag(int index, boolean value)` Set a flag value.
`void`	`setGeneric(boolean value)` Sets the generic flag.
`void`	`setGroup(String val)` Sets Group field value.
`void`	`setGUID(UUID value)` Sets the resource GUID.
`void`	`setHyperlink(String hyperlink)` Sets the hyperlink text.
`void`	`setHyperlinkAddress(String hyperlinkAddress)` Sets the hyperlink address.
`void`	`setHyperlinkScreenTip(String text)` Sets the hyperlink screen tip attribute.
`void`	`setHyperlinkSubAddress(String hyperlinkSubAddress)` Sets the hyperlink sub-address.
`void`	`setID(Integer val)` Sets ID field value.
`void`	`setInitials(String val)` Sets Initials field value.
`void`	`setIsNull(boolean isNull)` Set the flag indicating that this is a null resource.
`void`	`setLinkedFields(boolean val)` This field is ignored on import into MS Project.
`void`	`setLocation(Location location)` Sets the location.
`void`	`setLocationUniqueID(Integer uniqueID)` Sets the location unique ID.
`void`	`setModifyOnIntegrate(boolean value)` Set the modify on integrate field.
`void`	`setName(String val)` Sets Name field value.
`void`	`setNotes(String notes)` Sets the notes text for this resource.
`void`	`setNotesObject(Notes notes)` Set the Notes instance representing the resource notes.
`void`	`setNtAccount(String ntAccount)` Sets the Windows account name for a resource.
`void`	`setNumber(int index, Number value)` Set a number value.
`void`	`setObjects(Integer val)` Set objects.
`void`	`setOutlineCode(int index, String value)` Set an outline code value.
`void`	`setOverAllocated(boolean overallocated)` Set the overallocated flag.
`void`	`setOvertimeCost(Number currency)` Set the value of the overtime cost field.
`void`	`setOvertimeWork(Duration overtimeWork)` Sets the amount of overtime work.
`void`	`setParentResource(Resource resource)` Set the parent resource.
`void`	`setParentResourceUniqueID(Integer id)` Sets the parent resource's Unique ID.
`void`	`setPeakUnits(Number peakUnits)` Sets peak resource utilisation.
`void`	`setPercentWorkComplete(Number percentWorkComplete)` Sets the value of the percent work complete field.
`void`	`setPerDay(Number value)` Set the per day field.
`void`	`setPeriodDur(Number value)` Set the period dur field.
`void`	`setPhone(String value)` Set the phone field.
`void`	`setPhonetics(String phonetics)` Sets phonetic information for the Japanese version of MS Project.
`void`	`setPool(Number value)` Set the pool field.
`void`	`setPrimaryRole(Resource role)` Sets the primary role.
`void`	`setPrimaryRoleUniqueID(Integer uniqueID)` Sets the primary role unique ID.
`void`	`setPriority(Number value)` Set the priority field.
`void`	`setRate(Number value)` Set the rate field.
`void`	`setRegularWork(Duration duration)` Set the value of the regular work field.
`void`	`setRemainingCost(Number remainingCost)` Sets the remaining cost for this resource.
`void`	`setRemainingOvertimeCost(Number remainingOvertimeCost)` Set the remaining overtime cost.
`void`	`setRemainingOvertimeWork(Duration duration)` Sets the value of the remaining overtime work field.
`void`	`setRemainingWork(Duration val)` This field is ignored on import into MS Project.
`void`	`setResourceID(String value)` Set the resource ID field.
`void`	`setRole(boolean value)` Set the role field.
`void`	`setSequenceNumber(Integer sequenceNumber)` Set this resource's sequence number.
`void`	`setShift(Shift shift)` Sets the shift.
`void`	`setShiftUniqueID(Integer uniqueID)` Sets the shift unique ID.
`void`	`setStart(int index, LocalDateTime value)` Set a start value.
`void`	`setSubprojectResourceUniqueID(Integer subprojectUniqueResourceID)` Sets the sub project unique resource ID.
`void`	`setSupplyReference(String value)` Set the supply reference field.
`void`	`setSV(Number sv)` Set the schedule variance.
`void`	`setText(int index, String value)` Set a text value.
`void`	`setType(ResourceType type)` Set the resource type.
`void`	`setUniqueID(Integer val)` Sets Unique ID of this resource.
`void`	`setUnit(String value)` Set the unit field.
`void`	`setUnitOfMeasure(UnitOfMeasure unitOfMeasure)` Sets the unit of measure instance for this resource.
`void`	`setUnitOfMeasureUniqueID(Integer uniqueID)` Sets the unit of measure unique ID.
`void`	`setWork(Duration val)` This field is ignored on import into MS Project.
`void`	`setWorkGroup(WorkGroup workGroup)` Set the messaging method used to communicate with a project team.
`void`	`setWorkVariance(Duration workVariance)` Sets the work variance.
`String`	`toString()`

Methods inherited from class net.sf.mpxj.AbstractFieldContainer
addFieldListener, disableEvents, enableEvents, get, getCachedValue, removeFieldListener, set

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - addResource
```
public Resource addResource()
```
    Description copied from interface: ChildResourceContainer
    
    Creates and adds a resource to the list of resources held by this object.
    
    Specified by:
    
    addResource in interface ChildResourceContainer
    
    Returns:
    
    newly created resource
  - addChildResource
```
public void addChildResource(Resource child)
```
    Add an existing resource as a child of the current resource.
    
    Parameters:
    
    child - child resource
  - getChildResources
```
public List<Resource> getChildResources()
```
    Description copied from interface: ChildResourceContainer
    
    Retrieve a list of child resources held by this object.
    
    Specified by:
    
    getChildResources in interface ChildResourceContainer
    
    Returns:
    
    list of child resources
  - removeChildResource
```
public void removeChildResource(Resource child)
```
    Removes a child resource.
    
    Parameters:
    
    child - child resource instance
  - setName
```
public void setName(String val)
```
    Sets Name field value.
    
    Parameters:
    
    val - value
  - getName
```
public String getName()
```
    Gets Resource Name field value.
    
    Returns:
    
    value
  - setType
```
public void setType(ResourceType type)
```
    Set the resource type. Can be TYPE_MATERIAL, or TYPE_WORK.
    
    Parameters:
    
    type - resource type
  - getType
```
public ResourceType getType()
```
    Retrieves the resource type. Can return TYPE_MATERIAL, or TYPE_WORK.
    
    Returns:
    
    resource type
  - setIsNull
```
public void setIsNull(boolean isNull)
```
    Set the flag indicating that this is a null resource.
    
    Parameters:
    
    isNull - null resource flag
  - getNull
```
public boolean getNull()
```
    Retrieve a flag indicating if this is a null resource.
    
    Returns:
    
    boolean flag
  - setInitials
```
public void setInitials(String val)
```
    Sets Initials field value.
    
    Parameters:
    
    val - value
  - getInitials
```
public String getInitials()
```
    Gets Initials of name field value.
    
    Returns:
    
    value
  - setPhonetics
```
public void setPhonetics(String phonetics)
```
    Sets phonetic information for the Japanese version of MS Project.
    
    Parameters:
    
    phonetics - Japanese phonetic information
  - getPhonetics
```
public String getPhonetics()
```
    Retrieves phonetic information for the Japanese version of MS Project.
    
    Returns:
    
    Japanese phonetic information
  - setNtAccount
```
public void setNtAccount(String ntAccount)
```
    Sets the Windows account name for a resource.
    
    Parameters:
    
    ntAccount - windows account name
  - getNtAccount
```
public String getNtAccount()
```
    Retrieves the Windows account name for a resource.
    
    Returns:
    
    windows account name
  - getMaterialLabel
```
public String getMaterialLabel()
```
    Retrieves the units label for a material resource.
    
    Returns:
    
    material resource units label
  - setCode
```
public void setCode(String val)
```
    Sets code field value.
    
    Parameters:
    
    val - value
  - getCode
```
public String getCode()
```
    Gets code field value.
    
    Returns:
    
    value
  - setGroup
```
public void setGroup(String val)
```
    Sets Group field value.
    
    Parameters:
    
    val - value
  - getGroup
```
public String getGroup()
```
    Gets Group field value.
    
    Returns:
    
    value
  - setWorkGroup
```
public void setWorkGroup(WorkGroup workGroup)
```
    Set the messaging method used to communicate with a project team.
    
    Parameters:
    
    workGroup - messaging method
  - getWorkGroup
```
public WorkGroup getWorkGroup()
```
    Retrieve the messaging method used to communicate with a project team.
    
    Returns:
    
    messaging method
  - setEmailAddress
```
public void setEmailAddress(String emailAddress)
```
    Set the resource's email address.
    
    Parameters:
    
    emailAddress - email address
  - getEmailAddress
```
public String getEmailAddress()
```
    Retrieves the resource's email address.
    
    Returns:
    
    email address
  - setHyperlink
```
public void setHyperlink(String hyperlink)
```
    Sets the hyperlink text.
    
    Parameters:
    
    hyperlink - hyperlink text
  - getHyperlink
```
public String getHyperlink()
```
    Retrieves the hyperlink text.
    
    Returns:
    
    hyperlink text
  - setHyperlinkAddress
```
public void setHyperlinkAddress(String hyperlinkAddress)
```
    Sets the hyperlink address.
    
    Parameters:
    
    hyperlinkAddress - hyperlink address
  - getHyperlinkAddress
```
public String getHyperlinkAddress()
```
    Retrieves the hyperlink address.
    
    Returns:
    
    hyperlink address
  - setHyperlinkSubAddress
```
public void setHyperlinkSubAddress(String hyperlinkSubAddress)
```
    Sets the hyperlink sub-address.
    
    Parameters:
    
    hyperlinkSubAddress - hyperlink sub-address
  - getHyperlinkSubAddress
```
public String getHyperlinkSubAddress()
```
    Retrieves the hyperlink sub-address.
    
    Returns:
    
    hyperlink sub-address
  - setHyperlinkScreenTip
```
public void setHyperlinkScreenTip(String text)
```
    Sets the hyperlink screen tip attribute.
    
    Parameters:
    
    text - hyperlink screen tip attribute
  - getHyperlinkScreenTip
```
public String getHyperlinkScreenTip()
```
    Retrieves the hyperlink screen tip attribute.
    
    Returns:
    
    hyperlink screen tip attribute
  - setDefaultUnits
```
public void setDefaultUnits(Number defaultUnits)
```
    Sets the default availability of a resource.
    
    Parameters:
    
    defaultUnits - default availability
  - getDefaultUnits
```
public Number getDefaultUnits()
```
    Retrieves the default availability of a resource.
    
    Returns:
    
    maximum availability
  - getMaxUnits
```
public Number getMaxUnits()
```
    Retrieves the maximum availability of a resource on the current date. Refer to the availability table to retrieve this value for other dates.
    
    Returns:
    
    maximum availability
  - setPeakUnits
```
public void setPeakUnits(Number peakUnits)
```
    Sets peak resource utilisation.
    
    Parameters:
    
    peakUnits - peak resource utilisation
  - getPeakUnits
```
public Number getPeakUnits()
```
    Retrieves the peak resource utilisation.
    
    Returns:
    
    peak resource utilisation
  - setOverAllocated
```
public void setOverAllocated(boolean overallocated)
```
    Set the overallocated flag.
    
    Parameters:
    
    overallocated - overallocated flag
  - getOverAllocated
```
public boolean getOverAllocated()
```
    Retrieves the overallocated flag.
    
    Returns:
    
    overallocated flag
  - getAvailableFrom
```
public LocalDateTime getAvailableFrom()
```
    Retrieves the "available from" date.
    
    Returns:
    
    available from date
  - getAvailableTo
```
public LocalDateTime getAvailableTo()
```
    Retrieves the "available to" date.
    
    Returns:
    
    available from date
  - getStart
```
public LocalDateTime getStart()
```
    Retrieves the earliest start date for all assigned tasks.
    
    Returns:
    
    start date
  - getFinish
```
public LocalDateTime getFinish()
```
    Retrieves the latest finish date for all assigned tasks.
    
    Returns:
    
    finish date
  - setCanLevel
```
public void setCanLevel(boolean canLevel)
```
    Sets the flag indicating if the resource levelling can be applied to this resource.
    
    Parameters:
    
    canLevel - boolean flag
  - getCanLevel
```
public boolean getCanLevel()
```
    Retrieves the flag indicating if the resource levelling can be applied to this resource.
    
    Returns:
    
    boolean flag
  - setAccrueAt
```
public void setAccrueAt(AccrueType type)
```
    Sets the Accrue at type.The Accrue At field provides choices for how and when resource standard and overtime costs are to be charged, or accrued, to the cost of a task. The options are: Start, End and Prorated (Default)
    
    Parameters:
    
    type - accrue type
  - getAccrueAt
```
public AccrueType getAccrueAt()
```
    Gets the Accrue at type.The Accrue At field provides choices for how and when resource standard and overtime costs are to be charged, or accrued, to the cost of a task. The options are: Start, End and Prorated (Default)
    
    Returns:
    
    accrue type
  - setWork
```
public void setWork(Duration val)
```
    This field is ignored on import into MS Project.
    
    Parameters:
    
    val - - value to be set
  - getWork
```
public Duration getWork()
```
    Gets Work field value.
    
    Returns:
    
    value
  - getRegularWork
```
public Duration getRegularWork()
```
    Retrieve the value of the regular work field. Note that this value is an extension to the MPX specification.
    
    Returns:
    
    Regular work value
  - setRegularWork
```
public void setRegularWork(Duration duration)
```
    Set the value of the regular work field. Note that this value is an extension to the MPX specification.
    
    Parameters:
    
    duration - Regular work value
  - setActualWork
```
public void setActualWork(Duration val)
```
    Sets the Actual Work field contains the amount of work that has already been done for all assignments assigned to a resource.
    
    Parameters:
    
    val - duration value
  - getActualWork
```
public Duration getActualWork()
```
    Retrieves the Actual Work field contains the amount of work that has already been done for all assignments assigned to a resource.
    
    Returns:
    
    Actual work value
  - setOvertimeWork
```
public void setOvertimeWork(Duration overtimeWork)
```
    Sets the amount of overtime work.
    
    Parameters:
    
    overtimeWork - overtime work
  - getOvertimeWork
```
public Duration getOvertimeWork()
```
    Retrieves the amount of overtime work.
    
    Returns:
    
    overtime work
  - setRemainingWork
```
public void setRemainingWork(Duration val)
```
    This field is ignored on import into MS Project.
    
    Parameters:
    
    val - - value to be set
  - getRemainingWork
```
public Duration getRemainingWork()
```
    Gets Remaining Work field value.
    
    Returns:
    
    value
  - getActualOvertimeWork
```
public Duration getActualOvertimeWork()
```
    Retrieve the value of the actual overtime work field.
    
    Returns:
    
    actual overtime work value
  - setActualOvertimeWork
```
public void setActualOvertimeWork(Duration duration)
```
    Sets the value of the actual overtime work field.
    
    Parameters:
    
    duration - actual overtime work value
  - getRemainingOvertimeWork
```
public Duration getRemainingOvertimeWork()
```
    Retrieve the value of the remaining overtime work field.
    
    Returns:
    
    remaining overtime work value
  - setRemainingOvertimeWork
```
public void setRemainingOvertimeWork(Duration duration)
```
    Sets the value of the remaining overtime work field.
    
    Parameters:
    
    duration - remaining overtime work value
  - setPercentWorkComplete
```
public void setPercentWorkComplete(Number percentWorkComplete)
```
    Sets the value of the percent work complete field.
    
    Parameters:
    
    percentWorkComplete - percent work complete
  - getPercentWorkComplete
```
public Number getPercentWorkComplete()
```
    Retrieves the value of the percent work complete field.
    
    Returns:
    
    percent work complete
  - getStandardRate
```
public Rate getStandardRate()
```
    Gets Standard Rate field value.
    
    Returns:
    
    Rate
  - setCost
```
public void setCost(Number cost)
```
    Sets the cost field value.
    
    Parameters:
    
    cost - cost field value
  - getCost
```
public Number getCost()
```
    Retrieves the cost field value.
    
    Returns:
    
    cost field value
  - getOvertimeRate
```
public Rate getOvertimeRate()
```
    Retrieves the overtime rate for this resource.
    
    Returns:
    
    overtime rate
  - getOvertimeCost
```
public Number getOvertimeCost()
```
    Retrieve the value of the overtime cost field.
    
    Returns:
    
    Overtime cost value
  - setOvertimeCost
```
public void setOvertimeCost(Number currency)
```
    Set the value of the overtime cost field.
    
    Parameters:
    
    currency - Overtime cost
  - getCostPerUse
```
public Number getCostPerUse()
```
    Retrieve the cost per use.
    
    Returns:
    
    cost per use
  - setActualCost
```
public void setActualCost(Number actualCost)
```
    Set the actual cost for the work already performed by this resource.
    
    Parameters:
    
    actualCost - actual cost
  - getActualCost
```
public Number getActualCost()
```
    Retrieves the actual cost for the work already performed by this resource.
    
    Returns:
    
    actual cost
  - getActualOvertimeCost
```
public Number getActualOvertimeCost()
```
    Retrieve actual overtime cost.
    
    Returns:
    
    actual overtime cost
  - setActualOvertimeCost
```
public void setActualOvertimeCost(Number actualOvertimeCost)
```
    Sets the actual overtime cost.
    
    Parameters:
    
    actualOvertimeCost - actual overtime cost
  - setRemainingCost
```
public void setRemainingCost(Number remainingCost)
```
    Sets the remaining cost for this resource.
    
    Parameters:
    
    remainingCost - remaining cost
  - getRemainingCost
```
public Number getRemainingCost()
```
    Retrieves the remaining cost for this resource.
    
    Returns:
    
    remaining cost
  - getRemainingOvertimeCost
```
public Number getRemainingOvertimeCost()
```
    Retrieve the remaining overtime cost.
    
    Returns:
    
    remaining overtime cost
  - setRemainingOvertimeCost
```
public void setRemainingOvertimeCost(Number remainingOvertimeCost)
```
    Set the remaining overtime cost.
    
    Parameters:
    
    remainingOvertimeCost - remaining overtime cost
  - setWorkVariance
```
public void setWorkVariance(Duration workVariance)
```
    Sets the work variance.
    
    Parameters:
    
    workVariance - work variance
  - getWorkVariance
```
public Duration getWorkVariance()
```
    Retrieves the work variance.
    
    Returns:
    
    work variance
  - setCostVariance
```
public void setCostVariance(Number costVariance)
```
    Sets the cost variance.
    
    Parameters:
    
    costVariance - cost variance
  - getCostVariance
```
public Number getCostVariance()
```
    Retrieves the cost variance.
    
    Returns:
    
    cost variance
  - setSV
```
public void setSV(Number sv)
```
    Set the schedule variance.
    
    Parameters:
    
    sv - schedule variance
  - getSV
```
public Number getSV()
```
    Retrieve the schedule variance.
    
    Returns:
    
    schedule variance
  - setCV
```
public void setCV(Number cv)
```
    Set the cost variance.
    
    Parameters:
    
    cv - cost variance
  - getCV
```
public Number getCV()
```
    Retrieve the cost variance.
    
    Returns:
    
    cost variance
  - setACWP
```
public void setACWP(Number acwp)
```
    Set the actual cost of work performed.
    
    Parameters:
    
    acwp - actual cost of work performed
  - getACWP
```
public Number getACWP()
```
    Set the actual cost of work performed.
    
    Returns:
    
    actual cost of work performed
  - setNotes
```
public void setNotes(String notes)
```
    Sets the notes text for this resource.
    
    Parameters:
    
    notes - notes to be added
  - getNotes
```
public String getNotes()
```
    Retrieve the plain text representation of the resource notes. Use the getNotesObject method to retrieve an object which contains both the plain text notes and, if relevant, the original formatted version of the notes.
    
    Returns:
    
    notes
  - setNotesObject
```
public void setNotesObject(Notes notes)
```
    Set the Notes instance representing the resource notes.
    
    Parameters:
    
    notes - Notes instance
  - getNotesObject
```
public Notes getNotesObject()
```
    Retrieve an object which contains both the plain text notes and, if relevant, the original formatted version of the notes.
    
    Returns:
    
    Notes instance
  - setBCWS
```
public void setBCWS(Number bcws)
```
    Sets the budgeted cost of work scheduled.
    
    Parameters:
    
    bcws - budgeted cost of work scheduled
  - getBCWS
```
public Number getBCWS()
```
    Retrieves the budgeted cost of work scheduled.
    
    Returns:
    
    budgeted cost of work scheduled
  - setBCWP
```
public void setBCWP(Number bcwp)
```
    Sets the budgeted cost of work performed.
    
    Parameters:
    
    bcwp - budgeted cost of work performed
  - getBCWP
```
public Number getBCWP()
```
    Retrieves the budgeted cost of work performed.
    
    Returns:
    
    budgeted cost of work performed
  - setGeneric
```
public void setGeneric(boolean value)
```
    Sets the generic flag.
    
    Parameters:
    
    value - generic flag
  - getGeneric
```
public boolean getGeneric()
```
    Retrieves the generic flag.
    
    Returns:
    
    generic flag
  - setActive
```
public void setActive(boolean value)
```
    Sets the active flag.
    
    Parameters:
    
    value - generic flag
  - getActive
```
public boolean getActive()
```
    Retrieves the active flag.
    
    Returns:
    
    generic flag
  - setActiveDirectoryGUID
```
public void setActiveDirectoryGUID(String guid)
```
    Sets the active directory GUID for this resource.
    
    Parameters:
    
    guid - active directory GUID
  - getActiveDirectoryGUID
```
public String getActiveDirectoryGUID()
```
    Retrieves the active directory GUID for this resource.
    
    Returns:
    
    active directory GUID
  - setActualOvertimeWorkProtected
```
public void setActualOvertimeWorkProtected(Duration duration)
```
    Sets the actual overtime work protected duration.
    
    Parameters:
    
    duration - actual overtime work protected
  - getActualOvertimeWorkProtected
```
public Duration getActualOvertimeWorkProtected()
```
    Retrieves the actual overtime work protected duration.
    
    Returns:
    
    actual overtime work protected
  - setActualWorkProtected
```
public void setActualWorkProtected(Duration duration)
```
    Sets the actual work protected duration.
    
    Parameters:
    
    duration - actual work protected
  - getActualWorkProtected
```
public Duration getActualWorkProtected()
```
    Retrieves the actual work protected duration.
    
    Returns:
    
    actual work protected
  - setBookingType
```
public void setBookingType(BookingType bookingType)
```
    Sets the booking type.
    
    Parameters:
    
    bookingType - booking type
  - getBookingType
```
public BookingType getBookingType()
```
    Retrieves the booking type.
    
    Returns:
    
    booking type
  - setCreationDate
```
public void setCreationDate(LocalDateTime creationDate)
```
    Sets the creation date.
    
    Parameters:
    
    creationDate - creation date
  - getCreationDate
```
public LocalDateTime getCreationDate()
```
    Retrieves the creation date.
    
    Returns:
    
    creation date
  - setEnterprise
```
public void setEnterprise(boolean enterprise)
```
    Sets a flag indicating that a resource is an enterprise resource.
    
    Parameters:
    
    enterprise - boolean flag
  - getEnterprise
```
public boolean getEnterprise()
```
    Retrieves a flag indicating that a resource is an enterprise resource.
    
    Returns:
    
    boolean flag
  - getCalendarUniqueID
```
public Integer getCalendarUniqueID()
```
    Retrieve the calendar unique ID.
    
    Returns:
    
    calendar unique ID
  - setCalendarUniqueID
```
public void setCalendarUniqueID(Integer id)
```
    Set the calendar unique ID.
    
    Parameters:
    
    id - calendar unique ID
  - getCalendar
```
public ProjectCalendar getCalendar()
```
    This method retrieves the calendar associated with this resource.
    
    Returns:
    
    ProjectCalendar instance
  - setCalendar
```
public void setCalendar(ProjectCalendar calendar)
```
    This method allows a pre-existing resource calendar to be attached to a resource.
    
    Parameters:
    
    calendar - resource calendar
  - addCalendar
```
public ProjectCalendar addCalendar()
                            throws MPXJException
```
    This method allows a calendar to be added to a resource.
    
    Returns:
    
    ResourceCalendar
    
    Throws:
    
    MPXJException - if more than one calendar is added
  - setBaseCalendar
```
public void setBaseCalendar(String val)
```
    Sets the Base Calendar field indicates which calendar is the base calendar for a resource calendar. The list includes the three built-in calendars, as well as any new base calendars you have created in the Change Working Time dialog box.
    
    Parameters:
    
    val - calendar name
  - setBaselineCost
```
public void setBaselineCost(Number val)
```
    Sets the baseline cost. This field is ignored on import into MS Project
    
    Parameters:
    
    val - - value to be set
  - setBaselineWork
```
public void setBaselineWork(Duration val)
```
    Sets the baseline work duration. This field is ignored on import into MS Project.
    
    Parameters:
    
    val - - value to be set
  - setID
```
public void setID(Integer val)
```
    Sets ID field value.
    
    Specified by:
    
    setID in interface ProjectEntityWithID
    
    Parameters:
    
    val - value
  - setLinkedFields
```
public void setLinkedFields(boolean val)
```
    This field is ignored on import into MS Project.
    
    Parameters:
    
    val - - value to be set
  - setObjects
```
public void setObjects(Integer val)
```
    Set objects.
    
    Parameters:
    
    val - - value to be set
  - setText
```
public void setText(int index,
                    String value)
```
    Set a text value.
    
    Parameters:
    
    index - text index (1-30)
    
    value - text value
  - getText
```
public String getText(int index)
```
    Retrieve a text value.
    
    Parameters:
    
    index - text index (1-30)
    
    Returns:
    
    text value
  - setUniqueID
```
public void setUniqueID(Integer val)
```
    Sets Unique ID of this resource.
    
    Specified by:
    
    setUniqueID in interface ProjectEntityWithMutableUniqueID
    
    Parameters:
    
    val - Unique ID
  - getBaseCalendar
```
public String getBaseCalendar()
```
    Retrieves Base Calendar name associated with this resource. This field indicates which calendar is the base calendar for a resource calendar.
    
    Returns:
    
    Base calendar name
  - getBaselineCost
```
public Number getBaselineCost()
```
    Retrieves the Baseline Cost value. This value is the total planned cost for a resource for all assigned tasks. Baseline cost is also referred to as budget at completion (BAC).
    
    Returns:
    
    Baseline cost value
  - getBaselineWork
```
public Duration getBaselineWork()
```
    Retrieves the Baseline Work value.
    
    Returns:
    
    Baseline work value
  - getID
```
public Integer getID()
```
    Gets ID field value.
    
    Specified by:
    
    getID in interface ProjectEntityWithID
    
    Returns:
    
    value
  - getLinkedFields
```
public boolean getLinkedFields()
```
    Gets Linked Fields field value.
    
    Returns:
    
    value
  - getObjects
```
public Integer getObjects()
```
    Gets objects field value.
    
    Returns:
    
    value
  - getUniqueID
```
public Integer getUniqueID()
```
    Gets Unique ID field value.
    
    Specified by:
    
    getUniqueID in interface ProjectEntityWithUniqueID
    
    Returns:
    
    value
  - getParentResourceUniqueID
```
public Integer getParentResourceUniqueID()
```
    Retrieve the parent resource's Unique ID.
    
    Returns:
    
    parent resource Unique ID
  - setParentResourceUniqueID
```
public void setParentResourceUniqueID(Integer id)
```
    Sets the parent resource's Unique ID.
    
    Parameters:
    
    id - parent resource unique ID
  - getParentResource
```
public Resource getParentResource()
```
    Retrieve the parent resource.
    
    Returns:
    
    parent resource
  - setParentResource
```
public void setParentResource(Resource resource)
```
    Set the parent resource.
    
    Parameters:
    
    resource - parent resource
  - setStart
```
public void setStart(int index,
                     LocalDateTime value)
```
    Set a start value.
    
    Parameters:
    
    index - start index (1-10)
    
    value - start value
  - getStart
```
public LocalDateTime getStart(int index)
```
    Retrieve a start value.
    
    Parameters:
    
    index - start index (1-10)
    
    Returns:
    
    start value
  - setFinish
```
public void setFinish(int index,
                      LocalDateTime value)
```
    Set a finish value.
    
    Parameters:
    
    index - finish index (1-10)
    
    value - finish value
  - getFinish
```
public LocalDateTime getFinish(int index)
```
    Retrieve a finish value.
    
    Parameters:
    
    index - finish index (1-10)
    
    Returns:
    
    finish value
  - setNumber
```
public void setNumber(int index,
                      Number value)
```
    Set a number value.
    
    Parameters:
    
    index - number index (1-20)
    
    value - number value
  - getNumber
```
public Number getNumber(int index)
```
    Retrieve a number value.
    
    Parameters:
    
    index - number index (1-20)
    
    Returns:
    
    number value
  - setDuration
```
public void setDuration(int index,
                        Duration value)
```
    Set a duration value.
    
    Parameters:
    
    index - duration index (1-10)
    
    value - duration value
  - getDuration
```
public Duration getDuration(int index)
```
    Retrieve a duration value.
    
    Parameters:
    
    index - duration index (1-10)
    
    Returns:
    
    duration value
  - setDate
```
public void setDate(int index,
                    LocalDateTime value)
```
    Set a date value.
    
    Parameters:
    
    index - date index (1-10)
    
    value - date value
  - getDate
```
public LocalDateTime getDate(int index)
```
    Retrieve a date value.
    
    Parameters:
    
    index - date index (1-10)
    
    Returns:
    
    date value
  - setCost
```
public void setCost(int index,
                    Number value)
```
    Set a cost value.
    
    Parameters:
    
    index - cost index (1-10)
    
    value - cost value
  - getCost
```
public Number getCost(int index)
```
    Retrieve a cost value.
    
    Parameters:
    
    index - cost index (1-10)
    
    Returns:
    
    cost value
  - setFlag
```
public void setFlag(int index,
                    boolean value)
```
    Set a flag value.
    
    Parameters:
    
    index - flag index (1-20)
    
    value - flag value
  - getFlag
```
public boolean getFlag(int index)
```
    Retrieve a flag value.
    
    Parameters:
    
    index - flag index (1-20)
    
    Returns:
    
    flag value
  - setOutlineCode
```
public void setOutlineCode(int index,
                           String value)
```
    Set an outline code value.
    
    Parameters:
    
    index - outline code index (1-10)
    
    value - outline code value
  - getOutlineCode
```
public String getOutlineCode(int index)
```
    Retrieve an outline code value.
    
    Parameters:
    
    index - outline code index (1-10)
    
    Returns:
    
    outline code value
  - remove
```
public void remove()
```
    Removes this resource from the project.
  - getFieldByAlias
```
public Object getFieldByAlias(String alias)
```
    Retrieve the value of a field using its alias.
    
    Parameters:
    
    alias - field alias
    
    Returns:
    
    field value
  - setFieldByAlias
```
public void setFieldByAlias(String alias,
                            Object value)
```
    Set the value of a field using its alias.
    
    Parameters:
    
    alias - field alias
    
    value - field value
  - addResourceAssignment
```
public void addResourceAssignment(ResourceAssignment assignment)
```
    This method is used internally within MPXJ to track tasks which are assigned to a particular resource.
    
    Parameters:
    
    assignment - resource assignment instance
  - getTaskAssignments
```
public List<ResourceAssignment> getTaskAssignments()
```
    Retrieve a list of tasks assigned to this resource. Note that if this project data has been read from an MPX file which declared some or all of the resources assignments before the tasks and resources to which the assignments relate, then these assignments may not appear in this list. Caveat emptor!
    
    Returns:
    
    list of tasks assigned to this resource
  - addRoleAssignment
```
public void addRoleAssignment(Resource role,
                              SkillLevel skillLevel)
```
    Add a role assignment, and a skill level for the role, to this resource. Replaces any existing assignment for this role.
    
    Parameters:
    
    role - role to assign to the resource
    
    skillLevel - skill level
  - removeRoleAssignment
```
public void removeRoleAssignment(Resource role)
```
    Remove a role assignment from this resource.
    
    Parameters:
    
    role - role to remove
  - getRoleAssignments
```
public Map<Resource,SkillLevel> getRoleAssignments()
```
    Retrieve a map of the roles assigned to this resource. The roles are represented as the keys in this map with the skill level represented as the value.
    
    Returns:
    
    role assignment map
  - getSubprojectResourceUniqueID
```
public Integer getSubprojectResourceUniqueID()
```
    Where a resource in an MPP file represents a resource from a subproject, this value will be non-zero. The value itself is the unique ID value shown in the parent project. To retrieve the value of the resource unique ID in the child project, remove the top two bytes:
    resourceID = (subprojectUniqueID & 0xFFFF)
    
    Returns:
    
    sub project unique resource ID
  - setSubprojectResourceUniqueID
```
public void setSubprojectResourceUniqueID(Integer subprojectUniqueResourceID)
```
    Sets the sub project unique resource ID.
    
    Parameters:
    
    subprojectUniqueResourceID - subproject unique resource ID
  - getEnterpriseCost
```
public Number getEnterpriseCost(int index)
```
    Retrieve an enterprise field value.
    
    Parameters:
    
    index - field index
    
    Returns:
    
    field value
  - setEnterpriseCost
```
public void setEnterpriseCost(int index,
                              Number value)
```
    Set an enterprise field value.
    
    Parameters:
    
    index - field index
    
    value - field value
  - getEnterpriseDate
```
public LocalDateTime getEnterpriseDate(int index)
```
    Retrieve an enterprise field value.
    
    Parameters:
    
    index - field index
    
    Returns:
    
    field value
  - setEnterpriseDate
```
public void setEnterpriseDate(int index,
                              LocalDateTime value)
```
    Set an enterprise field value.
    
    Parameters:
    
    index - field index
    
    value - field value
  - getEnterpriseDuration
```
public Duration getEnterpriseDuration(int index)
```
    Retrieve an enterprise field value.
    
    Parameters:
    
    index - field index
    
    Returns:
    
    field value
  - setEnterpriseDuration
```
public void setEnterpriseDuration(int index,
                                  Duration value)
```
    Set an enterprise field value.
    
    Parameters:
    
    index - field index
    
    value - field value
  - getEnterpriseFlag
```
public boolean getEnterpriseFlag(int index)
```
    Retrieve an enterprise field value.
    
    Parameters:
    
    index - field index
    
    Returns:
    
    field value
  - setEnterpriseFlag
```
public void setEnterpriseFlag(int index,
                              boolean value)
```
    Set an enterprise field value.
    
    Parameters:
    
    index - field index
    
    value - field value
  - getEnterpriseNumber
```
public Number getEnterpriseNumber(int index)
```
    Retrieve an enterprise field value.
    
    Parameters:
    
    index - field index
    
    Returns:
    
    field value
  - setEnterpriseNumber
```
public void setEnterpriseNumber(int index,
                                Number value)
```
    Set an enterprise field value.
    
    Parameters:
    
    index - field index
    
    value - field value
  - getEnterpriseText
```
public String getEnterpriseText(int index)
```
    Retrieve an enterprise field value.
    
    Parameters:
    
    index - field index
    
    Returns:
    
    field value
  - setEnterpriseText
```
public void setEnterpriseText(int index,
                              String value)
```
    Set an enterprise field value.
    
    Parameters:
    
    index - field index
    
    value - field value
  - setBaselineCost
```
public void setBaselineCost(int baselineNumber,
                            Number value)
```
    Set a baseline value.
    
    Parameters:
    
    baselineNumber - baseline index (1-10)
    
    value - baseline value
  - setBaselineWork
```
public void setBaselineWork(int baselineNumber,
                            Duration value)
```
    Set a baseline value.
    
    Parameters:
    
    baselineNumber - baseline index (1-10)
    
    value - baseline value
  - getBaselineCost
```
public Number getBaselineCost(int baselineNumber)
```
    Retrieve a baseline value.
    
    Parameters:
    
    baselineNumber - baseline index (1-10)
    
    Returns:
    
    baseline value
  - getBaselineWork
```
public Duration getBaselineWork(int baselineNumber)
```
    Retrieve a baseline value.
    
    Parameters:
    
    baselineNumber - baseline index (1-10)
    
    Returns:
    
    baseline value
  - getBudget
```
public boolean getBudget()
```
    Retrieve the budget flag.
    
    Returns:
    
    budget flag
  - setBudget
```
public void setBudget(boolean budget)
```
    Set the budget flag.
    
    Parameters:
    
    budget - budget flag
  - getGUID
```
public UUID getGUID()
```
    Retrieves the resource GUID.
    
    Returns:
    
    resource GUID.
  - setUnit
```
public void setUnit(String value)
```
    Set the unit field.
    
    Parameters:
    
    value - unit value
  - getUnit
```
public String getUnit()
```
    Retrieve the unit field.
    
    Returns:
    
    unit value
  - setSupplyReference
```
public void setSupplyReference(String value)
```
    Set the supply reference field.
    
    Parameters:
    
    value - supply reference value
  - getSupplyReference
```
public String getSupplyReference()
```
    Retrieve the supply reference field.
    
    Returns:
    
    supply reference value
  - setDescription
```
public void setDescription(String value)
```
    Set the description field.
    
    Parameters:
    
    value - description field
  - getDescription
```
public String getDescription()
```
    Retrieve the description field.
    
    Returns:
    
    description value
  - setResourceID
```
public void setResourceID(String value)
```
    Set the resource ID field.
    
    Parameters:
    
    value - resource ID value
  - getResourceID
```
public String getResourceID()
```
    Retrieve the resource ID field.
    
    Returns:
    
    resource ID value
  - setModifyOnIntegrate
```
public void setModifyOnIntegrate(boolean value)
```
    Set the modify on integrate field.
    
    Parameters:
    
    value - modify on integrate value
  - getModifyOnIntegrate
```
public boolean getModifyOnIntegrate()
```
    Retrieve the modify on integrate value.
    
    Returns:
    
    modify on integrate value
  - setExpensesOnly
```
public void setExpensesOnly(boolean value)
```
    Set the expenses only field.
    
    Parameters:
    
    value - expenses only value
  - getExpensesOnly
```
public boolean getExpensesOnly()
```
    Retrieve the expenses only field.
    
    Returns:
    
    expenses only value
  - setPeriodDur
```
public void setPeriodDur(Number value)
```
    Set the period dur field.
    
    Parameters:
    
    value - period dur value
  - getPeriodDur
```
public Number getPeriodDur()
```
    Retrieve the period dur field.
    
    Returns:
    
    period dur value
  - setPriority
```
public void setPriority(Number value)
```
    Set the priority field.
    
    Parameters:
    
    value - priority value
  - getPriority
```
public Number getPriority()
```
    Retrieve the priority field.
    
    Returns:
    
    priority value
  - setRate
```
public void setRate(Number value)
```
    Set the rate field. Note that this is a TurboProject-specific field.
    
    Parameters:
    
    value - rate value
  - getRate
```
public Number getRate()
```
    Retrieve the rate field. Note that this is a TurboProject-specific field.
    
    Returns:
    
    rate value
  - setPool
```
public void setPool(Number value)
```
    Set the pool field.
    
    Parameters:
    
    value - pool value
  - getPool
```
public Number getPool()
```
    Retrieve the pool field.
    
    Returns:
    
    pool value
  - setPerDay
```
public void setPerDay(Number value)
```
    Set the per day field.
    
    Parameters:
    
    value - per day value
  - getPerDay
```
public Number getPerDay()
```
    Retrieve the per day field.
    
    Returns:
    
    per day value
  - setPhone
```
public void setPhone(String value)
```
    Set the phone field.
    
    Parameters:
    
    value - phone value
  - getPhone
```
public String getPhone()
```
    Retrieve the phone field.
    
    Returns:
    
    phone value
  - setRole
```
public void setRole(boolean value)
```
    Set the role field.
    
    Parameters:
    
    value - role value
  - getRole
```
public boolean getRole()
```
    Retrieve the role field. Returns true if this object represents a role rather than an individual resource.
    
    Returns:
    
    role value
  - setGUID
```
public void setGUID(UUID value)
```
    Sets the resource GUID.
    
    Parameters:
    
    value - resource GUID
  - setCostRateTable
```
public void setCostRateTable(int index,
                             CostRateTable crt)
```
    Associates a complete cost rate table with the current resource. Note that the index corresponds with the letter label used by MS Project to identify each table. For example 0=Table A, 1=Table B, 2=Table C, and so on.
    
    Parameters:
    
    index - table index
    
    crt - table instance
  - getCostRateTable
```
public CostRateTable getCostRateTable(int index)
```
    Retrieves a cost rate table associated with a resource. Note that the index corresponds with the letter label used by MS Project to identify each table. For example 0=Table A, 1=Table B, 2=Table C, and so on.
    
    Parameters:
    
    index - table index
    
    Returns:
    
    table instance
  - getCurrentCostRateTableEntry
```
public CostRateTableEntry getCurrentCostRateTableEntry(int costRateTable)
```
    Retrieve the cost rate table entry effective for the current date.
    
    Parameters:
    
    costRateTable - cost rate table index
    
    Returns:
    
    cost rate table entry
  - getAvailability
```
public AvailabilityTable getAvailability()
```
    Retrieve the availability table for this resource.
    
    Returns:
    
    availability table
  - getCurrentAvailabilityTableEntry
```
public Availability getCurrentAvailabilityTableEntry()
```
    Retrieve the availability table entry effective for the current date.
    
    Returns:
    
    availability table entry
  - getBudgetCost
```
public Number getBudgetCost()
```
    Retrieve the budget cost.
    
    Returns:
    
    budget cost value
  - setBudgetCost
```
public void setBudgetCost(Number value)
```
    Set the budget cost.
    
    Parameters:
    
    value - budget cost value
  - getBudgetWork
```
public Duration getBudgetWork()
```
    Retrieve the budget work.
    
    Returns:
    
    budget work value
  - setBudgetWork
```
public void setBudgetWork(Duration value)
```
    Set the budget work.
    
    Parameters:
    
    value - budget work value
  - getBaselineBudgetCost
```
public Number getBaselineBudgetCost()
```
    Retrieve the baseline budget cost.
    
    Returns:
    
    baseline budget cost value
  - setBaselineBudgetCost
```
public void setBaselineBudgetCost(Number value)
```
    Set the baseline budget cost.
    
    Parameters:
    
    value - baseline budget cost value
  - getBaselineBudgetWork
```
public Duration getBaselineBudgetWork()
```
    Retrieve the baseline budget work.
    
    Returns:
    
    baseline budget work value
  - setBaselineBudgetWork
```
public void setBaselineBudgetWork(Duration value)
```
    Set the baseline budget work.
    
    Parameters:
    
    value - baseline budget work value
  - getBaselineBudgetCost
```
public Number getBaselineBudgetCost(int baselineNumber)
```
    Retrieve a baseline budget cost.
    
    Parameters:
    
    baselineNumber - baseline number
    
    Returns:
    
    baseline budget cost
  - setBaselineBudgetCost
```
public void setBaselineBudgetCost(int baselineNumber,
                                  Number value)
```
    Set a baseline budget cost.
    
    Parameters:
    
    baselineNumber - baseline number
    
    value - baseline budget cost value
  - getBaselineBudgetWork
```
public Duration getBaselineBudgetWork(int baselineNumber)
```
    Retrieve a baseline budget work.
    
    Parameters:
    
    baselineNumber - baseline number
    
    Returns:
    
    baseline budget work value
  - setBaselineBudgetWork
```
public void setBaselineBudgetWork(int baselineNumber,
                                  Duration value)
```
    Set a baseline budget work.
    
    Parameters:
    
    baselineNumber - baseline number
    
    value - baseline budget work value
  - getCostCenter
```
public String getCostCenter()
```
    Retrieve the cost center.
    
    Returns:
    
    cost center value
  - setCostCenter
```
public void setCostCenter(String value)
```
    Set the cost center.
    
    Parameters:
    
    value - cost center value
  - getCalculateCostsFromUnits
```
public boolean getCalculateCostsFromUnits()
```
    Retrieve the calculate costs from units flag.
    
    Returns:
    
    calculate costs from units flag
  - setCalculateCostsFromUnits
```
public void setCalculateCostsFromUnits(boolean calculateCostsFromUnits)
```
    Set the calculate costs from units flag.
    
    Parameters:
    
    calculateCostsFromUnits - calculate costs from units flag
  - getSequenceNumber
```
public Integer getSequenceNumber()
```
    Retrieve this resource's sequence number.
    
    Returns:
    
    sequence number
  - setSequenceNumber
```
public void setSequenceNumber(Integer sequenceNumber)
```
    Set this resource's sequence number.
    
    Parameters:
    
    sequenceNumber - sequence number
  - getLocationUniqueID
```
public Integer getLocationUniqueID()
```
    Retrieves the location unique ID.
    
    Returns:
    
    location unique ID
  - setLocationUniqueID
```
public void setLocationUniqueID(Integer uniqueID)
```
    Sets the location unique ID.
    
    Parameters:
    
    uniqueID - location unique ID
  - getLocation
```
public Location getLocation()
```
    Retrieves the location.
    
    Returns:
    
    location.
  - setLocation
```
public void setLocation(Location location)
```
    Sets the location.
    
    Parameters:
    
    location - location
  - getShiftUniqueID
```
public Integer getShiftUniqueID()
```
    Retrieves the shift unique ID.
    
    Returns:
    
    shift unique ID
  - setShiftUniqueID
```
public void setShiftUniqueID(Integer uniqueID)
```
    Sets the shift unique ID.
    
    Parameters:
    
    uniqueID - shift unique ID
  - getShift
```
public Shift getShift()
```
    Retrieves the shift.
    
    Returns:
    
    shift.
  - setShift
```
public void setShift(Shift shift)
```
    Sets the shift.
    
    Parameters:
    
    shift - shift
  - getUnitOfMeasureUniqueID
```
public Integer getUnitOfMeasureUniqueID()
```
    Retrieve the unit of measure unique ID.
    
    Returns:
    
    unit of measure unique ID
  - setUnitOfMeasureUniqueID
```
public void setUnitOfMeasureUniqueID(Integer uniqueID)
```
    Sets the unit of measure unique ID.
    
    Parameters:
    
    uniqueID - unit of measure unique ID
  - getUnitOfMeasure
```
public UnitOfMeasure getUnitOfMeasure()
```
    Retrieves the unit of measure for this resource.
    
    Returns:
    
    unit of measure instance
  - setUnitOfMeasure
```
public void setUnitOfMeasure(UnitOfMeasure unitOfMeasure)
```
    Sets the unit of measure instance for this resource.
    
    Parameters:
    
    unitOfMeasure - unit of measure instance
  - getPrimaryRoleUniqueID
```
public Integer getPrimaryRoleUniqueID()
```
    Retrieves the primary role unique ID.
    
    Returns:
    
    primary role unique ID
  - setPrimaryRoleUniqueID
```
public void setPrimaryRoleUniqueID(Integer uniqueID)
```
    Sets the primary role unique ID.
    
    Parameters:
    
    uniqueID - primary role unique ID
  - getPrimaryRole
```
public Resource getPrimaryRole()
```
    Retrieves the primary role.
    
    Returns:
    
    primary role
  - setPrimaryRole
```
public void setPrimaryRole(Resource role)
```
    Sets the primary role.
    
    Parameters:
    
    role - primary role
  - handleFieldChange
```
protected void handleFieldChange(FieldType field,
                                 Object oldValue,
                                 Object newValue)
```
    Clear any cached calculated values which will be affected by this change.
    
    Parameters:
    
    field - modified field
    
    newValue - new value
    
    oldValue - old value of the updated field
  - getAlwaysCalculatedField
```
protected boolean getAlwaysCalculatedField(FieldType field)
```
    Description copied from class: AbstractFieldContainer
    
    Determine if the supplied field is always calculated.
    
    Parameters:
    
    field - field to check
    
    Returns:
    
    true if this field is always calculated
  - getCalculationMethod
```
protected Function<Resource,Object> getCalculationMethod(FieldType field)
```
    Description copied from class: AbstractFieldContainer
    
    Retrieve the method used to calculate the value of the supplied field.
    
    Parameters:
    
    field - target field
    
    Returns:
    
    calculation function, or null if the field is not calculated
  - compareTo
```
public int compareTo(Resource o)
```
    This method implements the only method in the Comparable interface. This allows Resources to be compared and sorted based on their ID value. Note that if the MPX/MPP file has been generated by MSP, the ID value will always be in the correct sequence. The Unique ID value will not necessarily be in the correct sequence as task insertions and deletions will change the order.
    
    Specified by:
    
    compareTo in interface Comparable<Resource>
    
    Parameters:
    
    o - object to compare this instance with
    
    Returns:
    
    result of comparison
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getParentFile
```
public final ProjectFile getParentFile()
```
    Accessor method allowing retrieval of ProjectFile reference.
    
    Returns:
    
    reference to this the parent ProjectFile instance

Class Resource

Method Summary

Methods inherited from class net.sf.mpxj.AbstractFieldContainer

Methods inherited from class java.lang.Object

Method Detail

addResource

addChildResource

getChildResources

removeChildResource

setName

getName

setType

getType

setIsNull

getNull

setInitials

getInitials

setPhonetics

getPhonetics

setNtAccount

getNtAccount

getMaterialLabel

setCode

getCode

setGroup

getGroup

setWorkGroup

getWorkGroup

setEmailAddress

getEmailAddress

setHyperlink

getHyperlink

setHyperlinkAddress

getHyperlinkAddress

setHyperlinkSubAddress

getHyperlinkSubAddress

setHyperlinkScreenTip

getHyperlinkScreenTip

setDefaultUnits

getDefaultUnits

getMaxUnits

setPeakUnits

getPeakUnits

setOverAllocated

getOverAllocated

getAvailableFrom

getAvailableTo

getStart

getFinish

setCanLevel

getCanLevel

setAccrueAt

getAccrueAt

setWork

getWork

getRegularWork

setRegularWork

setActualWork

getActualWork

setOvertimeWork

getOvertimeWork

setRemainingWork

getRemainingWork

getActualOvertimeWork

setActualOvertimeWork

getRemainingOvertimeWork

setRemainingOvertimeWork

setPercentWorkComplete

getPercentWorkComplete

getStandardRate

setCost

getCost

getOvertimeRate

getOvertimeCost

setOvertimeCost

getCostPerUse

setActualCost

getActualCost

getActualOvertimeCost

setActualOvertimeCost