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

This Java class represents a user defined record (UDR) that references a set of attribute descriptions.

See Also:

AttributeDescriptionModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD 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

Constructors

Constructor and Description
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 text description.

Method Summary

Modifier and Type	Method and Description
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 object, the child representing the marshallable object which must be added to the element.
java.util.List<AttributeDescriptionModel>	getAttributeDescriptions() Returns the list of attribute descriptions which defines this user defined record.
java.lang.String	getCode() Returns the identification code of the user defined record.
java.lang.String	getDescription() Returns the comprehensive description of the user defined record.
java.lang.String	getReference() Gets the reference.
boolean	isValid() Checks if this user defined record is valid; Each included attribute description has also to be valid and must have a unique name in the same user user defined record.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including 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 attribute descriptions in the user defined record.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setCode(java.lang.String code) Sets the identification code of the user defined record.
void	setDescription(java.lang.String description) Sets the comprehensive description of the user defined record.
void	setReference(java.lang.String r) Sets the reference.

Methods inherited from class java.lang.Object

equals, 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 text description.

Parameters:

code - The identification code of the user defined record

description - The comprehensive 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 identification code of the user defined record.

Returns:

The code of the user defined record

setCode

public void setCode(java.lang.String code)

Sets the identification code of the user defined record.

Parameters:

code - The identification code of the UDR

getDescription

public java.lang.String getDescription()

Returns the comprehensive description of the user defined record.

Returns:

The text description of the UDR

setDescription

public void setDescription(java.lang.String description)

Sets the comprehensive description of the user defined record.

Parameters:

description - The text description of the UDR

getAttributeDescriptions

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

Returns the list of attribute descriptions 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 attribute descriptions in the user defined record.

Parameters:

descriptions - A list of attribute descriptions

addAttributeDescription

public void addAttributeDescription(AttributeDescriptionModel ad)

Adds an attribute description in the user defined record.

Parameters:

ad - The attribute description to add in the UDR

removeAttributeDescription

public void removeAttributeDescription(int index)

Removes an attribute description from the user defined record.

Parameters:

index - The index of the attribute description to delete

isValid

public boolean isValid()

Checks if this user defined record is valid; Each included attribute description has also 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 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