Rate

Inheritance: java.lang.Object

public class Rate

Represents a definition of a time period and rates applicable for a resource during that period.

Methods

Method	Description
getCostPerUse()	Gets the cost per use of a resource.
getOvertimeRate()	Gets the overtime rate per hour for a resource.
getOvertimeRateFormat()	Gets the units used by Microsoft Project to display the overtime rate.
getRateTable()	Gets the unique identifier of a rate table for a resource.
getRatesFrom()	Gets the date when a rate becomes effective.
getRatesTo()	Gets the last date when a rate is effective.
getStandardRate()	Gets the standard rate per hour for a resource.
getStandardRateFormat()	Gets the units used by Microsoft Project to display the standard rate.
setCostPerUse(BigDecimal value)	Sets the cost per use of a resource.
setOvertimeRate(BigDecimal value)	Sets the overtime rate per hour for a resource.
setOvertimeRateFormat(int value)	Sets the units used by Microsoft Project to display the overtime rate.
setRateTable(int value)	Sets the unique identifier of a rate table for a resource.
setRatesFrom(Date value)	Sets the date when a rate becomes effective.
setRatesTo(Date value)	Sets the last date when a rate is effective.
setStandardRate(BigDecimal value)	Sets the standard rate per hour for a resource.
setStandardRateFormat(int value)	Sets the units used by Microsoft Project to display the standard rate.

getCostPerUse()

public final BigDecimal getCostPerUse()

Gets the cost per use of a resource. This value retrieved from the current date if a rate table exists for a resource.

Returns: java.math.BigDecimal - the cost per use of a resource.

getOvertimeRate()

public final BigDecimal getOvertimeRate()

Gets the overtime rate per hour for a resource.

Returns: java.math.BigDecimal - the overtime rate per hour for a resource.

getOvertimeRateFormat()

public final int getOvertimeRateFormat()

Gets the units used by Microsoft Project to display the overtime rate.

Returns: int - the units used by Microsoft Project to display the overtime rate.

getRateTable()

public final int getRateTable()

Gets the unique identifier of a rate table for a resource.

Returns: int - the unique identifier of a rate table for a resource.

getRatesFrom()

public final Date getRatesFrom()

Gets the date when a rate becomes effective.

Returns: java.util.Date - the date when a rate becomes effective.

getRatesTo()

public final Date getRatesTo()

Gets the last date when a rate is effective.

Returns: java.util.Date - the last date when a rate is effective.

getStandardRate()

public final BigDecimal getStandardRate()

Gets the standard rate per hour for a resource.

Returns: java.math.BigDecimal - the standard rate per hour for a resource.

getStandardRateFormat()

public final int getStandardRateFormat()

Gets the units used by Microsoft Project to display the standard rate.

Returns: int - the units used by Microsoft Project to display the standard rate.

setCostPerUse(BigDecimal value)

public final void setCostPerUse(BigDecimal value)

Sets the cost per use of a resource. This value retrieved from the current date if a rate table exists for a resource.

Parameters:

Parameter	Type	Description
value	java.math.BigDecimal	the cost per use of a resource.

setOvertimeRate(BigDecimal value)

public final void setOvertimeRate(BigDecimal value)

Sets the overtime rate per hour for a resource.

Parameters:

Parameter	Type	Description
value	java.math.BigDecimal	the overtime rate per hour for a resource.

setOvertimeRateFormat(int value)

public final void setOvertimeRateFormat(int value)

Sets the units used by Microsoft Project to display the overtime rate.

Parameters:

Parameter	Type	Description
value	int	the units used by Microsoft Project to display the overtime rate.

setRateTable(int value)

public final void setRateTable(int value)

Sets the unique identifier of a rate table for a resource.

Parameters:

Parameter	Type	Description
value	int	the unique identifier of a rate table for a resource.

setRatesFrom(Date value)

public final void setRatesFrom(Date value)

Sets the date when a rate becomes effective.

Parameters:

Parameter	Type	Description
value	java.util.Date	the date when a rate becomes effective.

setRatesTo(Date value)

public final void setRatesTo(Date value)

Sets the last date when a rate is effective.

Parameters:

Parameter	Type	Description
value	java.util.Date	the last date when a rate is effective.

setStandardRate(BigDecimal value)

public final void setStandardRate(BigDecimal value)

Sets the standard rate per hour for a resource.

Parameters:

Parameter	Type	Description
value	java.math.BigDecimal	the standard rate per hour for a resource.

setStandardRateFormat(int value)

public final void setStandardRateFormat(int value)

Sets the units used by Microsoft Project to display the standard rate.

Parameters:

Parameter	Type	Description
value	int	the units used by Microsoft Project to display the standard rate.