ca.infoway.messagebuilder.xml
Class MessagePart

java.lang.Object
  ca.infoway.messagebuilder.xml.MessagePart

All Implemented Interfaces:

Named, Documentable, HasDifferences

public class MessagePart
extends Object
implements Documentable, HasDifferences, Named

A message part. An example message part might be represent the type "MCCI_MT700751CA.ControlActEvent".

Author:

Intelliware Development

Constructor Summary

MessagePart()
Default constructor.

MessagePart(String name)
Default constructor.

Method Summary

void	addDifference(Difference difference)
static MessagePart	createAbstractPart(String name) Factory method for creating an abstract message part.
List<Difference>	getDifferences() Records the differences between message parts of different release versions during regen.
Documentation	getDocumentation() Get the documentation.
String	getName() Get the name.
Relationship	getRelationship(String name) Get a specific relationship by name.
Relationship	getRelationship(String name, Interaction interaction) Get a specific relationship by name.
List<Relationship>	getRelationships() Get the list of relationships.
RimClass	getRimClass()
List<String>	getSpecializationChilds() Get the list of names of the child types.
boolean	isAbstract() Get the abstractness.
void	setAbstract(boolean isAbstract) Set the abstractness.
void	setDifferences(List<Difference> differences)
void	setDocumentation(Documentation documentation) Set the documentation.
void	setName(String name) Set the name.
void	setRelationships(List<Relationship> relationships) Set the list of relationships.
void	setRimClass(RimClass rimClass)
void	setSpecializationChilds(List<String> specializationChilds) Set the list of child types.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagePart

public MessagePart()

Default constructor.

MessagePart

public MessagePart(String name)

Default constructor.

Parameters:

name - - the part type name

Method Detail

getName

public String getName()

Get the name.

Specified by:

getName in interface Named

Returns:

the name.

setName

public void setName(String name)

Set the name.

Parameters:

name - - the new name

getDocumentation

public Documentation getDocumentation()

Get the documentation.

Specified by:

getDocumentation in interface Documentable

Returns:

the documentation.

setDocumentation

public void setDocumentation(Documentation documentation)

Set the documentation.

Specified by:

setDocumentation in interface Documentable

Parameters:

documentation - - the new documentation value

getRelationships

public List<Relationship> getRelationships()

Get the list of relationships.

Returns:

- the relationships

setRelationships

public void setRelationships(List<Relationship> relationships)

Set the list of relationships.

Parameters:

relationships - - the new value

isAbstract

public boolean isAbstract()

Get the abstractness.

Returns:

true if the message part is abstract; false otherwise.

setAbstract

public void setAbstract(boolean isAbstract)

Set the abstractness.

Parameters:

isAbstract - - the new abstractness value

createAbstractPart

public static MessagePart createAbstractPart(String name)

Factory method for creating an abstract message part.

Parameters:

name - - the type name of the message part

Returns:

- the newly-constructed message part

getSpecializationChilds

public List<String> getSpecializationChilds()

Get the list of names of the child types.

Returns:

the child types.

setSpecializationChilds

public void setSpecializationChilds(List<String> specializationChilds)

Set the list of child types.

Parameters:

specializationChilds - - the new child types

getRelationship

public Relationship getRelationship(String name)

Get a specific relationship by name.

Parameters:

name - - the name of the relationship

Returns:

- the relationship

getRelationship

public Relationship getRelationship(String name,
                                    Interaction interaction)

Get a specific relationship by name.

Parameters:

name - - the name of the relationship

interaction - - the interaction (used to resolve names of template parameters) or null

Returns:

- the relationship

getDifferences

public List<Difference> getDifferences()

Records the differences between message parts of different release versions during regen.

Specified by:

getDifferences in interface HasDifferences

Returns:

list of differences

setDifferences

public void setDifferences(List<Difference> differences)

addDifference

public void addDifference(Difference difference)

Specified by:

addDifference in interface HasDifferences

getRimClass

public RimClass getRimClass()

setRimClass

public void setRimClass(RimClass rimClass)