ModelElementInstance (camunda BPM Javadocs 7.2.10-ee)

All Known Subinterfaces:

ActivationCondition, Activity, ApplicabilityRule, Artifact, Assignment, Association, Auditing, BaseElement, BoundaryEvent, Bounds, BpmnDiagram, BpmnEdge, BpmnLabel, BpmnLabelStyle, BpmnModelElementInstance, BpmnPlane, BpmnShape, BusinessRuleTask, CallableElement, CallActivity, CallConversation, CamundaCaseExecutionListener, CamundaConnector, CamundaConnectorId, CamundaConstraint, CamundaEntry, CamundaExecutionListener, CamundaExpression, CamundaExpression, CamundaFailedJobRetryTimeCycle, CamundaField, CamundaField, CamundaFormData, CamundaFormField, CamundaFormProperty, CamundaIn, CamundaIn, CamundaInputOutput, CamundaInputParameter, CamundaList, CamundaMap, CamundaOut, CamundaOut, CamundaOutputParameter, CamundaPotentialStarter, CamundaProperties, CamundaProperty, CamundaScript, CamundaScript, CamundaString, CamundaString, CamundaTaskListener, CamundaTaskListener, CamundaValidation, CamundaValue, CamundaVariableListener, CancelEventDefinition, Case, CaseFile, CaseFileItem, CaseFileItemDefinition, CaseFileItemOnPart, CaseFileItemStartTrigger, CaseParameter, CaseTask, CatchEvent, CategoryValue, Children, CmmnElement, CmmnModelElementInstance, Collaboration, CompensateEventDefinition, CompletionCondition, ComplexBehaviorDefinition, ComplexGateway, Condition, ConditionalEventDefinition, ConditionExpression, Conversation, ConversationAssociation, ConversationLink, ConversationNode, CorrelationKey, CorrelationProperty, CorrelationPropertyBinding, CorrelationPropertyRetrievalExpression, CorrelationSubscription, DataAssociation, DataInput, DataInputAssociation, DataObject, DataObjectReference, DataOutput, DataOutputAssociation, DataState, Definitions, Definitions, Diagram, DiagramElement, DiscretionaryItem, Documentation, Edge, EndEvent, EndPoint, Error, ErrorEventDefinition, Escalation, EscalationEventDefinition, Event, EventBasedGateway, EventDefinition, EventListener, ExclusiveGateway, Expression, Expression, Extension, Extension, ExtensionElements, ExtensionElements, FlowElement, FlowNode, Font, FormalExpression, Gateway, GlobalConversation, HumanTask, IfPart, Import, Import, InclusiveGateway, InputDataItem, InputSet, InteractionNode, Interface, IntermediateCatchEvent, IntermediateThrowEvent, IoBinding, IoSpecification, ItemAwareElement, ItemDefinition, Label, LabeledEdge, LabeledShape, Lane, LaneSet, LinkEventDefinition, LoopCardinality, LoopCharacteristics, ManualActivationRule, ManualTask, Message, MessageEventDefinition, MessageFlow, MessageFlowAssociation, Milestone, Monitoring, MultiInstanceLoopCharacteristics, Node, OnPart, Operation, OutputDataItem, OutputSet, ParallelGateway, Parameter, ParameterMapping, Participant, ParticipantAssociation, ParticipantMultiplicity, Plane, PlanFragment, PlanItem, PlanItemControl, PlanItemDefinition, PlanItemOnPart, PlanItemStartTrigger, PlanningTable, Point, Process, Process, ProcessParameter, ProcessTask, Property, Property, ReceiveTask, Relationship, Relationship, Rendering, RepetitionRule, RequiredRule, Resource, ResourceAssignmentExpression, ResourceParameter, ResourceParameterBinding, ResourceRole, Role, RootElement, Script, ScriptTask, SendTask, Sentry, SequenceFlow, ServiceTask, Shape, Signal, SignalEventDefinition, Source, Stage, StartEvent, StartTrigger, Style, SubConversation, SubProcess, TableItem, Target, Task, Task, TerminateEventDefinition, Text, TextAnnotation, ThrowEvent, TimeCycle, TimeDate, TimeDuration, TimerEventDefinition, TimerEventListener, UserEventListener, UserTask, Waypoint

All Known Implementing Classes:

