edu.uci.isr.xarch.tronanalysis
Interface ITest

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

TestImpl

public interface ITest

extends IXArchElement

Interface for accessing objects of the Test xsi:type in the tronanalysis 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 Test.
void	clearEnabled() Remove the enabled attribute from this Test.
void	clearId() Remove the id attribute from this Test.
IDescription	getDescription() Get the description from this Test.
String	getEnabled() Get the enabled attribute from this Test.
String	getId() Get the id attribute from this Test.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this Test has the given description
boolean	hasEnabled(String enabled) Determine if the enabled attribute on this Test has the given value.
boolean	hasId(String id) Determine if the id attribute on this Test has the given value.
boolean	isEqual(ITest TestToCheck) Determine if another Test has the same id as this one.
boolean	isEquivalent(ITest TestToCheck) Determine if another Test is equivalent to this one, ignoring ID's.
void	setDescription(IDescription value) Set the description for this Test.
void	setEnabled(String enabled) Set the enabled attribute on this Test.
void	setId(String id) Set the id attribute on this Test.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

Determine if the id attribute on this Test has the given value.

Parameters:

id - Attribute value to compare

Returns:

true if they match; false otherwise.

setEnabled

public void setEnabled(String enabled)

Set the enabled attribute on this Test.

Parameters:

enabled - enabled

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearEnabled

public void clearEnabled()

Remove the enabled attribute from this Test.

getEnabled

public String getEnabled()

Get the enabled attribute from this Test. 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:

enabled on this Test

hasEnabled

public boolean hasEnabled(String enabled)

Determine if the enabled attribute on this Test has the given value.

Parameters:

enabled - Attribute value to compare

Returns:

true if they match; false otherwise.

setDescription

public void setDescription(IDescription value)

Set the description for this Test.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this Test.

getDescription

public IDescription getDescription()

Get the description from this Test.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this Test has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

isEqual

public boolean isEqual(ITest TestToCheck)

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

Parameters:

TestToCheck - Test to compare with this one.

isEquivalent

public boolean isEquivalent(ITest TestToCheck)

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

Parameters:

TestToCheck - Test to compare to this one.

Returns:

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