IModelElement

All Superinterfaces:

ICockpitData, ICustomPropertiesAccess, IGraphic
```
public interface IModelElement
extends IGraphic
```
IModelElement allows to read attribute values of a unique element.
Item type constant: "uniqueElement"

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.List<IModelElement>`	`getCausallyDirectlyPrecedingModelElements()` Returns all model elements which are causally directly preceeding this model element.
`java.util.List<? extends IModelElement>`	`getCausallyDirectlyPrecedingModelElementsOnPlan(IPlan plan)` Returns all model elements which are causally directly preceeding this model element on the specified plan.
`java.util.List<IModelElement>`	`getCausallyDirectlySucceedingModelElements()` Returns all model elements which are causally directly preceded by this model element.
`java.util.List<? extends IModelElement>`	`getCausallyDirectlySucceedingModelElementsOnPlan(IPlan plan)` Returns all model elements which are causally directly preceded by this model element on the specified plan.
`java.util.List<? extends IModelElement>`	`getCausallyPrecedingModelElements()` Returns all model elements which are causally preceding this model element.
`java.util.List<? extends IModelElement>`	`getCausallyPrecedingModelElementsOnPlan(IPlan plan)` Returns all model elements which are causally preceding this model element on the specified plan.
`java.util.List<? extends IModelElement>`	`getCausallySucceedingModelElements()` Returns all model elements which are causally preceded by this model element.
`java.util.List<? extends IModelElement>`	`getCausallySucceedingModelElementsOnPlan(IPlan plan)` Returns all model elements which are causally preceded by this model element on the specified plan.
`java.util.List<? extends IModelElement>`	`getCommunicatingFunctions()` Returns all communicating functions, i.e. functions which are connected via transitive reading AND writing accesses.
`java.util.List<? extends IModelElement>`	`getCommunicatingFunctionsOnPlan(IPlan plan)` Returns all communicating functions on the specified plan, i.e.
`java.util.List<? extends IModelElement>`	`getContainedModelElements()` Returns all model elements which are contained directly or indirectly in this model element.
`java.util.List<? extends IModelElement>`	`getContainedModelElementsOnPlan(IPlan plan)` Returns all model elements which are contained directly or indirectly in this model element on the specified plan.
`java.util.List<? extends IModelElement>`	`getContainerModelElements()` Returns all model elements which directly or indirectly contain this model element.
`java.util.List<? extends IModelElement>`	`getContainerModelElementsOnPlan(IPlan plan)` Returns all model elements which directly or indirectly contain this model element on the specified plan.
`java.util.List<java.lang.String>`	`getDescription()` Returns the description of the unique element as list of Strings.
`java.util.List<? extends IModelElement>`	`getDirectContainerModelElements()` Returns all model elements which directly contain this model element.
`java.util.List<? extends IModelElement>`	`getDirectContainerModelElementsOnPlan(IPlan plan)` Returns all model elements which directly contain this model element on the specified plan.
`java.util.List<? extends IModelElement>`	`getDirectlyContainedModelElements()` Returns all model elements which are contained directly in this model element.
`java.util.List<? extends IModelElement>`	`getDirectlyContainedModelElementsOnPlan(IPlan plan)` Returns all model elements which are contained directly in this model element on the specified plan.
`java.lang.String`	`getElementTypeID()` Returns the id of the type of this unique element.
`java.lang.String`	`getElementTypeName()` Returns the name of the type of this unique element.
`java.util.List<? extends IModelElement>`	`getInfluencedInfos()` Returns all influenced infos, i.e. infos which are connected via transitive writing accesses.
`java.util.List<? extends IModelElement>`	`getInfluencedInfosOnPlan(IPlan plan)` Returns all influenced infos on the specified plan, i.e. infos which are connected via transitive writing accesses.
`java.util.List<? extends IModelElement>`	`getInfluencingInfos()` Returns all influencing infos, i.e. infos which are connected via transitive reading accesses.
`java.util.List<? extends IModelElement>`	`getInfluencingInfosOnPlan(IPlan plan)` Returns all influencing infos on the specified plan, i.e. infos which are connected via transitive reading accesses.
`java.util.List<? extends IModelElement>`	`getModifiedInfos()` Returns all modified infos.
`java.util.List<? extends IModelElement>`	`getModifiedInfosOnPlan(IPlan plan)` Returns all modified infos on the specified plan.
`java.util.List<? extends IModelElement>`	`getModifyingFunctions()` Returns all modifying functions.
`java.util.List<? extends IModelElement>`	`getModifyingFunctionsOnPlan(IPlan plan)` Returns all modifying functions on the specified plan.
`java.lang.String`	`getName()` Returns the name of the unique element.
`java.util.List<? extends IPlan>`	`getOccurrences()` Returns all plans on which the current unique element is displayed.
`java.util.List<? extends IModelElement>`	`getReadInfos()` Returns all read infos.
`java.util.List<? extends IModelElement>`	`getReadInfosOnPlan(IPlan plan)` Returns all read infos on the specified plan.
`java.util.List<? extends IModelElement>`	`getReadingFunctions()` Returns all reading functions.
`java.util.List<? extends IModelElement>`	`getReadingFunctionsOnPlan(IPlan plan)` Returns all reading functions on the specified plan.
`java.util.List<? extends IModelElement>`	`getReceivingFunctions()` Returns all receiving functions, i.e. functions which are connected via transitive writing accesses.
`java.util.List<IModelElement>`	`getReceivingFunctionsOnPlan(IPlan plan)` Returns all receiving functions on the specified plan, i.e. functions which are connected via transitive writing accesses.
`java.util.List<? extends IModelElement>`	`getRelatedInfos()` Returns all related infos, i.e. infos which are connected via transitive reading AND writing accesses.
`java.util.List<? extends IModelElement>`	`getRelatedInfosOnPlan(IPlan plan)` Returns all related infos on the specified plan, i.e. infos which are connected via transitive reading AND writing accesses.
`java.util.List<? extends IModelElement>`	`getSendingFunctions()` Returns all sending functions, i.e. functions which are connected via transitive reading accesses.
`java.util.List<? extends IModelElement>`	`getSendingFunctionsOnPlan(IPlan plan)` Returns all sending functions on the specified plan, i.e. functions which are connected via transitive reading accesses.
`java.lang.String`	`getUniqueIdentifier()` Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
`java.util.List<? extends IModelElement>`	`getWritingFunctions()` Returns all writing functions.
`java.util.List<? extends IModelElement>`	`getWritingFunctionsOnPlan(IPlan plan)` Returns all writing functions on the specified plan.
`java.util.List<IModelElement>`	`getWrittenInfos()` Returns all written infos.
`java.util.List<? extends IModelElement>`	`getWrittenInfosOnPlan(IPlan plan)` Returns all written infos on the specified plan.
`boolean`	`hasDescription()` Checks whether a description is available for the unique element.
`boolean`	`isPartOfCausalityCycle()` Returns whether this model element is part of a cycle in the causality relationship.
`boolean`	`isPartOfContainmentCycle()` Returns whether this model element is part of a cycle in the containment relationship.
`IRecord`	`toRecord()` Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic
getEMFFile, getImage, getPNGFile, getSVGFile, getWMFFile

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

- Method Detail
  - getUniqueIdentifier
```
java.lang.String getUniqueIdentifier()
```
    Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
    
    Example from report template:
    
    #set($folder_uid = ${folder.UniqueIdentifier})
    
    Specified by:
    
    getUniqueIdentifier in interface ICockpitData
    
    Returns:
    
    unique identifier
  - getName
```
java.lang.String getName()
```
    Returns the name of the unique element.
    The name is already HTML encoded so that it can be inserted into the document without further tranformations.
    
    Returns:
    
    name of the unique element (!= null)
  - hasDescription
```
boolean hasDescription()
```
    Checks whether a description is available for the unique element.
    
    Returns:
    
    true: a description is available
  - getDescription
```
java.util.List<java.lang.String> getDescription()
```
    Returns the description of the unique element as list of Strings. If the description consists of multiple lines (ENTER), each line is represented by an element in the String array.
    The description text is already HTML encoded so that it can be inserted into the document without further tranformations.
    
    Example from report template:
    
    #foreach( $text in ${folder.Description}) <para>$text</para> #end
    
    Returns:
    
    Description text of the folder, splitted into multiple strings, one for each line. (!= null)
  - getElementTypeID
```
java.lang.String getElementTypeID()
```
    Returns the id of the type of this unique element.
    The name is already HTML encoded so that it can be inserted into the document without further tranformations.
    Valid type IDs are:
    - bpre.function
    - bpre.information
    - bpre.state
    Returns:
    
    id of the unique elements type (!= null)
  - getElementTypeName
```
java.lang.String getElementTypeName()
```
    Returns the name of the type of this unique element.
    The name is already HTML encoded so that it can be inserted into the document without further tranformations.
    Examples for type names are:
    - Function
    - Information
    - States
    Returns:
    
    name of the unique elements type (!= null)
  - getOccurrences
```
java.util.List<? extends IPlan> getOccurrences()
```
    Returns all plans on which the current unique element is displayed.
    
    Returns:
    
    Plans on which the unique element is displayed.
  - getContainedModelElements
```
java.util.List<? extends IModelElement> getContainedModelElements()
```
    Returns all model elements which are contained directly or indirectly in this model element.
    The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements which are contained directly or indirectly in this model element
  - getContainerModelElements
```
java.util.List<? extends IModelElement> getContainerModelElements()
```
    Returns all model elements which directly or indirectly contain this model element.
    The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements which directly or indirectly contain this model element
  - getDirectlyContainedModelElements
```
java.util.List<? extends IModelElement> getDirectlyContainedModelElements()
```
    Returns all model elements which are contained directly in this model element.
    The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements which are contained directly in this model element
  - getDirectContainerModelElements
```
java.util.List<? extends IModelElement> getDirectContainerModelElements()
```
    Returns all model elements which directly contain this model element.
    The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements which directly contain this model element
  - getContainedModelElementsOnPlan
```
java.util.List<? extends IModelElement> getContainedModelElementsOnPlan(IPlan plan)
```
    Returns all model elements which are contained directly or indirectly in this model element on the specified plan.
    The model elements are returned sorted by their type and element names.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    a list of all model elements which are contained directly or indirectly in this model element
  - getContainerModelElementsOnPlan
```
java.util.List<? extends IModelElement> getContainerModelElementsOnPlan(IPlan plan)
```
    Returns all model elements which directly or indirectly contain this model element on the specified plan.
    The model elements are returned sorted by their type and element names.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    a list of all model elements which directly or indirectly contain this model element
  - getDirectlyContainedModelElementsOnPlan
```
java.util.List<? extends IModelElement> getDirectlyContainedModelElementsOnPlan(IPlan plan)
```
    Returns all model elements which are contained directly in this model element on the specified plan.
    The model elements are returned sorted by their type and element names.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    a list of all model elements which are contained directly in this model element
  - getDirectContainerModelElementsOnPlan
```
java.util.List<? extends IModelElement> getDirectContainerModelElementsOnPlan(IPlan plan)
```
    Returns all model elements which directly contain this model element on the specified plan.
    The model elements are returned sorted by their type and element names.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    a list of all model elements which directly contain this model element
  - isPartOfContainmentCycle
```
boolean isPartOfContainmentCycle()
```
    Returns whether this model element is part of a cycle in the containment relationship.
    
    Returns:
    
    whether this model element is part of a cycle in the containment relationship
  - getReadingFunctions
```
java.util.List<? extends IModelElement> getReadingFunctions()
```
    Returns all reading functions.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Returns:
    
    all reading functions
  - getWritingFunctions
```
java.util.List<? extends IModelElement> getWritingFunctions()
```
    Returns all writing functions.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Returns:
    
    all writing functions
  - getModifyingFunctions
```
java.util.List<? extends IModelElement> getModifyingFunctions()
```
    Returns all modifying functions.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Returns:
    
    all modifying functions
  - getInfluencedInfos
```
java.util.List<? extends IModelElement> getInfluencedInfos()
```
    Returns all influenced infos, i.e. infos which are connected via transitive writing accesses.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Returns:
    
    all influenced infos
  - getInfluencingInfos
```
java.util.List<? extends IModelElement> getInfluencingInfos()
```
    Returns all influencing infos, i.e. infos which are connected via transitive reading accesses.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Returns:
    
    all influencing infos
  - getRelatedInfos
```
java.util.List<? extends IModelElement> getRelatedInfos()
```
    Returns all related infos, i.e. infos which are connected via transitive reading AND writing accesses.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Returns:
    
    all related infos
  - getReadingFunctionsOnPlan
```
java.util.List<? extends IModelElement> getReadingFunctionsOnPlan(IPlan plan)
```
    Returns all reading functions on the specified plan.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all reading functions
  - getWritingFunctionsOnPlan
```
java.util.List<? extends IModelElement> getWritingFunctionsOnPlan(IPlan plan)
```
    Returns all writing functions on the specified plan.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all writing functions
  - getModifyingFunctionsOnPlan
```
java.util.List<? extends IModelElement> getModifyingFunctionsOnPlan(IPlan plan)
```
    Returns all modifying functions on the specified plan.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all modifying functions
  - getInfluencedInfosOnPlan
```
java.util.List<? extends IModelElement> getInfluencedInfosOnPlan(IPlan plan)
```
    Returns all influenced infos on the specified plan, i.e. infos which are connected via transitive writing accesses.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all influenced infos
  - getInfluencingInfosOnPlan
```
java.util.List<? extends IModelElement> getInfluencingInfosOnPlan(IPlan plan)
```
    Returns all influencing infos on the specified plan, i.e. infos which are connected via transitive reading accesses.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all influencing infos
  - getRelatedInfosOnPlan
```
java.util.List<? extends IModelElement> getRelatedInfosOnPlan(IPlan plan)
```
    Returns all related infos on the specified plan, i.e. infos which are connected via transitive reading AND writing accesses.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "info". If this model element is not an "info", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all related infos
  - getWrittenInfos
```
java.util.List<IModelElement> getWrittenInfos()
```
    Returns all written infos.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Returns:
    
    all written infos
  - getReadInfos
```
java.util.List<? extends IModelElement> getReadInfos()
```
    Returns all read infos.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Returns:
    
    all read infos
  - getModifiedInfos
```
java.util.List<? extends IModelElement> getModifiedInfos()
```
    Returns all modified infos.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Returns:
    
    all modified infos
  - getReceivingFunctions
```
java.util.List<? extends IModelElement> getReceivingFunctions()
```
    Returns all receiving functions, i.e. functions which are connected via transitive writing accesses.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Returns:
    
    all receiving functions
  - getSendingFunctions
```
java.util.List<? extends IModelElement> getSendingFunctions()
```
    Returns all sending functions, i.e. functions which are connected via transitive reading accesses.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Returns:
    
    all sending functions
  - getCommunicatingFunctions
```
java.util.List<? extends IModelElement> getCommunicatingFunctions()
```
    Returns all communicating functions, i.e. functions which are connected via transitive reading AND writing accesses.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Returns:
    
    all communicating functions
  - getWrittenInfosOnPlan
```
java.util.List<? extends IModelElement> getWrittenInfosOnPlan(IPlan plan)
```
    Returns all written infos on the specified plan.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all written infos
  - getReadInfosOnPlan
```
java.util.List<? extends IModelElement> getReadInfosOnPlan(IPlan plan)
```
    Returns all read infos on the specified plan.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all read infos
  - getModifiedInfosOnPlan
```
java.util.List<? extends IModelElement> getModifiedInfosOnPlan(IPlan plan)
```
    Returns all modified infos on the specified plan.
    The infos are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all modified infos
  - getReceivingFunctionsOnPlan
```
java.util.List<IModelElement> getReceivingFunctionsOnPlan(IPlan plan)
```
    Returns all receiving functions on the specified plan, i.e. functions which are connected via transitive writing accesses.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all receiving functions
  - getSendingFunctionsOnPlan
```
java.util.List<? extends IModelElement> getSendingFunctionsOnPlan(IPlan plan)
```
    Returns all sending functions on the specified plan, i.e. functions which are connected via transitive reading accesses.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all sending functions
  - getCommunicatingFunctionsOnPlan
```
java.util.List<? extends IModelElement> getCommunicatingFunctionsOnPlan(IPlan plan)
```
    Returns all communicating functions on the specified plan, i.e. functions which are connected via transitive reading AND writing accesses.
    The functions are returned sorted by their element names.
    Precondition: This model element must be of type "function". If this model element is not a "function", the returned list will be empty.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    all communicating functions
  - getCausallySucceedingModelElements
```
java.util.List<? extends IModelElement> getCausallySucceedingModelElements()
```
    Returns all model elements which are causally preceded by this model element.
    The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements which are causally preceded by this model element
  - getCausallyPrecedingModelElements
```
java.util.List<? extends IModelElement> getCausallyPrecedingModelElements()
```
    Returns all model elements which are causally preceding this model element.
    The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements which are causally preceding this model element
  - getCausallyDirectlySucceedingModelElements
```
java.util.List<IModelElement> getCausallyDirectlySucceedingModelElements()
```
    Returns all model elements which are causally directly preceded by this model element.
    The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements which are causally directly preceded by this model element
  - getCausallyDirectlyPrecedingModelElements
```
java.util.List<IModelElement> getCausallyDirectlyPrecedingModelElements()
```
    Returns all model elements which are causally directly preceeding this model element.
    The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements which are causally directly preceding this model element
  - getCausallySucceedingModelElementsOnPlan
```
java.util.List<? extends IModelElement> getCausallySucceedingModelElementsOnPlan(IPlan plan)
```
    Returns all model elements which are causally preceded by this model element on the specified plan.
    The model elements are returned sorted by their type and element names.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    a list of all model elements which are causally preceded by this model element
  - getCausallyPrecedingModelElementsOnPlan
```
java.util.List<? extends IModelElement> getCausallyPrecedingModelElementsOnPlan(IPlan plan)
```
    Returns all model elements which are causally preceding this model element on the specified plan.
    The model elements are returned sorted by their type and element names.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    a list of all model elements which are causally preceding this model element
  - getCausallyDirectlySucceedingModelElementsOnPlan
```
java.util.List<? extends IModelElement> getCausallyDirectlySucceedingModelElementsOnPlan(IPlan plan)
```
    Returns all model elements which are causally directly preceded by this model element on the specified plan.
    The model elements are returned sorted by their type and element names.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    a list of all model elements which are causally directly preceded by this model element
  - getCausallyDirectlyPrecedingModelElementsOnPlan
```
java.util.List<? extends IModelElement> getCausallyDirectlyPrecedingModelElementsOnPlan(IPlan plan)
```
    Returns all model elements which are causally directly preceeding this model element on the specified plan.
    The model elements are returned sorted by their type and element names.
    
    Parameters:
    
    plan - the plan
    
    Returns:
    
    a list of all model elements which are causally directly preceding this model element
  - isPartOfCausalityCycle
```
boolean isPartOfCausalityCycle()
```
    Returns whether this model element is part of a cycle in the causality relationship.
    
    Returns:
    
    whether this model element is part of a cycle in the causality relationship
  - toRecord
```
IRecord toRecord()
```
    Converts this generic module data into a record.
    In addition to all fields documented at ICustomPropertiesAccess.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:
    - IRecord.NAME_KEY
    - IRecord.DESCRIPTION_KEY
    Specified by:
    
    toRecord in interface ICockpitData
    
    Specified by:
    
    toRecord in interface ICustomPropertiesAccess
    
    Returns:
    
    converted cockpit project data

Interface IModelElement

Method Summary

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.IGraphic

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Method Detail

getUniqueIdentifier

getName

hasDescription

getDescription

getElementTypeID

getElementTypeName

getOccurrences

getContainedModelElements

getContainerModelElements

getDirectlyContainedModelElements

getDirectContainerModelElements

getContainedModelElementsOnPlan

getContainerModelElementsOnPlan

getDirectlyContainedModelElementsOnPlan

getDirectContainerModelElementsOnPlan

isPartOfContainmentCycle

getReadingFunctions

getWritingFunctions

getModifyingFunctions

getInfluencedInfos

getInfluencingInfos

getRelatedInfos

getReadingFunctionsOnPlan

getWritingFunctionsOnPlan

getModifyingFunctionsOnPlan

getInfluencedInfosOnPlan

getInfluencingInfosOnPlan

getRelatedInfosOnPlan

getWrittenInfos

getReadInfos

getModifiedInfos

getReceivingFunctions

getSendingFunctions

getCommunicatingFunctions

getWrittenInfosOnPlan

getReadInfosOnPlan

getModifiedInfosOnPlan

getReceivingFunctionsOnPlan

getSendingFunctionsOnPlan

getCommunicatingFunctionsOnPlan

getCausallySucceedingModelElements

getCausallyPrecedingModelElements

getCausallyDirectlySucceedingModelElements

getCausallyDirectlyPrecedingModelElements

getCausallySucceedingModelElementsOnPlan

getCausallyPrecedingModelElementsOnPlan

getCausallyDirectlySucceedingModelElementsOnPlan

getCausallyDirectlyPrecedingModelElementsOnPlan

isPartOfCausalityCycle

toRecord