Interface ACObjectFlow

All Superinterfaces:

ACActivityEdge, ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELRedefAble, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface ACObjectFlow
extends ACActivityEdge

An object flow is an activity edge that can have objects or data passing along it.

See Also:

• ACObjectFlowHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ACObjectFlow.VAttr

Method Summary

Modifier and Type	Method	Description
ARG_ACObjectFlowPins	createPinsOnObjFlow(ACActivityNode ohSource, ACActivityNode ohTarget)	If an object flow is to be created between the nodes, where at least one of them is not an object node but an action, then this command will create and return the missing pins so that the object flow can be created correctly.
BEBehavior	getSelBehavior()	The selection behavior which selects tokens from a source object node.
ACObjFlowBehavior	getSelectionBehavior()	Selects tokens from a source object node.
BEBehavior	getTransBehavior()	The transformation behavior which changes or replaces data tokens flowing along the edge.
ACObjFlowBehavior	getTransformationBehavior()	Changes or replaces data tokens flowing along the flow.
boolean	isMulticast()	Informs whether the objects in the flow are passed by multicasting.
boolean	isMultireceive()	Informs whether the objects in the flow are gathered from respondents to multicasting.
void	maintainObjTypes()	If the ACObjectFlow connects a typed and a typeless ACObjectNode, this command will set the ELType of the typeless object according to the typed object.
void	modifyBehaviorForSelection(BEBehavior oh)	Assigns a selection behavior to the flow.
void	modifyBehaviorForTransformation(BEBehavior oh)	Assigns a transformation behavior to the flow.
void	setMulticast(boolean value)	Set the value of Attribut IsMulticast.
void	setMultireceive(boolean value)	Set the value of Attribut IsMultireceive.
void	setSelBehavior(BEBehavior value)	Set the value of View SelBehavior.
void	setTransBehavior(BEBehavior value)	Set the value of View TransBehavior.

Methods inherited from interface ACActivityEdge

getActivity, getGuard, getGuardLanguage, getGuardSpecification, getInGroup, getInGroup, getInGroupExplicit, getInGroupImplicit, getInGroupImplicit, getInterrupts, getSource, getTarget, getWeight, getWeightLanguage, getWeightSpecification, insertActivityNode, isInterruptingEdge, isMaintainAble, reconnect, replaceInGroupExplicit, setGuardLanguage, setGuardSpecification, setInGroupExplicit, setSource, setTarget, setWeightSpecification

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface ELContainerAble

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

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface 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, unlockUnit

Methods inherited from interface ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface ELObject

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

Methods inherited from interface ELRedefAble

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MENamespaceAsgnAble

getSignatureMessage

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, 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, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

isMulticast

boolean isMulticast()
             throws InoNetException,
SrvErrorException

Informs whether the objects in the flow are passed by multicasting.

Throws:

InoNetException

SrvErrorException

setMulticast

void setMulticast(boolean value)
           throws InoNetException,
SrvErrorException

Set the value of Attribut IsMulticast.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isMultireceive

boolean isMultireceive()
                throws InoNetException,
SrvErrorException

Informs whether the objects in the flow are gathered from respondents to multicasting.

Throws:

InoNetException

SrvErrorException

setMultireceive

void setMultireceive(boolean value)
              throws InoNetException,
SrvErrorException

Set the value of Attribut IsMultireceive.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getSelBehavior

BEBehavior getSelBehavior()
                   throws InoNetException,
SrvErrorException

The selection behavior which selects tokens from a source object node. The view is not external as the API already provides a view named after the 'selection' role in the superstructure specification which offers the same functionality.

Throws:

InoNetException

SrvErrorException

setSelBehavior

void setSelBehavior(BEBehavior value)
             throws InoNetException,
SrvErrorException

Set the value of View SelBehavior.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getTransBehavior

BEBehavior getTransBehavior()
                     throws InoNetException,
SrvErrorException

The transformation behavior which changes or replaces data tokens flowing along the edge. The view is not external as the API already provides a view named after the 'transformation' role in the superstructure specification which offers the same functionality.

Throws:

InoNetException

SrvErrorException

setTransBehavior

void setTransBehavior(BEBehavior value)
               throws InoNetException,
SrvErrorException

Set the value of View TransBehavior.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

createPinsOnObjFlow

ARG_ACObjectFlowPins createPinsOnObjFlow(ACActivityNode ohSource,
 ACActivityNode ohTarget)
                                  throws InoNetException,
SrvErrorException

If an object flow is to be created between the nodes, where at least one of them is not an object node but an action, then this command will create and return the missing pins so that the object flow can be created correctly.

Parameters:

ohSource - The source element

ohTarget - The target element

Throws:

InoNetException

SrvErrorException

maintainObjTypes

void maintainObjTypes()
               throws InoNetException,
SrvErrorException

If the ACObjectFlow connects a typed and a typeless ACObjectNode, this command will set the ELType of the typeless object according to the typed object. The type will only be set if a free typing of the object is allowed.

Throws:

InoNetException

SrvErrorException

modifyBehaviorForSelection

void modifyBehaviorForSelection(BEBehavior oh)
                         throws InoNetException,
SrvErrorException

Assigns a selection behavior to the flow.

Parameters:

oh -

Throws:

InoNetException

SrvErrorException

modifyBehaviorForTransformation

void modifyBehaviorForTransformation(BEBehavior oh)
                              throws InoNetException,
SrvErrorException

Assigns a transformation behavior to the flow.

Parameters:

oh -

Throws:

InoNetException

SrvErrorException

getSelectionBehavior

ACObjFlowBehavior getSelectionBehavior()
                                throws InoNetException,
SrvErrorException

Selects tokens from a source object node.

Throws:

InoNetException

SrvErrorException

getTransformationBehavior

ACObjFlowBehavior getTransformationBehavior()
                                     throws InoNetException,
SrvErrorException

Changes or replaces data tokens flowing along the flow.

Throws:

InoNetException

SrvErrorException