org.eclipse.uml2
Interface TemplateSignature

All Superinterfaces:
Element, EModelElement, EObject, Notifier
All Known Subinterfaces:
RedefinableTemplateSignature

public interface TemplateSignature
extends Element

A representation of the model object 'Template Signature'. A TemplateSignature is owned by a TemplateableElement and has one or more TemplateParameters that define the signature for binding this template. A TemplateSignature may reference a set of nested template signatures to reflect the hierarchical nature of a template.

The following features are supported:

See Also:
UML2Package.getTemplateSignature()

Field Summary
static String copyright
           
 
Method Summary
 TemplateParameter createOwnedParameter(EClass eClass)
          Creates a TemplateParameter and appends it to the 'Owned Parameter' containment reference list
 EList getNestedSignatures()
          Returns the value of the 'Nested Signature' reference list.
 TemplateSignature getNestingSignature()
          Returns the value of the 'Nesting Signature' reference.
 EList getOwnedElements()
           
 EList getOwnedParameters()
          Returns the value of the 'Owned Parameter' containment reference list.
 Element getOwner()
           
 EList getParameters()
          Returns the value of the 'Parameter' reference list.
 TemplateableElement getTemplate()
          Returns the value of the 'Template' container reference.
 void setNestingSignature(TemplateSignature value)
          Sets the value of the 'Nesting Signature' reference
 void setTemplate(TemplateableElement value)
          Sets the value of the 'Template' 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

getParameters

public EList getParameters()
Returns the value of the 'Parameter' reference list. The list contents are of type TemplateParameter.

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

The complete set of formal template parameters for this template signature.

Returns:
the value of the 'Parameter' reference list.
See Also:
UML2Package.getTemplateSignature_Parameter()

getOwnedParameters

public EList getOwnedParameters()
Returns the value of the 'Owned Parameter' containment reference list. The list contents are of type TemplateParameter. It is bidirectional and its opposite is 'Signature'.

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

The formal template parameters that are owned by this template signature. Subsets parameter and Element::ownedElement.

Returns:
the value of the 'Owned Parameter' containment reference list.
See Also:
UML2Package.getTemplateSignature_OwnedParameter(), TemplateParameter.getSignature()

createOwnedParameter

public TemplateParameter createOwnedParameter(EClass eClass)
Creates a TemplateParameter and appends it to the 'Owned Parameter' containment reference list.

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

getNestedSignatures

public EList getNestedSignatures()
Returns the value of the 'Nested Signature' reference list. The list contents are of type TemplateSignature. It is bidirectional and its opposite is 'Nesting Signature'.

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

Returns:
the value of the 'Nested Signature' reference list.
See Also:
UML2Package.getTemplateSignature_NestedSignature(), getNestingSignature()

getNestingSignature

public TemplateSignature getNestingSignature()
Returns the value of the 'Nesting Signature' reference. It is bidirectional and its opposite is 'Nested Signature'.

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

Returns:
the value of the 'Nesting Signature' reference.
See Also:
setNestingSignature(TemplateSignature), UML2Package.getTemplateSignature_NestingSignature(), getNestedSignatures()

setNestingSignature

public void setNestingSignature(TemplateSignature value)
Sets the value of the 'Nesting Signature' reference.

Parameters:
value - the new value of the 'Nesting Signature' reference.
See Also:
getNestingSignature()

getTemplate

public TemplateableElement getTemplate()
Returns the value of the 'Template' container reference. It is bidirectional and its opposite is 'Owned Template Signature'.

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

element that owns this template signature. Subsets Element::owner.

Returns:
the value of the 'Template' container reference.
See Also:
setTemplate(TemplateableElement), UML2Package.getTemplateSignature_Template(), TemplateableElement.getOwnedTemplateSignature()

setTemplate

public void setTemplate(TemplateableElement value)
Sets the value of the 'Template' container reference.

Parameters:
value - the new value of the 'Template' container reference.
See Also:
getTemplate()

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()

getOwner

public Element getOwner()

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

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