net.sf.mpxj

Class CostRateTableEntry

java.lang.Object

net.sf.mpxj.CostRateTableEntry

All Implemented Interfaces:

Comparable<CostRateTableEntry>

public final class CostRateTableEntry
extends Object
implements Comparable<CostRateTableEntry>

This class represents a row from a resource's cost rate table. Note that MS Project always represents costs as an hourly rate, it holds an additional field to indicate the format used when displaying the rate.

Field Summary

Fields

Modifier and Type	Field and Description
static CostRateTableEntry	DEFAULT_ENTRY
static int	MAX_RATES

Constructor Summary

Constructors

Constructor and Description
CostRateTableEntry(LocalDateTime startDate, LocalDateTime endDate, Number costPerUse, Rate... rates) Constructor.
CostRateTableEntry(LocalDateTime startDate, LocalDateTime endDate, Number costPerUse, ShiftPeriod shiftPeriod, Rate... rates) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(CostRateTableEntry o)
Number	getCostPerUse() Retrieves the cost per use represented by this entry.
LocalDateTime	getEndDate() Retrieves the end date after which this table entry is not valid.
Rate	getOvertimeRate() Retrieves the overtime rate represented by this entry.
Rate	getRate(int index) Retrieve the rate with the specified index.
ShiftPeriod	getShiftPeriod() Retrieve the shift period associated with this rate.
Rate	getStandardRate() Retrieves the standard rate represented by this entry.
LocalDateTime	getStartDate() Retrieves the start date at which this table entry is valid.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ENTRY

public static final CostRateTableEntry DEFAULT_ENTRY

MAX_RATES

public static final int MAX_RATES

See Also:

Constant Field Values

Constructor Detail

CostRateTableEntry

public CostRateTableEntry(LocalDateTime startDate,
                          LocalDateTime endDate,
                          Number costPerUse,
                          Rate... rates)

Constructor.

Parameters:

startDate - start date

endDate - end date

costPerUse - cost per use

rates - Rate instances

CostRateTableEntry

public CostRateTableEntry(LocalDateTime startDate,
                          LocalDateTime endDate,
                          Number costPerUse,
                          ShiftPeriod shiftPeriod,
                          Rate... rates)

Constructor.

Parameters:

startDate - start date

endDate - end date

costPerUse - cost per use

shiftPeriod - shift period

rates - Rate instances

Method Detail

getStartDate

public LocalDateTime getStartDate()

Retrieves the start date at which this table entry is valid.

Returns:

start date

getEndDate

public LocalDateTime getEndDate()

Retrieves the end date after which this table entry is not valid.

Returns:

end date

getRate

public Rate getRate(int index)

Retrieve the rate with the specified index.

Parameters:

index - rate index

Returns:

Rate instance

getStandardRate

public Rate getStandardRate()

Retrieves the standard rate represented by this entry.

Returns:

standard rate

getOvertimeRate

public Rate getOvertimeRate()

Retrieves the overtime rate represented by this entry.

Returns:

overtime rate

getCostPerUse

public Number getCostPerUse()

Retrieves the cost per use represented by this entry.

Returns:

per use rate

getShiftPeriod

public ShiftPeriod getShiftPeriod()

Retrieve the shift period associated with this rate.

Returns:

ShiftPeriod instance or null

compareTo

public int compareTo(CostRateTableEntry o)

Specified by:

compareTo in interface Comparable<CostRateTableEntry>

toString

public String toString()

Overrides:

toString in class Object