xArch/xADL 2.0 Data Binding Library

edu.uci.isr.xarch.variants
Interface IVariant

All Superinterfaces:
IXArchElement
All Known Implementing Classes:
VariantImpl

public interface IVariant
extends IXArchElement

Interface for accessing objects of the Variant xsi:type in the variants 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 clearGuard()
          Clear the guard from this Variant.
 void clearVariantType()
          Clear the variantType from this Variant.
 IGuard getGuard()
          Get the guard from this Variant.
 IXMLLink getVariantType()
          Get the variantType from this Variant.
 boolean hasGuard(IGuard guardToCheck)
          Determine if this Variant has the given guard
 boolean hasVariantType(IXMLLink variantTypeToCheck)
          Determine if this Variant has the given variantType
 boolean isEquivalent(IVariant VariantToCheck)
          Determine if another Variant is equivalent to this one, ignoring ID's.
 void setGuard(IGuard value)
          Set the guard for this Variant.
 void setVariantType(IXMLLink value)
          Set the variantType for this Variant.
 
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

setGuard

public void setGuard(IGuard value)
Set the guard for this Variant.

Parameters:
value - new guard

clearGuard

public void clearGuard()
Clear the guard from this Variant.


getGuard

public IGuard getGuard()
Get the guard from this Variant.

Returns:
guard

hasGuard

public boolean hasGuard(IGuard guardToCheck)
Determine if this Variant has the given guard

Parameters:
guardToCheck - guard to compare
Returns:
true if the guards are equivalent, false otherwise

setVariantType

public void setVariantType(IXMLLink value)
Set the variantType for this Variant.

Parameters:
value - new variantType

clearVariantType

public void clearVariantType()
Clear the variantType from this Variant.


getVariantType

public IXMLLink getVariantType()
Get the variantType from this Variant.

Returns:
variantType

hasVariantType

public boolean hasVariantType(IXMLLink variantTypeToCheck)
Determine if this Variant has the given variantType

Parameters:
variantTypeToCheck - variantType to compare
Returns:
true if the variantTypes are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IVariant VariantToCheck)
Determine if another Variant is equivalent to this one, ignoring ID's.

Parameters:
VariantToCheck - Variant to compare to this one.
Returns:
true if all the child elements of this Variant are equivalent, false otherwise.

xArch/xADL 2.0 Data Binding Library