ActivationConditionImpl, ActivityImpl, ApplicabilityRuleImpl, ArtifactImpl, AssignmentImpl, AssociationImpl, AuditingImpl, BaseElementImpl, BindingRefinementExpression, Body, BoundaryEventImpl, BoundsImpl, BpmnDiagramImpl, BpmnEdgeImpl, BpmnLabelImpl, BpmnLabelStyleImpl, BpmnModelElementInstanceImpl, BpmnPlaneImpl, BpmnShapeImpl, BusinessRuleTaskImpl, CallableElementImpl, CallActivityImpl, CallConversationImpl, CamundaCaseExecutionListenerImpl, CamundaConnectorIdImpl, CamundaConnectorImpl, CamundaConstraintImpl, CamundaEntryImpl, CamundaExecutionListenerImpl, CamundaExpressionImpl, CamundaExpressionImpl, CamundaFailedJobRetryTimeCycleImpl, CamundaFieldImpl, CamundaFieldImpl, CamundaFormDataImpl, CamundaFormFieldImpl, CamundaFormPropertyImpl, CamundaGenericValueElementImpl, CamundaInImpl, CamundaInImpl, CamundaInputOutputImpl, CamundaInputParameterImpl, CamundaListImpl, CamundaMapImpl, CamundaOutImpl, CamundaOutImpl, CamundaOutputParameterImpl, CamundaPotentialStarterImpl, CamundaPropertiesImpl, CamundaPropertyImpl, CamundaScriptImpl, CamundaScriptImpl, CamundaStringImpl, CamundaStringImpl, CamundaTaskListenerImpl, CamundaTaskListenerImpl, CamundaValidationImpl, CamundaValueImpl, CamundaVariableListenerImpl, CancelEventDefinitionImpl, CaseFileImpl, CaseFileItemDefinitionImpl, CaseFileItemImpl, CaseFileItemOnPartImpl, CaseFileItemStartTriggerImpl, CaseFileItemTransitionStandardEvent, CaseFileModel, CaseImpl, CaseParameterImpl, CasePlanModel, CaseRoles, CaseTaskImpl, CatchEventImpl, CategoryValueImpl, CategoryValueRef, ChildLaneSet, ChildrenImpl, CmmnElementImpl, CmmnModelElementInstanceImpl, CollaborationImpl, CompensateEventDefinitionImpl, CompletionConditionImpl, ComplexBehaviorDefinitionImpl, ComplexGatewayImpl, ConditionalEventDefinitionImpl, ConditionExpression, ConditionExpressionImpl, ConditionImpl, ConversationAssociationImpl, ConversationImpl, ConversationLinkImpl, ConversationNodeImpl, CorrelationKeyImpl, CorrelationPropertyBindingImpl, CorrelationPropertyImpl, CorrelationPropertyRef, CorrelationPropertyRetrievalExpressionImpl, CorrelationSubscriptionImpl, DataAssociationImpl, DataInputAssociationImpl, DataInputImpl, DataInputRefs, DataObjectImpl, DataObjectReferenceImpl, DataOutputAssociationImpl, DataOutputImpl, DataOutputRefs, DataPath, DataStateImpl, DefaultControl, DefinitionsImpl, DefinitionsImpl, DiagramElementImpl, DiagramImpl, DiscretionaryItemImpl, DocumentationImpl, EdgeImpl, EndEventImpl, EndPointImpl, EndPointRef, ErrorEventDefinitionImpl, ErrorImpl, ErrorRef, EscalationEventDefinitionImpl, EscalationImpl, EventBasedGatewayImpl, EventDefinitionImpl, EventDefinitionRef, EventImpl, EventListenerImpl, ExclusiveGatewayImpl, ExpressionImpl, ExpressionImpl, ExtensionElementsImpl, ExtensionElementsImpl, ExtensionImpl, ExtensionImpl, FlowElementImpl, FlowNodeImpl, FlowNodeRef, FontImpl, FormalExpressionImpl, From, GatewayImpl, GlobalConversationImpl, HumanTaskImpl, IfPartImpl, ImportImpl, ImportImpl, InclusiveGatewayImpl, Incoming, InMessageRef, InnerParticipantRef, InputCaseParameter, InputDataItemImpl, InputProcessParameter, InputsCaseParameter, InputSetImpl, InputSetRefs, InteractionNodeImpl, InterfaceImpl, InterfaceRef, IntermediateCatchEventImpl, IntermediateThrowEventImpl, IoBindingImpl, IoSpecificationImpl, ItemAwareElementImpl, ItemControl, ItemDefinitionImpl, LabeledEdgeImpl, LabeledShapeImpl, LabelImpl, LaneImpl, LaneSetImpl, LinkEventDefinitionImpl, LoopCardinalityImpl, LoopCharacteristicsImpl, LoopDataInputRef, LoopDataOutputRef, ManualActivationRuleImpl, ManualTaskImpl, MessageEventDefinitionImpl, MessageFlowAssociationImpl, MessageFlowImpl, MessageFlowRef, MessageImpl, MessagePath, MilestoneImpl, ModelElementInstanceImpl, MonitoringImpl, MultiInstanceLoopCharacteristicsImpl, NodeImpl, OnPartImpl, OperationImpl, OperationRef, OptionalInputRefs, OptionalOutputRefs, OuterParticipantRef, Outgoing, OutMessageRef, OutputCaseParameter, OutputDataItemImpl, OutputProcessParameter, OutputsCaseParameter, OutputSetImpl, OutputSetRefs, ParallelGatewayImpl, ParameterImpl, ParameterMappingImpl, ParticipantAssociationImpl, ParticipantImpl, ParticipantMultiplicityImpl, ParticipantRef, PartitionElement, PlaneImpl, PlanFragmentImpl, PlanItemControlImpl, PlanItemDefinitionImpl, PlanItemImpl, PlanItemOnPartImpl, PlanItemStartTriggerImpl, PlanItemTransitionStandardEvent, PlanningTableImpl, PointImpl, ProcessImpl, ProcessImpl, ProcessParameterImpl, ProcessTaskImpl, PropertyImpl, PropertyImpl, ReceiveTaskImpl, RelationshipImpl, RelationshipImpl, RenderingImpl, RepetitionRuleImpl, RequiredRuleImpl, ResourceAssignmentExpressionImpl, ResourceImpl, ResourceParameterBindingImpl, ResourceParameterImpl, ResourceRef, ResourceRoleImpl, RoleImpl, RootElementImpl, ScriptImpl, ScriptTaskImpl, SendTaskImpl, SentryImpl, SequenceFlowImpl, ServiceTaskImpl, ShapeImpl, SignalEventDefinitionImpl, SignalImpl, Source, SourceImpl, SourceRef, StageImpl, StartEventImpl, StartTriggerImpl, StyleImpl, SubConversationImpl, SubProcessImpl, SupportedInterfaceRef, Supports, TableItemImpl, Target, TargetImpl, TargetRef, TaskImpl, TaskImpl, TerminateEventDefinitionImpl, TextAnnotationImpl, TextImpl, ThrowEventImpl, TimeCycleImpl, TimeDateImpl, TimeDurationImpl, TimerEventDefinitionImpl, TimerEventListenerImpl, TimerExpression, To, Transformation, TransformationExpression, UserEventListenerImpl, UserTaskImpl, WaypointImpl, WhileExecutingInputRefs, WhileExecutingOutputRefs
```
public interface ModelElementInstance
```
An instance of a ModelElementType

