com.highdeal.pnr.hci

Class ProrataModel

java.lang.Object

com.highdeal.pnr.hci.ProrataModel

public class ProrataModel
extends java.lang.Object

This class represents a prorata.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DAYS Time unit in days.
static int	HOURS Time unit in hours.
static int	MINUTES Time unit in minutes.
static int	ROUND_DOWN Rounding down mode.
static int	ROUND_NEAREST Rounding to nearest mode.
static int	ROUND_UP Rounding up mode.
static int	SECONDS Time unit in seconds.

Constructor Summary

Constructors

Constructor and Description
ProrataModel() Builds an empty ProrataModel.
ProrataModel(int unit, java.math.BigDecimal step, int mode, java.math.BigDecimal fraction, boolean fractionDefined, boolean splitRefund) Builds a ProrataModel.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.math.BigDecimal	getFraction() Gets the fraction.
int	getRoundingMode() Gets the rounding mode.
java.math.BigDecimal	getRoundingStep() Gets the rounding step.
int	getTimeUnit() Gets the time unit.
int	hashCode()
boolean	isFractionDefined() Tests if the fraction is defined.
boolean	isSplitRefund() Tests if the prorata is a split refund.
void	setFraction(java.math.BigDecimal fraction) Sets the fraction.
void	setFractionDefined(boolean defined) Sets the fraction defined.
void	setRoundingMode(int mode) Sets the rounding mode.
void	setRoundingStep(java.math.BigDecimal step) Sets the rounding step.
void	setSplitRefund(boolean splitRefund) Sets the split refund flag.
void	setTimeUnit(int unit) Sets the time unit.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

SECONDS

public static final int SECONDS

Time unit in seconds.

See Also:

Constant Field Values

MINUTES

public static final int MINUTES

Time unit in minutes.

See Also:

Constant Field Values

HOURS

public static final int HOURS

Time unit in hours.

See Also:

Constant Field Values

DAYS

public static final int DAYS

Time unit in days.

See Also:

Constant Field Values

ROUND_UP

public static final int ROUND_UP

Rounding up mode.

See Also:

Constant Field Values

ROUND_DOWN

public static final int ROUND_DOWN

Rounding down mode.

See Also:

Constant Field Values

ROUND_NEAREST

public static final int ROUND_NEAREST

Rounding to nearest mode.

See Also:

Constant Field Values

Constructor Detail

ProrataModel

public ProrataModel()

Builds an empty ProrataModel.

ProrataModel

public ProrataModel(int unit,
                    java.math.BigDecimal step,
                    int mode,
                    java.math.BigDecimal fraction,
                    boolean fractionDefined,
                    boolean splitRefund)

Builds a ProrataModel.

Parameters:

unit - the time unit, see setTimeUnit.

step - the rounding step.

mode - the rounding mode, see setRoundingMode.

fraction - the fraction.

fractionDefined - set the fraction defined.

splitRefund - true if the refund is done on the complete period, false if the refund is partial

Method Detail

setTimeUnit

public void setTimeUnit(int unit)

Sets the time unit. Allowed values are :

• DAYS
• HOURS
• MINUTES
• SECONDS

Parameters:

unit - the time unit.

getTimeUnit

public int getTimeUnit()

Gets the time unit. Returned values are :

• DAYS
• HOURS
• MINUTES
• SECONDS

Returns:

the time unit.

setRoundingStep

public void setRoundingStep(java.math.BigDecimal step)

Sets the rounding step.

Parameters:

step - the rounding step.

getRoundingStep

public java.math.BigDecimal getRoundingStep()

Gets the rounding step.

Returns:

the rounding step.

setRoundingMode

public void setRoundingMode(int mode)

Sets the rounding mode. Allowed values are :

• ROUND_UP
• ROUND_DOWN
• ROUND_NEAREST

Parameters:

mode - the rounding mode.

getRoundingMode

public int getRoundingMode()

Gets the rounding mode. Returned values are :

• ROUND_UP
• ROUND_DOWN
• ROUND_NEAREST

Returns:

the rounding mode.

setFraction

public void setFraction(java.math.BigDecimal fraction)

Sets the fraction.

Parameters:

fraction - the fraction.

getFraction

public java.math.BigDecimal getFraction()

Gets the fraction.

Returns:

the fraction.

setFractionDefined

public void setFractionDefined(boolean defined)

Sets the fraction defined.

Parameters:

defined - the fraction defined.

isFractionDefined

public boolean isFractionDefined()

Tests if the fraction is defined.

Returns:

true if the fraction is defined, false otherwise.

setSplitRefund

public void setSplitRefund(boolean splitRefund)

Sets the split refund flag.

Parameters:

splitRefund - true if the prorata is a split refund, false otherwise

isSplitRefund

public boolean isSplitRefund()

Tests if the prorata is a split refund.

Returns:

true if the prorata is a split refund, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object