com.highdeal.udr.hci
Class UserDefinedRecordModel

java.lang.Object
  com.highdeal.udr.hci.UserDefinedRecordModel

All Implemented Interfaces:

XMLMarshallable

public class UserDefinedRecordModel
extends java.lang.Object
implements XMLMarshallable

In HighDeal Transactive^TM, a user defined record references a set of attribute descriptions.

XML Schema Fragment

<xs:element name="userDefinedRecord">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="attributeDescription" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="description" type="xs:string"/>
     <xs:attribute name="code" type="xs:string"/>
     <xs:attribute name="ref" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

UserDefinedRecordModel()
Builds an empty user defined record.

UserDefinedRecordModel(java.lang.String code, java.lang.String description)
Builds an empty user defined record with a code and a description.

Method Summary

void	addAttributeDescription(AttributeDescriptionModel ad) Adds an attribute description in the user defined record.
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 objects, the child represents the marshallable object to be added into the content tree.
java.util.List<AttributeDescriptionModel>	getAttributeDescriptions() Returns the list of attributeDescriptionModel which defines this user defined record.
java.lang.String	getCode() Returns the code of the user defined record.
java.lang.String	getDescription() Returns the description of the user defined record.
java.lang.String	getReference() Gets the reference.
boolean	isValid() Checks if this user defined record is valid.
void	marshal(XMLOutputter output) Gives an XML representation of this object, and of its children.
void	removeAttributeDescription(int index) Removes an attribute description from the user defined record.
void	setAttributeDescriptions(java.util.List<AttributeDescriptionModel> descriptions) Sets the list of AttributeDescriptionModel in the user defined record.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the tag beeing processed.
void	setCode(java.lang.String code) Sets the code of the user defined record.
void	setDescription(java.lang.String description) Sets the description of the user defined record.
void	setReference(java.lang.String r) Sets the reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDefinedRecordModel

public UserDefinedRecordModel()

Builds an empty user defined record.

UserDefinedRecordModel

public UserDefinedRecordModel(java.lang.String code,
                              java.lang.String description)

Builds an empty user defined record with a code and a description.

Parameters:

code - the code of the user defined record.

description - the description of the user defined record.

Method Detail

getReference

public java.lang.String getReference()

Gets the reference.

Returns:

the reference.

setReference

public void setReference(java.lang.String r)

Sets the reference.

Parameters:

r - the reference.

getCode

public java.lang.String getCode()

Returns the code of the user defined record.

Returns:

the code of the user defined record.

setCode

public void setCode(java.lang.String code)

Sets the code of the user defined record.

Parameters:

code - the code of the user defined record.

getDescription

public java.lang.String getDescription()

Returns the description of the user defined record.

Returns:

the description of the user defined record.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the user defined record.

Parameters:

description - the description of the user defined record.

getAttributeDescriptions

public java.util.List<AttributeDescriptionModel> getAttributeDescriptions()

Returns the list of attributeDescriptionModel which defines this user defined record.

Returns:

the list of the associated attribute descriptions.

setAttributeDescriptions

public void setAttributeDescriptions(java.util.List<AttributeDescriptionModel> descriptions)

Sets the list of AttributeDescriptionModel in the user defined record.

Parameters:

descriptions - a list of AttributeDescriptionModel.

addAttributeDescription

public void addAttributeDescription(AttributeDescriptionModel ad)

Adds an attribute description in the user defined record.

Parameters:

ad - an attribute description.

removeAttributeDescription

public void removeAttributeDescription(int index)

Removes an attribute description from the user defined record.

Parameters:

index - the index of the attribute description.

isValid

public boolean isValid()

Checks if this user defined record is valid. Each attribute description has to be valid and must have a unique name in the same user user defined record.

Returns:

true if this user defined record is valid, false otherwise.

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the tag beeing processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - the XML attributes of the current tag.

addChild

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

Description copied from interface: XMLMarshallable

Adds a child to the objects, the child represents the marshallable object to be added into the content tree.

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, and of its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - the XML output to marshall the object into.