edu.uci.isr.xarch.types
Interface IInterface

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

IOptionalInterface, IOptionalInterfacePosition

All Known Implementing Classes:

InterfaceImpl, OptionalInterfaceImpl, OptionalInterfacePositionImpl

public interface IInterface

extends IXArchElement

Interface for accessing objects of the Interface xsi:type in the types 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 Interface.
void	clearDirection() Clear the direction from this Interface.
void	clearId() Remove the id attribute from this Interface.
void	clearSignature() Clear the signature from this Interface.
void	clearType() Clear the type from this Interface.
IDescription	getDescription() Get the description from this Interface.
IDirection	getDirection() Get the direction from this Interface.
String	getId() Get the id attribute from this Interface.
IXMLLink	getSignature() Get the signature from this Interface.
IXMLLink	getType() Get the type from this Interface.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this Interface has the given description
boolean	hasDirection(IDirection directionToCheck) Determine if this Interface has the given direction
boolean	hasId(String id) Determine if the id attribute on this Interface has the given value.
boolean	hasSignature(IXMLLink signatureToCheck) Determine if this Interface has the given signature
boolean	hasType(IXMLLink typeToCheck) Determine if this Interface has the given type
boolean	isEqual(IInterface InterfaceToCheck) Determine if another Interface has the same id as this one.
boolean	isEquivalent(IInterface InterfaceToCheck) Determine if another Interface is equivalent to this one, ignoring ID's.
void	setDescription(IDescription value) Set the description for this Interface.
void	setDirection(IDirection value) Set the direction for this Interface.
void	setId(String id) Set the id attribute on this Interface.
void	setSignature(IXMLLink value) Set the signature for this Interface.
void	setType(IXMLLink value) Set the type for this Interface.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

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

Parameters:

id - Attribute value to compare

Returns:

true if they match; false otherwise.

setDescription

public void setDescription(IDescription value)

Set the description for this Interface.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this Interface.

getDescription

public IDescription getDescription()

Get the description from this Interface.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this Interface has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

setDirection

public void setDirection(IDirection value)

Set the direction for this Interface.

Parameters:

value - new direction

clearDirection

public void clearDirection()

Clear the direction from this Interface.

getDirection

public IDirection getDirection()

Get the direction from this Interface.

Returns:

direction

hasDirection

public boolean hasDirection(IDirection directionToCheck)

Determine if this Interface has the given direction

Parameters:

directionToCheck - direction to compare

Returns:

true if the directions are equivalent, false otherwise

setType

public void setType(IXMLLink value)

Set the type for this Interface.

Parameters:

value - new type

clearType

public void clearType()

Clear the type from this Interface.

getType

public IXMLLink getType()

Get the type from this Interface.

Returns:

type

hasType

public boolean hasType(IXMLLink typeToCheck)

Determine if this Interface has the given type

Parameters:

typeToCheck - type to compare

Returns:

true if the types are equivalent, false otherwise

setSignature

public void setSignature(IXMLLink value)

Set the signature for this Interface.

Parameters:

value - new signature

clearSignature

public void clearSignature()

Clear the signature from this Interface.

getSignature

public IXMLLink getSignature()

Get the signature from this Interface.

Returns:

signature

hasSignature

public boolean hasSignature(IXMLLink signatureToCheck)

Determine if this Interface has the given signature

Parameters:

signatureToCheck - signature to compare

Returns:

true if the signatures are equivalent, false otherwise

isEqual

public boolean isEqual(IInterface InterfaceToCheck)

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

Parameters:

InterfaceToCheck - Interface to compare with this one.

isEquivalent

public boolean isEquivalent(IInterface InterfaceToCheck)

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

Parameters:

InterfaceToCheck - Interface to compare to this one.

Returns:

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