Package de.mid.innovator.srv2api.icw2bp
Interface BPDataIOAssociation
- All Superinterfaces:
ADClientAble,ADFindAble,ADHistoryAble,ADM2AttrModifyAble,BCBaseElement,ELContainerAble,ELContAsgnAble,ELDeleteAble,ELElement,ELObject,ELUUIDAble,ELValueContainerAble,MECommentAble,MEConstraintAble,MEModelElement,MEStereotypeAble,METermAble,MMAttachmentAble,MMCommentContainerAble,MMLabelAble,MMLabelTextAttachmentAble,MMStereotypeAble,MMTextAble
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionassignDerivedStructure(ADClientAble partOfStructure) For the structure parts passed as the argument action is taken according to the model setting how to handle derived structures at IO associations.assignObjectWithDataModelStructure(ADClientAble partOfStructure) For the structure parts passed as the argument a structure definition is created if there doesn't exist one already.assignViewWithObject(ADClientAble partOfStructure) For the structure parts passed as the argument a structure definition is created if there doesn't exist one already.The assignment expression definition used at the data I/O association.Returns the list of structures and structure parts of the data model eligible for the structure yet to be defined.The data object or data store reference which does not belong to the owner of theBPDataIOAssociation.Direction of flow.The activity of the data association.The event of the data association.Ensure a single source element for theBPDataIOAssociationalso the data model allows more than one source.The target item of the data association.<T extends BPItemAwareElement>
List<T> getSourceItemAwareElement(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) The source element of the data association.getSourceItemDefinition(MMStereotype stereotype) The method calls getSourceItemDefinition and filters its return values according to the given stereotype value.getSourceStates(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) getSourceStates(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags) The method calls getSourceStates and filters its return values according to the given stereotype value.<T extends ELClassifier>
List<T> getSourceStructureDefinition(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) Returns the connectedELClassifierof the assignedBPItemDefinitionat the associations source element.<T extends ELClassifier>
List<T> getSourceStructureDefinition(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags) The method calls getSourceStructureDefinition and filters its return values according to the given stereotype value.The structure definition of the business object of the element being considered external to thisBPDataIOAssociation.Returns the list of structures and structure parts eligible for the structure yet to be defined.The target item of the data association.getTargetStates(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) getTargetStates(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags) The method calls getTargetStates and filters its return values according to the given stereotype value.Returns the connectedELClassifierof the assignedBPItemDefinitionat the associations target element.The transformation expression's text.Specifies the languages which the transformation expression is stated in.The transformation expression definition used at the data I/O association.booleanTrue if the source and the target item aware elements have the same business object assigned.booleanTrue if the source and the target item aware elements have both a business object and of those two business objects have the same structure.booleanTrue if there is a business object at the source side and if that business object has a structure, too.booleanTrue if the element being considered external to thisBPDataIOAssociationhas a business object with a structure assigned.booleanTrue if there is a business object at the target side and if that business object has a structure, too.booleanTrue if a global expression is used instead of a local transformation rule.booleanTrue if there is no structure at the I/O element, which is either a data input or a data output at the owner of theBPDataIOAssociation.booleanTrue if there are business objects with a structure at both sides and if the source structure is considered to be a part of the target structure.booleanTrue if there are business objects with a structure at both sides and if the target structure is considered to be a part of the source structure.voidreconnectRelship(ELElement ohNew, K_SIDE kSide) Assigns this data association to a new source/target element.voidsetAssignmentExpression(List<? extends BCExpression> values) Set the value of Foreign Key AssignmentExpression.voidsetExpressionReused(boolean value) Set the value of Attribut IsExpressionReused.voidSet the value of Foreign Key SingleSourceItemAwareElement.voidSet the value of Foreign Key SingleTargetItemAwareElement.voidsetSourceItemAwareElement(List<? extends BPItemAwareElement> values) Set the value of Foreign Key SourceItemAwareElement.voidSet the value of Foreign Key TargetItemAwareElement.voidSet the value of Attribut TransformationExpressionBody.voidSet the value of Foreign Key TransformExpression.Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble
getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDiaMethods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble
getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistoryMethods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble
getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModifyMethods inherited from interface de.mid.innovator.srv2api.icw2bc.BCBaseElement
getBusinessIdentifier, setBusinessIdentifierMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble
getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContentsMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwnerMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble
deleteMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement
duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnitMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject
getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasReadMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUIDMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble
getValueReUseAble, setValueReUseAbleMethods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssignMethods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssignMethods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement
buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColorMethods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble
getApplicableAnalysisDia, getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholderMethods inherited from interface de.mid.innovator.srv2api.icw2model.METermAble
getTerm, setTermMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachmentMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble
getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConceptMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble
getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfoMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble
assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAbleMethods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble
getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg
-
Method Details
-
getTransformationExpressionLanguage
Specifies the languages which the transformation expression is stated in.- Throws:
InoNetExceptionSrvErrorException
-
getTransformationExpressionBody
The transformation expression's text.- Throws:
InoNetExceptionSrvErrorException
-
setTransformationExpressionBody
Set the value of Attribut TransformationExpressionBody.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
isExpressionReused
True if a global expression is used instead of a local transformation rule.- Throws:
InoNetExceptionSrvErrorException
-
setExpressionReused
Set the value of Attribut IsExpressionReused.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getFlowDirection
Direction of flow.- Throws:
InoNetExceptionSrvErrorException
-
hasSourceDefinitionWithStructure
True if there is a business object at the source side and if that business object has a structure, too.- Throws:
InoNetExceptionSrvErrorException
-
hasTargetDefinitionWithStructure
True if there is a business object at the target side and if that business object has a structure, too.- Throws:
InoNetExceptionSrvErrorException
-
isSourceStructureCompatibleToTargetStructure
True if there are business objects with a structure at both sides and if the source structure is considered to be a part of the target structure.- Throws:
InoNetExceptionSrvErrorException
-
isTargetStructureCompatibleToSourceStructure
True if there are business objects with a structure at both sides and if the target structure is considered to be a part of the source structure.- Throws:
InoNetExceptionSrvErrorException
-
hasSameSourceTargetDefinition
True if the source and the target item aware elements have the same business object assigned.- Throws:
InoNetExceptionSrvErrorException
-
hasSameSourceTargetStructure
True if the source and the target item aware elements have both a business object and of those two business objects have the same structure.- Throws:
InoNetExceptionSrvErrorException
-
isMissingIOStructure
True if there is no structure at the I/O element, which is either a data input or a data output at the owner of theBPDataIOAssociation.- Throws:
InoNetExceptionSrvErrorException
-
hasStructureOfExternalElement
True if the element being considered external to thisBPDataIOAssociationhas a business object with a structure assigned.- Throws:
InoNetExceptionSrvErrorException
-
getSourceItemDefinition
- Throws:
InoNetExceptionSrvErrorException
-
getSourceItemDefinition
List<BPItemDefinition> getSourceItemDefinition(MMStereotype stereotype) throws InoNetException, SrvErrorException The method calls getSourceItemDefinition and filters its return values according to the given stereotype value.- Parameters:
stereotype- The stereotype used to filter the result list- Throws:
InoNetExceptionSrvErrorException
-
getTargetItemDefinition
- Throws:
InoNetExceptionSrvErrorException
-
getIOElementAtOwner
- Throws:
InoNetExceptionSrvErrorException
-
getExternalElement
The data object or data store reference which does not belong to the owner of theBPDataIOAssociation. It is the object at the opposite side of the data input or a data output, which belongs to the owner of theBPDataIOAssociation.- Throws:
InoNetExceptionSrvErrorException
-
getItemDefinitionOfExternalElement
- Throws:
InoNetExceptionSrvErrorException
-
getStructureOfExternalElement
The structure definition of the business object of the element being considered external to thisBPDataIOAssociation.- Throws:
InoNetExceptionSrvErrorException
-
getOwningPathAble
- Throws:
InoNetExceptionSrvErrorException
-
getSourceStructureDefinition
<T extends ELClassifier> List<T> getSourceStructureDefinition(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException Returns the connectedELClassifierof the assignedBPItemDefinitionat the associations source 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:
InoNetExceptionSrvErrorException
-
getSourceStructureDefinition
<T extends ELClassifier> List<T> getSourceStructureDefinition(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException The method calls getSourceStructureDefinition 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 listbehaviourFlags- An optional list of enum values to control the behaviour of the command.- Throws:
InoNetExceptionSrvErrorException
-
getTargetStructureDefinition
Returns the connectedELClassifierof the assignedBPItemDefinitionat the associations target element.- Throws:
InoNetExceptionSrvErrorException
-
getSourceStates
<T extends BSState> List<T> getSourceStates(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException - 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:
InoNetExceptionSrvErrorException
-
getSourceStates
<T extends BSState> List<T> getSourceStates(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException The method calls getSourceStates 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 listbehaviourFlags- An optional list of enum values to control the behaviour of the command.- Throws:
InoNetExceptionSrvErrorException
-
getTargetStates
<T extends BSState> List<T> getTargetStates(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException - 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:
InoNetExceptionSrvErrorException
-
getTargetStates
<T extends BSState> List<T> getTargetStates(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException The method calls getTargetStates 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 listbehaviourFlags- An optional list of enum values to control the behaviour of the command.- Throws:
InoNetExceptionSrvErrorException
-
getDataModelPartsForView
ARG_ModifyByM2AttrOhValueListOut getDataModelPartsForView() throws InoNetException, SrvErrorExceptionReturns the list of structures and structure parts of the data model eligible for the structure yet to be defined.- Throws:
InoNetExceptionSrvErrorException
-
getStructurePartsForView
ARG_ModifyByM2AttrOhValueListOut getStructurePartsForView() throws InoNetException, SrvErrorExceptionReturns the list of structures and structure parts eligible for the structure yet to be defined.- Throws:
InoNetExceptionSrvErrorException
-
assignDerivedStructure
ADClientAble assignDerivedStructure(ADClientAble partOfStructure) throws InoNetException, SrvErrorException For the structure parts passed as the argument action is taken according to the model setting how to handle derived structures at IO associations. The command returns the element which refers to the derived structure.- Parameters:
partOfStructure- A structure itself or a part of it to create a new view from. If a view and and object do already exist, the existing one will be taken.- Throws:
InoNetExceptionSrvErrorException
-
assignObjectWithDataModelStructure
BPItemDefinition assignObjectWithDataModelStructure(ADClientAble partOfStructure) throws InoNetException, SrvErrorException For the structure parts passed as the argument a structure definition is created if there doesn't exist one already. If the structure part passed is a structure from the data model, no new structure is created. The new or existing structure defines the structure of the object at the IO association. The command returns the business object which is referred by the object.- Parameters:
partOfStructure- A structure itself or a part of it to create a new view from. If a view and and object do already exist, the existing one will be taken.- Throws:
InoNetExceptionSrvErrorException
-
assignViewWithObject
BPItemDefinition assignViewWithObject(ADClientAble partOfStructure) throws InoNetException, SrvErrorException For the structure parts passed as the argument a structure definition is created if there doesn't exist one already. The new or existing structure definition serves as a view of the base structure and defines the structure of the object at the IO association. The command returns the business object which is referred by the object.- Parameters:
partOfStructure- A structure itself or a part of it to create a new view from. If a view and and object do already exist, the existing one will be taken.- Throws:
InoNetExceptionSrvErrorException
-
reconnectRelship
Assigns this data association to a new source/target element.- Parameters:
ohNew- the element to which the relationship is redirectedkSide- specifies the role of the new element in the relationship- Throws:
InoNetExceptionSrvErrorException
-
getSourceItemAwareElement
<T extends BPItemAwareElement> List<T> getSourceItemAwareElement(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException The source element of the data association.- 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:
InoNetExceptionSrvErrorException
-
setSourceItemAwareElement
void setSourceItemAwareElement(List<? extends BPItemAwareElement> values) throws InoNetException, SrvErrorException Set the value of Foreign Key SourceItemAwareElement.- Parameters:
values- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getTargetItemAwareElement
The target item of the data association.- Throws:
InoNetExceptionSrvErrorException
-
setTargetItemAwareElement
Set the value of Foreign Key TargetItemAwareElement.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getTransformExpression
The transformation expression definition used at the data I/O association.- Throws:
InoNetExceptionSrvErrorException
-
setTransformExpression
Set the value of Foreign Key TransformExpression.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getAssignmentExpression
The assignment expression definition used at the data I/O association.- Throws:
InoNetExceptionSrvErrorException
-
setAssignmentExpression
void setAssignmentExpression(List<? extends BCExpression> values) throws InoNetException, SrvErrorException Set the value of Foreign Key AssignmentExpression.- Parameters:
values- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getOwningActivityNode
The activity of the data association.- Throws:
InoNetExceptionSrvErrorException
-
getOwningEventNode
The event of the data association.- Throws:
InoNetExceptionSrvErrorException
-
getSingleSourceItemAwareElement
Ensure a single source element for theBPDataIOAssociationalso the data model allows more than one source.- Throws:
InoNetExceptionSrvErrorException
-
setSingleSourceItemAwareElement
void setSingleSourceItemAwareElement(BPItemAwareElement value) throws InoNetException, SrvErrorException Set the value of Foreign Key SingleSourceItemAwareElement.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getSingleTargetItemAwareElement
The target item of the data association.- Throws:
InoNetExceptionSrvErrorException
-
setSingleTargetItemAwareElement
void setSingleTargetItemAwareElement(BPItemAwareElement value) throws InoNetException, SrvErrorException Set the value of Foreign Key SingleTargetItemAwareElement.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-