Author:

Daniel Meyer

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChildElement(ModelElementInstance newChild)` Adds a new child element to the children of this element.
`String`	`getAttributeValue(String attributeName)` Returns the attribute value for the attribute name.
`String`	`getAttributeValueNs(String namespaceUri, String attributeName)` Returns the attribute value for the given attribute name and namespace URI.
`<T extends ModelElementInstance> Collection<T>`	`getChildElementsByType(Class<T> childElementClass)` Return all child elements of a given type
`Collection<ModelElementInstance>`	`getChildElementsByType(ModelElementType childElementType)` Return all child elements of a given type
`DomElement`	`getDomElement()` Returns the represented DOM `DomElement`.
`ModelElementType`	`getElementType()` Returns the element type of this.
`ModelInstance`	`getModelInstance()` Returns the model instance which contains this type instance.
`ModelElementInstance`	`getParentElement()` Returns the parent element of this.
`String`	`getRawTextContent()` Returns the raw text content of the DOM element including all whitespaces.
`String`	`getTextContent()` Returns the text content of the DOM element without leading and trailing spaces.
`ModelElementInstance`	`getUniqueChildElementByNameNs(String namespaceUri, String elementName)` Returns a child element with the given name or 'null' if no such element exists
`ModelElementInstance`	`getUniqueChildElementByType(Class<? extends ModelElementInstance> elementType)` Returns a child element with the given type
`void`	`insertElementAfter(ModelElementInstance elementToInsert, ModelElementInstance insertAfterElement)` Inserts the new element after the given element or at the beginning if the given element is null.
`void`	`removeAttribute(String attributeName)` Removes attribute by name.
`void`	`removeAttributeNs(String namespaceUri, String attributeName)` Removes the attribute by name and namespace.
`boolean`	`removeChildElement(ModelElementInstance child)` Removes the child element from this.
`void`	`replaceChildElement(ModelElementInstance existingChild, ModelElementInstance newChild)` Replace an existing child element with a new child element.
`void`	`replaceWithElement(ModelElementInstance newElement)` Replaces this element with a new element and updates references.
`void`	`setAttributeValue(String attributeName, String xmlValue)` Sets the value by name of a non-ID attribute.
`void`	`setAttributeValue(String attributeName, String xmlValue, boolean isIdAttribute)` Sets attribute value by name.
`void`	`setAttributeValueNs(String namespaceUri, String attributeName, String xmlValue)` Sets the value by name and namespace of a non-ID attribute.
`void`	`setAttributeValueNs(String namespaceUri, String attributeName, String xmlValue, boolean isIdAttribute)` Sets the attribute value by name and namespace.
`void`	`setTextContent(String textContent)` Sets the text content of the DOM element
`void`	`setUniqueChildElementByNameNs(ModelElementInstance newChild)` Adds or replaces a child element by name.
`void`	`updateAfterReplacement()` Execute updates after the element was inserted as a replacement of another element.

- Method Detail
  - getDomElement
```
DomElement getDomElement()
```
    Returns the represented DOM DomElement.
    
    Returns:
    the DOM element
  - getModelInstance
```
ModelInstance getModelInstance()
```
    Returns the model instance which contains this type instance.
    
    Returns:
    the model instance
  - getParentElement
```
ModelElementInstance getParentElement()
```
    Returns the parent element of this.
    
    Returns:
    the parent element
  - getElementType
```
ModelElementType getElementType()
```
    Returns the element type of this.
    
    Returns:
    the element type
  - getAttributeValue
```
String getAttributeValue(String attributeName)
```
    Returns the attribute value for the attribute name.
    
    Parameters:
    attributeName - the name of the attribute
    
    Returns:
    the value of the attribute
  - setAttributeValue
```
void setAttributeValue(String attributeName,
                     String xmlValue)
