edu.uci.isr.xarch.types
Interface IPrescribedInterfaceInstance

All Superinterfaces:

IInterfaceInstance, IXArchElement

All Known Implementing Classes:

PrescribedInterfaceInstanceImpl

public interface IPrescribedInterfaceInstance

extends IInterfaceInstance, IXArchElement

Interface for accessing objects of the PrescribedInterfaceInstance xsi:type in the types namespace. Extends and inherits the properties of the InterfaceInstance xsi:type.

Author:

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	clearStructure() Clear the structure from this PrescribedInterfaceInstance.
IXMLLink	getStructure() Get the structure from this PrescribedInterfaceInstance.
boolean	hasStructure(IXMLLink structureToCheck) Determine if this PrescribedInterfaceInstance has the given structure
boolean	isEquivalent(IPrescribedInterfaceInstance PrescribedInterfaceInstanceToCheck) Determine if another PrescribedInterfaceInstance is equivalent to this one, ignoring ID's.
void	setStructure(IXMLLink value) Set the structure for this PrescribedInterfaceInstance.

Methods inherited from interface edu.uci.isr.xarch.instance.IInterfaceInstance

clearDescription, clearDirection, clearId, getDescription, getDirection, getId, hasDescription, hasDirection, hasId, isEqual, isEquivalent, setDescription, setDirection, setId

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

setStructure

public void setStructure(IXMLLink value)

Set the structure for this PrescribedInterfaceInstance.

Parameters:

value - new structure

clearStructure

public void clearStructure()

Clear the structure from this PrescribedInterfaceInstance.

getStructure

public IXMLLink getStructure()

Get the structure from this PrescribedInterfaceInstance.

Returns:

structure

hasStructure

public boolean hasStructure(IXMLLink structureToCheck)

Determine if this PrescribedInterfaceInstance has the given structure

Parameters:

structureToCheck - structure to compare

Returns:

true if the structures are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IPrescribedInterfaceInstance PrescribedInterfaceInstanceToCheck)

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

Parameters:

PrescribedInterfaceInstanceToCheck - PrescribedInterfaceInstance to compare to this one.

Returns:

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