Package com.highdeal.pnr.hci

Class SubscriptionModificationModel

java.lang.Object

com.highdeal.filter.hci.ModificationModel

com.highdeal.pnr.hci.SubscriptionModificationModel

All Implemented Interfaces:

XMLMarshallable

public class SubscriptionModificationModel
extends ModificationModel

This class represents a subscription 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
• PRICE_FREEZE_EFFECTIVE
• PRICE_FREEZE_EXPIRATION
• COMMITMENT_EXPIRATION
• SUSPENSION_DATE
• RESUMPTION_DATE
• CANCELLATION_DATE

Please consult ModificationModel for more information. The element name for this subscription modification is set to "subscriptionModification". No specific modification exists for subscriptions.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CANCELLATION_DATE	Name of the attributeDescription that represents cancellationDate.
static final String	COMMITMENT_EXPIRATION	Name of the attributeDescription that represents commitmentEffective.
static final String	EXPIRATION	Name of the attributeDescription that represents expiration.
static final String	PRICE_FREEZE_EFFECTIVE	Name of the attributeDescription that represents priceFreezeEffective.
static final String	PRICE_FREEZE_EXPIRATION	Name of the attributeDescription that represents priceFreezeExpiration.
static final String	RESUMPTION_DATE	Name of the attributeDescription that represents resumptionDate.
static final String	SUSPENSION_DATE	Name of the attributeDescription that represents suspensionDate.

Constructor Summary

Constructors

Constructor	Description
SubscriptionModificationModel()

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

PRICE_FREEZE_EFFECTIVE

public static final String PRICE_FREEZE_EFFECTIVE

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

See Also:

• Constant Field Values

PRICE_FREEZE_EXPIRATION

public static final String PRICE_FREEZE_EXPIRATION

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

See Also:

• Constant Field Values

COMMITMENT_EXPIRATION

public static final String COMMITMENT_EXPIRATION

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

See Also:

• Constant Field Values

SUSPENSION_DATE

public static final String SUSPENSION_DATE

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

See Also:

• Constant Field Values

RESUMPTION_DATE

public static final String RESUMPTION_DATE

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

See Also:

• Constant Field Values

CANCELLATION_DATE

public static final String CANCELLATION_DATE

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

See Also:

• Constant Field Values

Constructor Details

SubscriptionModificationModel

public SubscriptionModificationModel()

Method Details

getSpecificModificationFromCatalog

public SpecificModificationModel getSpecificModificationFromCatalog(String code)

Description copied from class: ModificationModel

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

getSpecificModificationCatalog

public Vector<SpecificModificationModel> getSpecificModificationCatalog()

Description copied from class: ModificationModel

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

Specified by:

getSpecificModificationCatalog in class ModificationModel

Returns:

A list of SpecificModificationModel

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