edu.uci.isr.xarch.types
Interface IInterfaceType

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

IInterfaceTypeImpl, IInterfaceTypeImplVers

All Known Implementing Classes:

InterfaceTypeImpl, InterfaceTypeImplImpl, InterfaceTypeImplVersImpl

public interface IInterfaceType

extends IXArchElement

Interface for accessing objects of the InterfaceType xsi:type in the types 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	clearDescription() Clear the description from this InterfaceType.
void	clearId() Remove the id attribute from this InterfaceType.
IDescription	getDescription() Get the description from this InterfaceType.
String	getId() Get the id attribute from this InterfaceType.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this InterfaceType has the given description
boolean	hasId(String id) Determine if the id attribute on this InterfaceType has the given value.
boolean	isEqual(IInterfaceType InterfaceTypeToCheck) Determine if another InterfaceType has the same id as this one.
boolean	isEquivalent(IInterfaceType InterfaceTypeToCheck) Determine if another InterfaceType is equivalent to this one, ignoring ID's.
void	setDescription(IDescription value) Set the description for this InterfaceType.
void	setId(String id) Set the id attribute on this InterfaceType.

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 InterfaceType.

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 InterfaceType.

getId

public String getId()

Get the id attribute from this InterfaceType. 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 InterfaceType

hasId

public boolean hasId(String id)

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

Parameters:

id - Attribute value to compare

Returns:

true if they match; false otherwise.

setDescription

public void setDescription(IDescription value)

Set the description for this InterfaceType.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this InterfaceType.

getDescription

public IDescription getDescription()

Get the description from this InterfaceType.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this InterfaceType has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

isEqual

public boolean isEqual(IInterfaceType InterfaceTypeToCheck)

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

Parameters:

InterfaceTypeToCheck - InterfaceType to compare with this one.

isEquivalent

public boolean isEquivalent(IInterfaceType InterfaceTypeToCheck)

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

Parameters:

InterfaceTypeToCheck - InterfaceType to compare to this one.

Returns:

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