edu.uci.isr.xarch.instance
Interface IInterfaceInstance

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

IPrescribedInterfaceInstance

All Known Implementing Classes:

InterfaceInstanceImpl, PrescribedInterfaceInstanceImpl

public interface IInterfaceInstance

extends IXArchElement

Interface for accessing objects of the InterfaceInstance 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 InterfaceInstance.
void	clearDirection() Clear the direction from this InterfaceInstance.
void	clearId() Remove the id attribute from this InterfaceInstance.
IDescription	getDescription() Get the description from this InterfaceInstance.
IDirection	getDirection() Get the direction from this InterfaceInstance.
String	getId() Get the id attribute from this InterfaceInstance.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this InterfaceInstance has the given description
boolean	hasDirection(IDirection directionToCheck) Determine if this InterfaceInstance has the given direction
boolean	hasId(String id) Determine if the id attribute on this InterfaceInstance has the given value.
boolean	isEqual(IInterfaceInstance InterfaceInstanceToCheck) Determine if another InterfaceInstance has the same id as this one.
boolean	isEquivalent(IInterfaceInstance InterfaceInstanceToCheck) Determine if another InterfaceInstance is equivalent to this one, ignoring ID's.
void	setDescription(IDescription value) Set the description for this InterfaceInstance.
void	setDirection(IDirection value) Set the direction for this InterfaceInstance.
void	setId(String id) Set the id attribute on this InterfaceInstance.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

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

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this InterfaceInstance.

getDescription

public IDescription getDescription()

Get the description from this InterfaceInstance.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this InterfaceInstance has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

setDirection

public void setDirection(IDirection value)

Set the direction for this InterfaceInstance.

Parameters:

value - new direction

clearDirection

public void clearDirection()

Clear the direction from this InterfaceInstance.

getDirection

public IDirection getDirection()

Get the direction from this InterfaceInstance.

Returns:

direction

hasDirection

public boolean hasDirection(IDirection directionToCheck)

Determine if this InterfaceInstance has the given direction

Parameters:

directionToCheck - direction to compare

Returns:

true if the directions are equivalent, false otherwise

isEqual

public boolean isEqual(IInterfaceInstance InterfaceInstanceToCheck)

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

Parameters:

InterfaceInstanceToCheck - InterfaceInstance to compare with this one.

isEquivalent

public boolean isEquivalent(IInterfaceInstance InterfaceInstanceToCheck)

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

Parameters:

InterfaceInstanceToCheck - InterfaceInstance to compare to this one.

Returns:

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