edu.uci.isr.xarch.pladiff
Interface IAddOptional

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

AddOptionalImpl

public interface IAddOptional

extends IXArchElement

Interface for accessing objects of the AddOptional xsi:type in the pladiff 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	clearElementDescription() Clear the elementDescription from this AddOptional.
void	clearOptional() Clear the optional from this AddOptional.
IDescription	getElementDescription() Get the elementDescription from this AddOptional.
IOptional	getOptional() Get the optional from this AddOptional.
boolean	hasElementDescription(IDescription elementDescriptionToCheck) Determine if this AddOptional has the given elementDescription
boolean	hasOptional(IOptional optionalToCheck) Determine if this AddOptional has the given optional
boolean	isEquivalent(IAddOptional AddOptionalToCheck) Determine if another AddOptional is equivalent to this one, ignoring ID's.
void	setElementDescription(IDescription value) Set the elementDescription for this AddOptional.
void	setOptional(IOptional value) Set the optional for this AddOptional.

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

setElementDescription

public void setElementDescription(IDescription value)

Set the elementDescription for this AddOptional.

Parameters:

value - new elementDescription

clearElementDescription

public void clearElementDescription()

Clear the elementDescription from this AddOptional.

getElementDescription

public IDescription getElementDescription()

Get the elementDescription from this AddOptional.

Returns:

elementDescription

hasElementDescription

public boolean hasElementDescription(IDescription elementDescriptionToCheck)

Determine if this AddOptional has the given elementDescription

Parameters:

elementDescriptionToCheck - elementDescription to compare

Returns:

true if the elementDescriptions are equivalent, false otherwise

setOptional

public void setOptional(IOptional value)

Set the optional for this AddOptional.

Parameters:

value - new optional

clearOptional

public void clearOptional()

Clear the optional from this AddOptional.

getOptional

public IOptional getOptional()

Get the optional from this AddOptional.

Returns:

optional

hasOptional

public boolean hasOptional(IOptional optionalToCheck)

Determine if this AddOptional has the given optional

Parameters:

optionalToCheck - optional to compare

Returns:

true if the optionals are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IAddOptional AddOptionalToCheck)

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

Parameters:

AddOptionalToCheck - AddOptional to compare to this one.

Returns:

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