org.eclipse.uml2
Interface TemplateParameter

All Superinterfaces:
Element, EModelElement, EObject, Notifier
All Known Subinterfaces:
ClassifierTemplateParameter, ConnectableElementTemplateParameter, OperationTemplateParameter

public interface TemplateParameter
extends Element

A representation of the model object 'Template Parameter'. TemplateParameter references a ParameterableElement which is exposed as a formal template parameter in the containing template.

The following features are supported:

See Also:
UML2Package.getTemplateParameter()

Field Summary
static String copyright
           
 
Method Summary
 ParameterableElement createOwnedDefault(EClass eClass)
          Creates a ParameterableElement and sets the 'Owned Default' containment reference
 ParameterableElement createOwnedParameteredElement(EClass eClass)
          Creates a ParameterableElement and sets the 'Owned Parametered Element' containment reference
 ParameterableElement getDefault()
          Returns the value of the 'Default' reference
 ParameterableElement getOwnedDefault()
          Returns the value of the 'Owned Default' containment reference
 EList getOwnedElements()
           
 ParameterableElement getOwnedParameteredElement()
          Returns the value of the 'Owned Parametered Element' containment reference.
 Element getOwner()
           
 ParameterableElement getParameteredElement()
          Returns the value of the 'Parametered Element' reference.
 TemplateSignature getSignature()
          Returns the value of the 'Signature' container reference.
 void setDefault(ParameterableElement value)
          Sets the value of the 'Default' reference
 void setOwnedDefault(ParameterableElement value)
          Sets the value of the 'Owned Default' containment reference
 void setOwnedParameteredElement(ParameterableElement value)
          Sets the value of the 'Owned Parametered Element' containment reference
 void setParameteredElement(ParameterableElement value)
          Sets the value of the 'Parametered Element' reference
 void setSignature(TemplateSignature value)
          Sets the value of the 'Signature' container reference
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getValue, hasKeyword, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, validateHasOwner, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getSignature

public TemplateSignature getSignature()
Returns the value of the 'Signature' container reference. It is bidirectional and its opposite is 'Owned Parameter'.

If the meaning of the 'Signature' container reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Signature' container reference.
See Also:
setSignature(TemplateSignature), UML2Package.getTemplateParameter_Signature(), TemplateSignature.getOwnedParameters()

setSignature

public void setSignature(TemplateSignature value)
Sets the value of the 'Signature' container reference.

Parameters:
value - the new value of the 'Signature' container reference.
See Also:
getSignature()

getParameteredElement

public ParameterableElement getParameteredElement()
Returns the value of the 'Parametered Element' reference. It is bidirectional and its opposite is 'Template Parameter'.

If the meaning of the 'Parametered Element' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Parametered Element' reference.
See Also:
setParameteredElement(ParameterableElement), UML2Package.getTemplateParameter_ParameteredElement(), ParameterableElement.getTemplateParameter()

setParameteredElement

public void setParameteredElement(ParameterableElement value)
Sets the value of the 'Parametered Element' reference.

Parameters:
value - the new value of the 'Parametered Element' reference.
See Also:
getParameteredElement()

getOwnedParameteredElement

public ParameterableElement getOwnedParameteredElement()
Returns the value of the 'Owned Parametered Element' containment reference. It is bidirectional and its opposite is 'Owning Parameter'.

If the meaning of the 'Owned Parametered Element' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Owned Parametered Element' containment reference.
See Also:
setOwnedParameteredElement(ParameterableElement), UML2Package.getTemplateParameter_OwnedParameteredElement(), ParameterableElement.getOwningParameter()

setOwnedParameteredElement

public void setOwnedParameteredElement(ParameterableElement value)
Sets the value of the 'Owned Parametered Element' containment reference.

Parameters:
value - the new value of the 'Owned Parametered Element' containment reference.
See Also:
getOwnedParameteredElement()

createOwnedParameteredElement

public ParameterableElement createOwnedParameteredElement(EClass eClass)
Creates a ParameterableElement and sets the 'Owned Parametered Element' containment reference.

Parameters:
eClass - The Ecore class of the ParameterableElement to create.
Returns:
The new ParameterableElement.
See Also:
getOwnedParameteredElement()

getDefault

public ParameterableElement getDefault()
Returns the value of the 'Default' reference.

If the meaning of the 'Default' reference isn't clear, there really should be more of a description here...

element that is the default for this formal template parameter.

Returns:
the value of the 'Default' reference.
See Also:
setDefault(ParameterableElement), UML2Package.getTemplateParameter_Default()

setDefault

public void setDefault(ParameterableElement value)
Sets the value of the 'Default' reference.

Parameters:
value - the new value of the 'Default' reference.
See Also:
getDefault()

getOwnedDefault

public ParameterableElement getOwnedDefault()
Returns the value of the 'Owned Default' containment reference.

If the meaning of the 'Owned Default' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Owned Default' containment reference.
See Also:
setOwnedDefault(ParameterableElement), UML2Package.getTemplateParameter_OwnedDefault()

setOwnedDefault

public void setOwnedDefault(ParameterableElement value)
Sets the value of the 'Owned Default' containment reference.

Parameters:
value - the new value of the 'Owned Default' containment reference.
See Also:
getOwnedDefault()

createOwnedDefault

public ParameterableElement createOwnedDefault(EClass eClass)
Creates a ParameterableElement and sets the 'Owned Default' containment reference.

Parameters:
eClass - The Ecore class of the ParameterableElement to create.
Returns:
The new ParameterableElement.
See Also:
getOwnedDefault()

getOwner

public Element getOwner()

Specified by:
getOwner in interface Element
Returns:
the value of the 'Owner' reference.
See Also:
UML2Package.getElement_Owner(), Element.getOwnedElements()

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface Element
Returns:
the value of the 'Owned Element' reference list.
See Also:
UML2Package.getElement_OwnedElement(), Element.getOwner()

Copyright 2003, 2004 IBM Corporation and others.
All Rights Reserved.