Package com.highdeal.pnr.hci

Class ChargeActivationModificationModel

java.lang.Object

com.highdeal.filter.hci.ModificationModel

com.highdeal.pnr.hci.ChargeActivationModificationModel

All Implemented Interfaces:

XMLMarshallable

public class ChargeActivationModificationModel
extends ModificationModel

This class represents a charge activation modification model by using attributeModificationModel to describe each modification.
If no attributeModificationModel is given, no modification is done.
Available main modifiable attribute names are :

• EXPIRATION
• EFFECTIVE

Please consult ModificationModel for XML Schema. The element name for this charge activation modification is set to "chargeActivationModification". No specific modification exists for charge activations.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="chargeActivationModification" substitutionGroup="ModificationModel" type="ModificationModel"/>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EFFECTIVE	Name of the attributeDescription that represents effective.
static final String	EXPIRATION	Name of the attributeDescription that represents expiration.

Constructor Summary

Constructors

Constructor	Description
ChargeActivationModificationModel()

Method Summary

Modifier and Type	Method	Description
void	checkModifications()	This method throws an exception if the required modifications are not well formed.
Vector<AttributeDescriptionModel>	getMainModifiableAttributeCatalog()	Returns the list of pre-formed modification model of all modifiable main attributes.
AttributeDescriptionModel	getMainModifiableAttributeFromCatalog(String name)	Gets a pre-formed attribute modification model for a specified main attribute.
Vector<SpecificModificationModel>	getSpecificModificationCatalog()	This method allows the user to retrieve the catalog of available specific modifications.
SpecificModificationModel	getSpecificModificationFromCatalog(String code)	This method allows the user to retrieve from the catalog of available specific modifications a specified one.

Methods inherited from class com.highdeal.filter.hci.ModificationModel

addAttributeModification, addCharacterData, addChild, addSpecificModification, checkAttributeUnicity, getAttributeModificationList, getAttributeModificationListFromGroup, getEndPeriod, getModificationName, getSpecificModificationList, getStartPeriod, isPeriodRequired, marshal, setAttributeModificationList, setAttributes, setEndPeriod, setPeriodRequired, setSpecificModificationList, setStartPeriod

Methods inherited from class java.lang.Object

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

Field Details

EXPIRATION

public static final String EXPIRATION

Name of the attributeDescription that represents expiration. The type of the corresponding attributeDescription is date

See Also:

• Constant Field Values

EFFECTIVE

public static final String EFFECTIVE

Name of the attributeDescription that represents effective. The type of the corresponding attributeDescription is date

See Also:

• Constant Field Values

Constructor Details

ChargeActivationModificationModel

public ChargeActivationModificationModel()

Method Details

getSpecificModificationFromCatalog

public SpecificModificationModel getSpecificModificationFromCatalog(String code)

This method allows the user to retrieve from the catalog of available specific modifications a specified one.

Specified by:

getSpecificModificationFromCatalog in class ModificationModel

Parameters:

code - the code of the requested specific modification.

Returns:

null.

getSpecificModificationCatalog

public Vector<SpecificModificationModel> getSpecificModificationCatalog()

This method allows the user to retrieve the catalog of available specific modifications.

Specified by:

getSpecificModificationCatalog in class ModificationModel

Returns:

an empty list.

getMainModifiableAttributeFromCatalog

public AttributeDescriptionModel getMainModifiableAttributeFromCatalog(String name)

Description copied from class: ModificationModel

Gets a pre-formed attribute modification model for a specified main attribute.

Specified by:

getMainModifiableAttributeFromCatalog in class ModificationModel

Returns:

The attribute related modification model or null if no modification is allowed on the specified attribute

getMainModifiableAttributeCatalog

public Vector<AttributeDescriptionModel> getMainModifiableAttributeCatalog()

Description copied from class: ModificationModel

Returns the list of pre-formed modification model of all modifiable main attributes.

Specified by:

getMainModifiableAttributeCatalog in class ModificationModel

Returns:

A list of AttributeDescriptionModel

checkModifications

public void checkModifications()
                        throws InvalidBulkModificationException

Description copied from class: ModificationModel

This method throws an exception if the required modifications are not well formed.

Specified by:

checkModifications in class ModificationModel

Throws:

InvalidBulkModificationException - with MALFORMED_MODEL as reason