Package de.mid.innovator.srv2api.icw2class

Interface CLTemplateAbleElement

All Superinterfaces:

ELContainerAble, ELDeleteAble, ELElement, ELObject

All Known Subinterfaces:

ACActivity, BEBehavior, BEOpaque, BPInterface, BRResourceCL, CLActor, CLArtifact, CLAssocClass, CLAssociation, CLBehavioredClassifier, CLClass, CLClassifier, CLCollaboration, CLCommunicationPath, CLComponent, CLDataType, CLDeclarationAbleClassifier, CLDeploymentSpec, CLDevice, CLEncapsulatedClassifier, CLEnumeration, CLExecEnv, CLInterface, CLNode, CLPrimitiveType, CLSignal, CLStructuredClassifier, CLStructureDefinition, CLTemplateParameterAbleClass, CLUseCase, IAInteraction, IMCLDataType, SMProtocolStateMachine, SMStateMachine

public interface CLTemplateAbleElement
extends ELContainerAble

A CLTemplateAbleElement is an element that can optionally be defined as template and bound to other templates.

See Also:

CLTemplateAbleElementHelper

Note:

The interface CLTemplateAbleElement describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CLTemplateAbleElement.VAttr

Method Summary

Modifier and Type	Method	Description
<T extends CLTemplateParameterAbleElement> java.util.List<T>	getActualTemplateParameter(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	If this element is bound to a template the result is a list of all elements which are used as actual parameters by substitutions of the template binding.
<T extends CLTemplateParameterAbleElement> java.util.List<T>	getActualTemplateParameter(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getActualTemplateParameter and filters its return values according to the given stereotype value.
<T extends CLTemplateParameter> java.util.List<T>	getOwnedTemplateParameter(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	The formal template parameters that are owned by this element.
java.util.List<CLTemplateBinding>	getTemplateBindingSource(K_CONTROL_OPTION... behaviourFlags)	The optional bindings from this element to templates.
java.util.List<CLTemplateBinding>	getTemplateBindingTarget(K_CONTROL_OPTION... behaviourFlags)	All bindings of the signature of this element.
ARG_TemplateParameterList	getTemplateParameter()	Returns the list of template parameters.

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Method Detail

getActualTemplateParameter

<T extends CLTemplateParameterAbleElement> java.util.List<T> getActualTemplateParameter(java.lang.Class<T> returnType,
                                                                                        K_CONTROL_OPTION... behaviourFlags)
                                                                                 throws InoNetException,
                                                                                        SrvErrorException

If this element is bound to a template the result is a list of all elements which are used as actual parameters by substitutions of the template binding. Without a binding the result is empty.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getActualTemplateParameter

<T extends CLTemplateParameterAbleElement> java.util.List<T> getActualTemplateParameter(java.lang.Class<T> returnType,
                                                                                        MMStereotype stereotype,
                                                                                        K_CONTROL_OPTION... behaviourFlags)
                                                                                 throws InoNetException,
                                                                                        SrvErrorException

The method calls getActualTemplateParameter and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getTemplateParameter

ARG_TemplateParameterList getTemplateParameter()
                                        throws InoNetException,
                                               SrvErrorException

Returns the list of template parameters.

Throws:

InoNetException

SrvErrorException

getOwnedTemplateParameter

<T extends CLTemplateParameter> java.util.List<T> getOwnedTemplateParameter(java.lang.Class<T> returnType,
                                                                            K_CONTROL_OPTION... behaviourFlags)
                                                                     throws InoNetException,
                                                                            SrvErrorException

The formal template parameters that are owned by this element.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getTemplateBindingSource

java.util.List<CLTemplateBinding> getTemplateBindingSource(K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException

The optional bindings from this element to templates.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getTemplateBindingTarget

java.util.List<CLTemplateBinding> getTemplateBindingTarget(K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException

All bindings of the signature of this element.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException