edu.uci.isr.xarch.types
Interface IPrescribedLinkInstance

All Superinterfaces:

ILinkInstance, IXArchElement

All Known Implementing Classes:

PrescribedLinkInstanceImpl

public interface IPrescribedLinkInstance

extends ILinkInstance, IXArchElement

Interface for accessing objects of the PrescribedLinkInstance xsi:type in the types namespace. Extends and inherits the properties of the LinkInstance 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 PrescribedLinkInstance.
IXMLLink	getStructure() Get the structure from this PrescribedLinkInstance.
boolean	hasStructure(IXMLLink structureToCheck) Determine if this PrescribedLinkInstance has the given structure
boolean	isEquivalent(IPrescribedLinkInstance PrescribedLinkInstanceToCheck) Determine if another PrescribedLinkInstance is equivalent to this one, ignoring ID's.
void	setStructure(IXMLLink value) Set the structure for this PrescribedLinkInstance.

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

addPoint, addPoints, clearDescription, clearId, clearPoints, getAllPoints, getDescription, getId, hasAllPoints, hasDescription, hasId, hasPoint, hasPoints, isEqual, isEquivalent, removePoint, removePoints, setDescription, 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 PrescribedLinkInstance.

Parameters:

value - new structure

clearStructure

public void clearStructure()

Clear the structure from this PrescribedLinkInstance.

getStructure

public IXMLLink getStructure()

Get the structure from this PrescribedLinkInstance.

Returns:

structure

hasStructure

public boolean hasStructure(IXMLLink structureToCheck)

Determine if this PrescribedLinkInstance has the given structure

Parameters:

structureToCheck - structure to compare

Returns:

true if the structures are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IPrescribedLinkInstance PrescribedLinkInstanceToCheck)

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

Parameters:

PrescribedLinkInstanceToCheck - PrescribedLinkInstance to compare to this one.

Returns:

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