edu.uci.isr.xarch.messages
Interface IGenericMessage

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

INamedPropertyMessage

All Known Implementing Classes:

GenericMessageImpl, NamedPropertyMessageImpl

public interface IGenericMessage

extends IXArchElement

Interface for accessing objects of the GenericMessage xsi:type in the messages namespace.

Author:

Automatically generated by xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Method Summary

void	clearCount() Clear the count from this GenericMessage.
void	clearDescription() Clear the description from this GenericMessage.
void	clearId() Remove the id attribute from this GenericMessage.
void	clearKind() Remove the kind attribute from this GenericMessage.
void	clearType() Clear the type from this GenericMessage.
ICount	getCount() Get the count from this GenericMessage.
IDescription	getDescription() Get the description from this GenericMessage.
String	getId() Get the id attribute from this GenericMessage.
String	getKind() Get the kind attribute from this GenericMessage.
IMessageType	getType() Get the type from this GenericMessage.
boolean	hasCount(ICount countToCheck) Determine if this GenericMessage has the given count
boolean	hasDescription(IDescription descriptionToCheck) Determine if this GenericMessage has the given description
boolean	hasId(String id) Determine if the id attribute on this GenericMessage has the given value.
boolean	hasKind(String kind) Determine if the kind attribute on this GenericMessage has the given value.
boolean	hasType(IMessageType typeToCheck) Determine if this GenericMessage has the given type
boolean	isEqual(IGenericMessage GenericMessageToCheck) Determine if another GenericMessage has the same id as this one.
boolean	isEquivalent(IGenericMessage GenericMessageToCheck) Determine if another GenericMessage is equivalent to this one, ignoring ID's.
void	setCount(ICount value) Set the count for this GenericMessage.
void	setDescription(IDescription value) Set the description for this GenericMessage.
void	setId(String id) Set the id attribute on this GenericMessage.
void	setKind(String kind) Set the kind attribute on this GenericMessage.
void	setType(IMessageType value) Set the type for this GenericMessage.

Methods inherited from interface edu.uci.isr.xarch.IXArchElement

cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

setId

public void setId(String id)

Set the id attribute on this GenericMessage.

Parameters:

id - id

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearId

public void clearId()

Remove the id attribute from this GenericMessage.

getId

public String getId()

Get the id attribute from this GenericMessage. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

id on this GenericMessage

hasId

public boolean hasId(String id)

Determine if the id attribute on this GenericMessage has the given value.

Parameters:

id - Attribute value to compare

Returns:

true if they match; false otherwise.

setKind

public void setKind(String kind)

Set the kind attribute on this GenericMessage.

Parameters:

kind - kind

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearKind

public void clearKind()

Remove the kind attribute from this GenericMessage.

getKind

public String getKind()

Get the kind attribute from this GenericMessage. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

kind on this GenericMessage

hasKind

public boolean hasKind(String kind)

Determine if the kind attribute on this GenericMessage has the given value.

Parameters:

kind - Attribute value to compare

Returns:

true if they match; false otherwise.

setDescription

public void setDescription(IDescription value)

Set the description for this GenericMessage.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this GenericMessage.

getDescription

public IDescription getDescription()

Get the description from this GenericMessage.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this GenericMessage has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

setCount

public void setCount(ICount value)

Set the count for this GenericMessage.

Parameters:

value - new count

clearCount

public void clearCount()

Clear the count from this GenericMessage.

getCount

public ICount getCount()

Get the count from this GenericMessage.

Returns:

count

hasCount

public boolean hasCount(ICount countToCheck)

Determine if this GenericMessage has the given count

Parameters:

countToCheck - count to compare

Returns:

true if the counts are equivalent, false otherwise

setType

public void setType(IMessageType value)

Set the type for this GenericMessage.

Parameters:

value - new type

clearType

public void clearType()

Clear the type from this GenericMessage.

getType

public IMessageType getType()

Get the type from this GenericMessage.

Returns:

type

hasType

public boolean hasType(IMessageType typeToCheck)

Determine if this GenericMessage has the given type

Parameters:

typeToCheck - type to compare

Returns:

true if the types are equivalent, false otherwise

isEqual

public boolean isEqual(IGenericMessage GenericMessageToCheck)

Determine if another GenericMessage has the same id as this one.

Parameters:

GenericMessageToCheck - GenericMessage to compare with this one.

isEquivalent

public boolean isEquivalent(IGenericMessage GenericMessageToCheck)

Determine if another GenericMessage is equivalent to this one, ignoring ID's.

Parameters:

GenericMessageToCheck - GenericMessage to compare to this one.

Returns:

true if all the child elements of this GenericMessage are equivalent, false otherwise.