com.highdeal.pnr.hci

Class DefaultChargeActionModel

java.lang.Object

com.highdeal.pnr.hci.RateComponentModel

com.highdeal.pnr.hci.DefaultChargeActionModel

All Implemented Interfaces:

XMLMarshallable, ContextualNode

Direct Known Subclasses:

InternalChargeActionModel

public class DefaultChargeActionModel
extends RateComponentModel

This class represents the action of charging on the default one of the mapping following a charging mode.

This model is a rate RateComponentModel containing three properties:

• name="chargingMode" type="string" value="<ChargingMode, the default one is ChargingMode.forceNothing>"
• name="allowFreeChargeUpTo" type="string" value="<AccountState, the default one is AccountState.CLOSED>"
• name="allowNotFreeChargeUpTo" type="string" value="<AccountState, the default one is AccountState.ACTIVE>"

Since:

Transactive 4.0

Field Summary

Fields

Modifier and Type	Field and Description
static AccountState	DEFAULT_FREE_CHARGE_UP_TO Default account state from which free amounts are not charged if its state is strictly higher than this value.
static AccountState	DEFAULT_NOT_FREE_CHARGE_UP_TO Default account state from which non free amounts are not charged if its state is strictly higher than this value.

Constructor Summary

Constructors

Constructor and Description
DefaultChargeActionModel()

Method Summary

Modifier and Type	Method and Description
void	addChild(java.lang.String name, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
boolean	checkValidity() Returns true if the component is valid.
AccountState	getAllowFreeChargeUpTo() Gets the account state from which free charged amounts are rejected.
AccountState	getAllowNotFreeChargeUpTo() Gets the account state from which non free charged amounts are rejected.
ChargingMode	getChargingMode() Returns the mode of the charging.
int	getMaxChildCount() Gets the maximum child count.
java.util.List<com.highdeal.pnr.hci.PropertyReference>	getPropertyReferences() Returns the list of the properties that are used in this component.
void	internalAddChild(java.lang.String name, XMLMarshallable child)
void	internalMarshal(XMLOutputter output)
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAllowFreeChargeUpTo(AccountState allowFreeChargeUpTo) Sets the account state from which free charged amounts are rejected.
void	setAllowNotFreeChargeUpTo(AccountState allowNotFreeChargeUpTo) Sets the account state from which non free amounts charged are rejected.
void	setChargingMode(ChargingMode chargingMode) Sets the charging mode.

Methods inherited from class com.highdeal.pnr.hci.RateComponentModel

addCharacterData, findRootRateModel, getChildAt, getChildCount, getChildren, getContext, getDescription, getName, getParent, getPropertyNames, inheritedContext, isRemoveChildAllowed, isSetChildAllowed, remove, removeChild, setAttributes, setChild, setChildren, setDescription, setName, setParent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FREE_CHARGE_UP_TO

public static final AccountState DEFAULT_FREE_CHARGE_UP_TO

Default account state from which free amounts are not charged if its state is strictly higher than this value.

DEFAULT_NOT_FREE_CHARGE_UP_TO

public static final AccountState DEFAULT_NOT_FREE_CHARGE_UP_TO

Default account state from which non free amounts are not charged if its state is strictly higher than this value.

Constructor Detail

DefaultChargeActionModel

public DefaultChargeActionModel()

Method Detail

getChargingMode

public ChargingMode getChargingMode()

Returns the mode of the charging.

Returns:

the mode of the charging.

setChargingMode

public void setChargingMode(ChargingMode chargingMode)

Sets the charging mode.

Parameters:

chargingMode - the charging mode.

getAllowFreeChargeUpTo

public AccountState getAllowFreeChargeUpTo()

Gets the account state from which free charged amounts are rejected.

Returns:

an account state

setAllowFreeChargeUpTo

public void setAllowFreeChargeUpTo(AccountState allowFreeChargeUpTo)

Sets the account state from which free charged amounts are rejected.

Parameters:

allowFreeChargeUpTo - an account state

getAllowNotFreeChargeUpTo

public AccountState getAllowNotFreeChargeUpTo()

Gets the account state from which non free charged amounts are rejected.

Returns:

an account state

setAllowNotFreeChargeUpTo

public void setAllowNotFreeChargeUpTo(AccountState allowNotFreeChargeUpTo)

Sets the account state from which non free amounts charged are rejected.

Parameters:

allowNotFreeChargeUpTo - an account state

getMaxChildCount

public int getMaxChildCount()

Description copied from class: RateComponentModel

Gets the maximum child count.

Specified by:

getMaxChildCount in class RateComponentModel

Returns:

the maximum child count.

checkValidity

public boolean checkValidity()

Description copied from class: RateComponentModel

Returns true if the component is valid.

Specified by:

checkValidity in class RateComponentModel

Returns:

true if the component is valid, false otherwise.

getPropertyReferences

public java.util.List<com.highdeal.pnr.hci.PropertyReference> getPropertyReferences()

Description copied from class: RateComponentModel

Returns the list of the properties that are used in this component.

Specified by:

getPropertyReferences in class RateComponentModel

Returns:

the list of the properties that are used in this component

addChild

public void addChild(java.lang.String name,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Overrides:

addChild in class RateComponentModel

Parameters:

name - The name of tag for the child

child - The child to be added

internalAddChild

public void internalAddChild(java.lang.String name,
                             XMLMarshallable child)

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Overrides:

marshal in class RateComponentModel

Parameters:

output - The XML output to marshal the object into

internalMarshal

public void internalMarshal(XMLOutputter output)