edu.uci.isr.xarch.options
Interface IOptionalLink

All Superinterfaces:

ILink, IXArchElement

All Known Implementing Classes:

OptionalLinkImpl

public interface IOptionalLink

extends ILink, IXArchElement

Interface for accessing objects of the OptionalLink xsi:type in the options namespace. Extends and inherits the properties of the Link 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	clearOptional() Clear the optional from this OptionalLink.
IOptional	getOptional() Get the optional from this OptionalLink.
boolean	hasOptional(IOptional optionalToCheck) Determine if this OptionalLink has the given optional
boolean	isEquivalent(IOptionalLink OptionalLinkToCheck) Determine if another OptionalLink is equivalent to this one, ignoring ID's.
void	setOptional(IOptional value) Set the optional for this OptionalLink.

Methods inherited from interface edu.uci.isr.xarch.types.ILink

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

setOptional

public void setOptional(IOptional value)

Set the optional for this OptionalLink.

Parameters:

value - new optional

clearOptional

public void clearOptional()

Clear the optional from this OptionalLink.

getOptional

public IOptional getOptional()

Get the optional from this OptionalLink.

Returns:

optional

hasOptional

public boolean hasOptional(IOptional optionalToCheck)

Determine if this OptionalLink has the given optional

Parameters:

optionalToCheck - optional to compare

Returns:

true if the optionals are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IOptionalLink OptionalLinkToCheck)

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

Parameters:

OptionalLinkToCheck - OptionalLink to compare to this one.

Returns:

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