edu.uci.isr.xarch.types
Interface ISignatureInterfaceMapping

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

IOptionalSignatureInterfaceMapping

All Known Implementing Classes:

OptionalSignatureInterfaceMappingImpl, SignatureInterfaceMappingImpl

public interface ISignatureInterfaceMapping

extends IXArchElement

Interface for accessing objects of the SignatureInterfaceMapping 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 SignatureInterfaceMapping.
void	clearId() Remove the id attribute from this SignatureInterfaceMapping.
void	clearInnerInterface() Clear the innerInterface from this SignatureInterfaceMapping.
void	clearOuterSignature() Clear the outerSignature from this SignatureInterfaceMapping.
IDescription	getDescription() Get the description from this SignatureInterfaceMapping.
String	getId() Get the id attribute from this SignatureInterfaceMapping.
IXMLLink	getInnerInterface() Get the innerInterface from this SignatureInterfaceMapping.
IXMLLink	getOuterSignature() Get the outerSignature from this SignatureInterfaceMapping.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this SignatureInterfaceMapping has the given description
boolean	hasId(String id) Determine if the id attribute on this SignatureInterfaceMapping has the given value.
boolean	hasInnerInterface(IXMLLink innerInterfaceToCheck) Determine if this SignatureInterfaceMapping has the given innerInterface
boolean	hasOuterSignature(IXMLLink outerSignatureToCheck) Determine if this SignatureInterfaceMapping has the given outerSignature
boolean	isEqual(ISignatureInterfaceMapping SignatureInterfaceMappingToCheck) Determine if another SignatureInterfaceMapping has the same id as this one.
boolean	isEquivalent(ISignatureInterfaceMapping SignatureInterfaceMappingToCheck) Determine if another SignatureInterfaceMapping is equivalent to this one, ignoring ID's.
void	setDescription(IDescription value) Set the description for this SignatureInterfaceMapping.
void	setId(String id) Set the id attribute on this SignatureInterfaceMapping.
void	setInnerInterface(IXMLLink value) Set the innerInterface for this SignatureInterfaceMapping.
void	setOuterSignature(IXMLLink value) Set the outerSignature for this SignatureInterfaceMapping.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

Determine if the id attribute on this SignatureInterfaceMapping 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 SignatureInterfaceMapping.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this SignatureInterfaceMapping.

getDescription

public IDescription getDescription()

Get the description from this SignatureInterfaceMapping.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this SignatureInterfaceMapping has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

setOuterSignature

public void setOuterSignature(IXMLLink value)

Set the outerSignature for this SignatureInterfaceMapping.

Parameters:

value - new outerSignature

clearOuterSignature

public void clearOuterSignature()

Clear the outerSignature from this SignatureInterfaceMapping.

getOuterSignature

public IXMLLink getOuterSignature()

Get the outerSignature from this SignatureInterfaceMapping.

Returns:

outerSignature

hasOuterSignature

public boolean hasOuterSignature(IXMLLink outerSignatureToCheck)

Determine if this SignatureInterfaceMapping has the given outerSignature

Parameters:

outerSignatureToCheck - outerSignature to compare

Returns:

true if the outerSignatures are equivalent, false otherwise

setInnerInterface

public void setInnerInterface(IXMLLink value)

Set the innerInterface for this SignatureInterfaceMapping.

Parameters:

value - new innerInterface

clearInnerInterface

public void clearInnerInterface()

Clear the innerInterface from this SignatureInterfaceMapping.

getInnerInterface

public IXMLLink getInnerInterface()

Get the innerInterface from this SignatureInterfaceMapping.

Returns:

innerInterface

hasInnerInterface

public boolean hasInnerInterface(IXMLLink innerInterfaceToCheck)

Determine if this SignatureInterfaceMapping has the given innerInterface

Parameters:

innerInterfaceToCheck - innerInterface to compare

Returns:

true if the innerInterfaces are equivalent, false otherwise

isEqual

public boolean isEqual(ISignatureInterfaceMapping SignatureInterfaceMappingToCheck)

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

Parameters:

SignatureInterfaceMappingToCheck - SignatureInterfaceMapping to compare with this one.

isEquivalent

public boolean isEquivalent(ISignatureInterfaceMapping SignatureInterfaceMappingToCheck)

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

Parameters:

SignatureInterfaceMappingToCheck - SignatureInterfaceMapping to compare to this one.

Returns:

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