```
    Sets the value by name of a non-ID attribute.
    
    Parameters:
    attributeName - the name of the attribute
    xmlValue - the value to set
  - setAttributeValue
```
void setAttributeValue(String attributeName,
                     String xmlValue,
                     boolean isIdAttribute)
```
    Sets attribute value by name.
    
    Parameters:
    attributeName - the name of the attribute
    xmlValue - the value to set
    isIdAttribute - true if the attribute is an ID attribute, false otherwise
  - removeAttribute
```
void removeAttribute(String attributeName)
```
    Removes attribute by name.
    
    Parameters:
    attributeName - the name of the attribute
  - getAttributeValueNs
```
String getAttributeValueNs(String namespaceUri,
                         String attributeName)
```
    Returns the attribute value for the given attribute name and namespace URI.
    
    Parameters:
    namespaceUri - the namespace URI of the attribute
    attributeName - the attribute name of the attribute
    
    Returns:
    the value of the attribute
  - setAttributeValueNs
```
void setAttributeValueNs(String namespaceUri,
                       String attributeName,
                       String xmlValue)
```
    Sets the value by name and namespace of a non-ID attribute.
    
    Parameters:
    namespaceUri - the namespace URI of the attribute
    attributeName - the name of the attribute
    xmlValue - the XML value to set
  - setAttributeValueNs
```
void setAttributeValueNs(String namespaceUri,
                       String attributeName,
                       String xmlValue,
                       boolean isIdAttribute)
```
    Sets the attribute value by name and namespace.
    
    Parameters:
    namespaceUri - the namespace URI of the attribute
    attributeName - the name of the attribute
    xmlValue - the XML value to set
    isIdAttribute - true if the attribute is an ID attribute, false otherwise
  - removeAttributeNs
```
void removeAttributeNs(String namespaceUri,
                     String attributeName)
