edu.uci.isr.xarch.instance
Interface IInterfaceInstanceMapping

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

InterfaceInstanceMappingImpl

public interface IInterfaceInstanceMapping

extends IXArchElement

Interface for accessing objects of the InterfaceInstanceMapping xsi:type in the instance 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 InterfaceInstanceMapping.
void	clearId() Remove the id attribute from this InterfaceInstanceMapping.
void	clearInnerInterfaceInstance() Clear the innerInterfaceInstance from this InterfaceInstanceMapping.
void	clearOuterInterfaceInstance() Clear the outerInterfaceInstance from this InterfaceInstanceMapping.
IDescription	getDescription() Get the description from this InterfaceInstanceMapping.
String	getId() Get the id attribute from this InterfaceInstanceMapping.
IXMLLink	getInnerInterfaceInstance() Get the innerInterfaceInstance from this InterfaceInstanceMapping.
IXMLLink	getOuterInterfaceInstance() Get the outerInterfaceInstance from this InterfaceInstanceMapping.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this InterfaceInstanceMapping has the given description
boolean	hasId(String id) Determine if the id attribute on this InterfaceInstanceMapping has the given value.
boolean	hasInnerInterfaceInstance(IXMLLink innerInterfaceInstanceToCheck) Determine if this InterfaceInstanceMapping has the given innerInterfaceInstance
boolean	hasOuterInterfaceInstance(IXMLLink outerInterfaceInstanceToCheck) Determine if this InterfaceInstanceMapping has the given outerInterfaceInstance
boolean	isEqual(IInterfaceInstanceMapping InterfaceInstanceMappingToCheck) Determine if another InterfaceInstanceMapping has the same id as this one.
boolean	isEquivalent(IInterfaceInstanceMapping InterfaceInstanceMappingToCheck) Determine if another InterfaceInstanceMapping is equivalent to this one, ignoring ID's.
void	setDescription(IDescription value) Set the description for this InterfaceInstanceMapping.
void	setId(String id) Set the id attribute on this InterfaceInstanceMapping.
void	setInnerInterfaceInstance(IXMLLink value) Set the innerInterfaceInstance for this InterfaceInstanceMapping.
void	setOuterInterfaceInstance(IXMLLink value) Set the outerInterfaceInstance for this InterfaceInstanceMapping.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

Determine if the id attribute on this InterfaceInstanceMapping 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 InterfaceInstanceMapping.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this InterfaceInstanceMapping.

getDescription

public IDescription getDescription()

Get the description from this InterfaceInstanceMapping.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this InterfaceInstanceMapping has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

setOuterInterfaceInstance

public void setOuterInterfaceInstance(IXMLLink value)

Set the outerInterfaceInstance for this InterfaceInstanceMapping.

Parameters:

value - new outerInterfaceInstance

clearOuterInterfaceInstance

public void clearOuterInterfaceInstance()

Clear the outerInterfaceInstance from this InterfaceInstanceMapping.

getOuterInterfaceInstance

public IXMLLink getOuterInterfaceInstance()

Get the outerInterfaceInstance from this InterfaceInstanceMapping.

Returns:

outerInterfaceInstance

hasOuterInterfaceInstance

public boolean hasOuterInterfaceInstance(IXMLLink outerInterfaceInstanceToCheck)

Determine if this InterfaceInstanceMapping has the given outerInterfaceInstance

Parameters:

outerInterfaceInstanceToCheck - outerInterfaceInstance to compare

Returns:

true if the outerInterfaceInstances are equivalent, false otherwise

setInnerInterfaceInstance

public void setInnerInterfaceInstance(IXMLLink value)

Set the innerInterfaceInstance for this InterfaceInstanceMapping.

Parameters:

value - new innerInterfaceInstance

clearInnerInterfaceInstance

public void clearInnerInterfaceInstance()

Clear the innerInterfaceInstance from this InterfaceInstanceMapping.

getInnerInterfaceInstance

public IXMLLink getInnerInterfaceInstance()

Get the innerInterfaceInstance from this InterfaceInstanceMapping.

Returns:

innerInterfaceInstance

hasInnerInterfaceInstance

public boolean hasInnerInterfaceInstance(IXMLLink innerInterfaceInstanceToCheck)

Determine if this InterfaceInstanceMapping has the given innerInterfaceInstance

Parameters:

innerInterfaceInstanceToCheck - innerInterfaceInstance to compare

Returns:

true if the innerInterfaceInstances are equivalent, false otherwise

isEqual

public boolean isEqual(IInterfaceInstanceMapping InterfaceInstanceMappingToCheck)

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

Parameters:

InterfaceInstanceMappingToCheck - InterfaceInstanceMapping to compare with this one.

isEquivalent

public boolean isEquivalent(IInterfaceInstanceMapping InterfaceInstanceMappingToCheck)

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

Parameters:

InterfaceInstanceMappingToCheck - InterfaceInstanceMapping to compare to this one.

Returns:

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