xArch/xADL 2.0 Data Binding Library

edu.uci.isr.xarch.pladiff
Interface IAddLink

All Superinterfaces:
IXArchElement
All Known Implementing Classes:
AddLinkImpl

public interface IAddLink
extends IXArchElement

Interface for accessing objects of the AddLink 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 addInterfaceEndPoint(IInterfaceEndPoint newInterfaceEndPoint)
          Add a interfaceEndPoint to this AddLink.
 void addInterfaceEndPoints(Collection interfaceEndPoints)
          Add a collection of interfaceEndPoints to this AddLink.
 void clearInterfaceEndPoints()
          Remove all interfaceEndPoints from this AddLink.
 void clearLink()
          Clear the link from this AddLink.
 Collection getAllInterfaceEndPoints()
          Get all the interfaceEndPoints from this AddLink.
 ILink getLink()
          Get the link from this AddLink.
 boolean hasAllInterfaceEndPoints(Collection interfaceEndPointsToCheck)
          Determine if this AddLink contains each element in the given set of interfaceEndPoints.
 boolean hasInterfaceEndPoint(IInterfaceEndPoint interfaceEndPointToCheck)
          Determine if this AddLink contains a given interfaceEndPoint.
 Collection hasInterfaceEndPoints(Collection interfaceEndPointsToCheck)
          Determine if this AddLink contains the given set of interfaceEndPoints.
 boolean hasLink(ILink linkToCheck)
          Determine if this AddLink has the given link
 boolean isEquivalent(IAddLink AddLinkToCheck)
          Determine if another AddLink is equivalent to this one, ignoring ID's.
 void removeInterfaceEndPoint(IInterfaceEndPoint interfaceEndPointToRemove)
          Remove the given interfaceEndPoint from this AddLink.
 void removeInterfaceEndPoints(Collection interfaceEndPoints)
          Remove all the given interfaceEndPoints from this AddLink.
 void setLink(ILink value)
          Set the link for this AddLink.
 
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

setLink

public void setLink(ILink value)
Set the link for this AddLink.

Parameters:
value - new link

clearLink

public void clearLink()
Clear the link from this AddLink.


getLink

public ILink getLink()
Get the link from this AddLink.

Returns:
link

hasLink

public boolean hasLink(ILink linkToCheck)
Determine if this AddLink has the given link

Parameters:
linkToCheck - link to compare
Returns:
true if the links are equivalent, false otherwise

addInterfaceEndPoint

public void addInterfaceEndPoint(IInterfaceEndPoint newInterfaceEndPoint)
Add a interfaceEndPoint to this AddLink.

Parameters:
newInterfaceEndPoint - interfaceEndPoint to add.

addInterfaceEndPoints

public void addInterfaceEndPoints(Collection interfaceEndPoints)
Add a collection of interfaceEndPoints to this AddLink.

Parameters:
interfaceEndPoints - interfaceEndPoints to add.

clearInterfaceEndPoints

public void clearInterfaceEndPoints()
Remove all interfaceEndPoints from this AddLink.


removeInterfaceEndPoint

public void removeInterfaceEndPoint(IInterfaceEndPoint interfaceEndPointToRemove)
Remove the given interfaceEndPoint from this AddLink. Matching is done by the isEquivalent(...) function.

Parameters:
interfaceEndPointToRemove - interfaceEndPoint to remove.

removeInterfaceEndPoints

public void removeInterfaceEndPoints(Collection interfaceEndPoints)
Remove all the given interfaceEndPoints from this AddLink. Matching is done by the isEquivalent(...) function.

Parameters:
interfaceEndPoints - interfaceEndPoint to remove.

getAllInterfaceEndPoints

public Collection getAllInterfaceEndPoints()
Get all the interfaceEndPoints from this AddLink.

Returns:
all interfaceEndPoints in this AddLink.

hasInterfaceEndPoint

public boolean hasInterfaceEndPoint(IInterfaceEndPoint interfaceEndPointToCheck)
Determine if this AddLink contains a given interfaceEndPoint.

Returns:
true if this AddLink contains the given interfaceEndPointToCheck, false otherwise.

hasInterfaceEndPoints

public Collection hasInterfaceEndPoints(Collection interfaceEndPointsToCheck)
Determine if this AddLink contains the given set of interfaceEndPoints.

Parameters:
interfaceEndPointsToCheck - interfaceEndPoints to check for.
Returns:
Collection of java.lang.Boolean. If the ith element in interfaceEndPoints was found, then the ith element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllInterfaceEndPoints

public boolean hasAllInterfaceEndPoints(Collection interfaceEndPointsToCheck)
Determine if this AddLink contains each element in the given set of interfaceEndPoints.

Parameters:
interfaceEndPointsToCheck - interfaceEndPoints to check for.
Returns:
true if every element in interfaceEndPoints is found in this AddLink, false otherwise.

isEquivalent

public boolean isEquivalent(IAddLink AddLinkToCheck)
Determine if another AddLink is equivalent to this one, ignoring ID's.

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

xArch/xADL 2.0 Data Binding Library