```
    Removes the attribute by name and namespace.
    
    Parameters:
    namespaceUri - the namespace URI of the attribute
    attributeName - the name of the attribute
  - getTextContent
```
String getTextContent()
```
    Returns the text content of the DOM element without leading and trailing spaces. For raw text content see ModelElementInstanceImpl.getRawTextContent().
    
    Returns:
    text content of underlying DOM element with leading and trailing whitespace trimmed
  - getRawTextContent
```
String getRawTextContent()
```
    Returns the raw text content of the DOM element including all whitespaces.
    
    Returns:
    raw text content of underlying DOM element
  - setTextContent
```
void setTextContent(String textContent)
```
    Sets the text content of the DOM element
    
    Parameters:
    textContent - the new text content
  - replaceWithElement
```
void replaceWithElement(ModelElementInstance newElement)
```
    Replaces this element with a new element and updates references.
    
    Parameters:
    newElement - the new element to replace with
  - getUniqueChildElementByNameNs
```
ModelElementInstance getUniqueChildElementByNameNs(String namespaceUri,
                                                 String elementName)
```
    Returns a child element with the given name or 'null' if no such element exists
    
    Parameters:
    namespaceUri - the local name of the element
    elementName - the namespace of the element
    
    Returns:
    the child element or null.
  - getUniqueChildElementByType
```
ModelElementInstance getUniqueChildElementByType(Class<? extends ModelElementInstance> elementType)
```
    Returns a child element with the given type
    
    Parameters:
    elementType - the type of the element
    
    Returns:
    the child element or null
  - setUniqueChildElementByNameNs
```
void setUniqueChildElementByNameNs(ModelElementInstance newChild)
```
    Adds or replaces a child element by name. Replaces an existing Child Element with the same name or adds a new child if no such element exists.
    
    Parameters:
    newChild - the child to add
  - replaceChildElement
```
void replaceChildElement(ModelElementInstance existingChild,
                       ModelElementInstance newChild)
```
    Replace an existing child element with a new child element. Changes the underlying DOM element tree.
    
    Parameters:
    existingChild - the child element to replace
    newChild - the new child element
  - addChildElement
```
void addChildElement(ModelElementInstance newChild)
```
    Adds a new child element to the children of this element. The child is inserted at the correct position of the allowed child types. Updates the underlying DOM element tree.
    
    Parameters:
    newChild - the new child element
    
    Throws:
    
    ModelException - if the new child type is not an allowed child type
  - removeChildElement
```
boolean removeChildElement(ModelElementInstance child)
```
    Removes the child element from this.
    
    Parameters:
    child - the child element to remove
    
    Returns:
    true if the child element could be removed
  - getChildElementsByType
```
Collection<ModelElementInstance> getChildElementsByType(ModelElementType childElementType)
```
    Return all child elements of a given type
    
    Parameters:
    childElementType - the child element type to search for
    
    Returns:
    a collection of elements of the given type
  - getChildElementsByType
```
<T extends ModelElementInstance> Collection<T> getChildElementsByType(Class<T> childElementClass)
```
    Return all child elements of a given type
    
    Parameters:
    childElementClass - the class of the child element type to search for
    
    Returns:
    a collection of elements to the given type
  - insertElementAfter
```
void insertElementAfter(ModelElementInstance elementToInsert,
                      ModelElementInstance insertAfterElement)
```
    Inserts the new element after the given element or at the beginning if the given element is null.
    
    Parameters:
    elementToInsert - the new element to insert
    insertAfterElement - the element to insert after or null to insert at first position
  - updateAfterReplacement
```
void updateAfterReplacement()
```
    Execute updates after the element was inserted as a replacement of another element.

Interface ModelElementInstance

Method Summary

Method Detail

getDomElement

getModelInstance

getParentElement

getElementType

getAttributeValue

setAttributeValue

setAttributeValue

removeAttribute

getAttributeValueNs

setAttributeValueNs

setAttributeValueNs

removeAttributeNs

getTextContent

getRawTextContent

setTextContent

replaceWithElement

getUniqueChildElementByNameNs

getUniqueChildElementByType

setUniqueChildElementByNameNs

replaceChildElement

addChildElement

removeChildElement

getChildElementsByType

getChildElementsByType

insertElementAfter

updateAfterReplacement