com.highdeal.filter.hci

Class ModificationModel

java.lang.Object

com.highdeal.filter.hci.ModificationModel

All Implemented Interfaces:

XMLMarshallable

Direct Known Subclasses:

ChargeActivationModificationModel, SubscriptionModificationModel

public abstract class ModificationModel
extends java.lang.Object
implements XMLMarshallable

This abstract Java class supports any entity modification description; It allows you to describe the modification you want to apply on a set of entity. This class is mainly used for bulk modification. For single modification, some entity related operation requests exist and work with each entity model for describing modification.

This class aggregates a list of attribute modification models and a list of specific modification model (particular modifications which cannot be expressed with some attribute modification model (see SpecificModificationModel and AttributeModificationModel).

You can set a modification period for entities which are managed into chronology.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="ModificationModel">
     <xs:sequence>
       <xs:element ref="attributeModification" minOccurs="0" maxOccurs="unbounded"/>
       <xs:element ref="specificModification" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="periodRequired" type="xs:boolean" default="false"/> <!-- tells if the targetted objects are managed in chronology or not. If true, a period must be specified into the modification. -->
    <xs:attribute name="startPeriod" type="xs:dateTime"/> <!-- used only if period required is true -->
    <xs:attribute name="endPeriod" type="xs:dateTime"/> <!-- used only if period required is true -->
   </xs:complexType>

<xs:element name="ModificationModel" type="ModificationModel" abstract="true"/>

Constructor Summary

Constructors

Constructor and Description
ModificationModel(java.lang.String modificationName) Builds an empty modification model.
ModificationModel(java.lang.String modificationName, boolean periodRequired) Builds a modification model.

Method Summary

Modifier and Type	Method and Description
void	addAttributeModification(AttributeModificationModel sel) Adds a modification which port on a attribute field.
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
void	addSpecificModification(SpecificModificationModel spec) Adds a specific constraint for the modification operation.
void	checkAttributeUnicity() This method throws an exception if it exists a doublon among attributes description model.
abstract void	checkModifications() This method throws an exception if the required modifications are not well formed.
java.util.Vector<AttributeModificationModel>	getAttributeModificationList() Gets the list of constraints which port on attribute fields.
java.util.Vector<AttributeModificationModel>	getAttributeModificationListFromGroup(java.lang.String group) Returns a list of attribute modification models which belong to a specified group.
java.util.Date	getEndPeriod() Gets end period.
abstract java.util.Vector<AttributeDescriptionModel>	getMainModifiableAttributeCatalog() Returns the list of pre-formed modification model of all modifiable main attributes.
abstract AttributeDescriptionModel	getMainModifiableAttributeFromCatalog(java.lang.String attributeName) Gets a pre-formed attribute modification model for a specified main attribute.
java.lang.String	getModificationName() Returns the XML element name of the current modification model.
abstract java.util.Vector<SpecificModificationModel>	getSpecificModificationCatalog() This method allows the user to retrieve the catalog of available specific modifications.
abstract SpecificModificationModel	getSpecificModificationFromCatalog(java.lang.String specCode) This method allows the user to retrieve from the catalog of available specific modifications a specified one.
java.util.Vector<SpecificModificationModel>	getSpecificModificationList() Gets the list of specific constraints.
java.util.Date	getStartPeriod() Gets start period.
boolean	isPeriodRequired() Returns true if the modified object family is managed with chronology.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributeModificationList(java.util.Vector<AttributeModificationModel> sels) Sets the list of constraints which port on attribute fields.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setEndPeriod(java.util.Date to) Sets end period.
void	setPeriodRequired(boolean state)
void	setSpecificModificationList(java.util.Vector<SpecificModificationModel> specifics) Sets the list of specific constraints.
void	setStartPeriod(java.util.Date from) Sets start period.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModificationModel

public ModificationModel(java.lang.String modificationName)

Builds an empty modification model.

ModificationModel

public ModificationModel(java.lang.String modificationName,
                         boolean periodRequired)

Builds a modification model.

Method Detail

getModificationName

public java.lang.String getModificationName()

Returns the XML element name of the current modification model.

Returns:

The name of the element

getAttributeModificationList

public java.util.Vector<AttributeModificationModel> getAttributeModificationList()

Gets the list of constraints which port on attribute fields.

Returns:

A list of AttributeModificationModel

setAttributeModificationList

public void setAttributeModificationList(java.util.Vector<AttributeModificationModel> sels)

Sets the list of constraints which port on attribute fields.

Parameters:

sels - A list of AttributeModificationModel

getAttributeModificationListFromGroup

public java.util.Vector<AttributeModificationModel> getAttributeModificationListFromGroup(java.lang.String group)

Returns a list of attribute modification models which belong to a specified group.

It exists 4 groups for qualifying an attribute:

• MAIN_GROUP: The attribute is a main attribute which is located into the main item table
• ADDITIONAL_GROUP: The attribute is an additional attribute which is located into the additional item table
• PARAMETER_GROUP: The attribute is a parameter attribute which is located into a related parameter table
• COUNTER_GROUP: The attribute is view as a counter which is located into a related table

Parameters:

group - The group name. The available values are:

• MAIN_GROUP
• ADDITIONAL_GROUP
• PARAMETER_GROUP
• COUNTER_GROUP

addAttributeModification

public void addAttributeModification(AttributeModificationModel sel)

Adds a modification which port on a attribute field.

Parameters:

sel - The attribute modification to add

getSpecificModificationList

public java.util.Vector<SpecificModificationModel> getSpecificModificationList()

Gets the list of specific constraints.

Returns:

A list of SpecificModificationModel

setSpecificModificationList

public void setSpecificModificationList(java.util.Vector<SpecificModificationModel> specifics)

Sets the list of specific constraints.

Parameters:

specifics - A list of SpecificModificationModel

addSpecificModification

public void addSpecificModification(SpecificModificationModel spec)

Adds a specific constraint for the modification operation.

Parameters:

spec - The specific modification to add

getStartPeriod

public java.util.Date getStartPeriod()

Gets start period. Returns always null if the modification model is a no "periodRequired" model. If the modifier works on chronologized entities, null means since ever.

Returns:

The start period date

setStartPeriod

public void setStartPeriod(java.util.Date from)

Sets start period. Sets null value if the modification model is a no "periodRequired" filter. If the filter works on chronologized items, null means since ever.

Parameters:

from - The start period date to set up

getEndPeriod

public java.util.Date getEndPeriod()

Gets end period. Returns always null if the filter is a no "periodRequired" filter. If the filter works on chronologized items, null means since ever.

Returns:

The end period date

setEndPeriod

public void setEndPeriod(java.util.Date to)

Sets end period. Sets null value if the filter is a no "periodRequired" filter. If the filter works on chronologized items, null means since ever.

Parameters:

to - The end period date to set up

isPeriodRequired

public boolean isPeriodRequired()

Returns true if the modified object family is managed with chronology.

setPeriodRequired

public void setPeriodRequired(boolean state)

getSpecificModificationFromCatalog

public abstract SpecificModificationModel getSpecificModificationFromCatalog(java.lang.String specCode)

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

Parameters:

specCode - The code of the requested specific modification

getSpecificModificationCatalog

public abstract java.util.Vector<SpecificModificationModel> getSpecificModificationCatalog()

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

Returns:

A list of SpecificModificationModel

getMainModifiableAttributeFromCatalog

public abstract AttributeDescriptionModel getMainModifiableAttributeFromCatalog(java.lang.String attributeName)

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

Returns:

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

getMainModifiableAttributeCatalog

public abstract java.util.Vector<AttributeDescriptionModel> getMainModifiableAttributeCatalog()

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

Returns:

A list of AttributeDescriptionModel

checkModifications

public abstract void checkModifications()
                                 throws InvalidBulkModificationException

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

Throws:

InvalidBulkModificationException - with MALFORMED_MODEL as reason

checkAttributeUnicity

public void checkAttributeUnicity()
                           throws InvalidBulkModificationException

This method throws an exception if it exists a doublon among attributes description model.

Throws:

InvalidBulkModificationException - with MALFORMED_MODEL as reason

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagName,
                     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

Parameters:

tagName - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

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

Parameters:

output - The XML output to marshal the object into