de.mid.innovator.srv2api.icw2bp
Interface BPDataObject

All Superinterfaces:
ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, BCBaseElement, BCBaseNamedStereotypeAble, BCPropertyAble, BPFlowElement, BPItemAwareElement, BPPathAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface BPDataObject
extends BPFlowElement, BPItemAwareElement


Nested Class Summary
static class BPDataObject.VAttr
           
 
Method Summary
 List<BPObjInputSetRef> assignInputSet(List<? extends ELElement> seq)
          Assigns a list of elements to this input data.
 List<BPObjOutputSetRef> assignOutputSet(List<? extends ELElement> seq)
          Assigns a list of elements to this output data.
 List<BPDataObject> getDataInputOfCall(K_CONTROL_OPTION... behaviourFlags)
          The inputs of the call tasks.
 List<BPDataObject> getDataInputOfCall(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getDataInputOfCall and filters its return values according to the given stereotype value.
 BPDataObject getDataInputOfCalledElement()
          The input of the callable element.
 List<BPDataObject> getDataObjectOfCall()
          The object of the call activity.
 BPDataObject getDataObjectOfCalledElement()
          The object of the callable element.
 K_BP_DATA_OBJECT_TYPE getDataObjectType()
          The type of the BPDataObject.
 List<BPDataObject> getDataOutputOfCall(K_CONTROL_OPTION... behaviourFlags)
          The outputs of the call tasks.
 List<BPDataObject> getDataOutputOfCall(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getDataOutputOfCall and filters its return values according to the given stereotype value.
 BPDataObject getDataOutputOfCalledElement()
          The output of the callable element.
 BPDataStore getDataStore()
          The reuseable data store element being referenced.
 BPInputOutputSpecifyAble getInputOutputSpecifyAble()
          The BPInputOutputSpecifyAble of the BPDataObject.
 List<BPObjInputSetRef> getInputSetR(K_CONTROL_OPTION... behaviourFlags)
          All BPObjInputSetRef which contain the object.
 BPItemDefinition getItemSubjectRefOfStore()
          The business object that is represented by the assigned BPDataStore.
 List<BPObjOutputSetRef> getOutputSetR(K_CONTROL_OPTION... behaviourFlags)
          All BPObjOutputSetRef which contain the BPDataObject.
 BPEventNode getOwningEvent()
          The BPEventNode of the object.
 boolean isCollection()
          Defines if the Data Object represents a collection of elements.
 boolean isDataObjectTypeDynamic()
          If this flag is true, the data object type is automatically modified if the context of the BPDataObject changes.
 void setCollection(boolean value)
          Set the value of Attribut IsCollection.
 void setDataObjectOfCall(List<? extends BPDataObject> values)
          Set the value of Foreign Key DataObjectOfCall.
 void setDataObjectOfCalledElement(BPDataObject value)
          Set the value of Foreign Key DataObjectOfCalledElement.
 void setDataObjectType(K_BP_DATA_OBJECT_TYPE value)
          Set the value of Attribut DataObjectType.
 void setDataObjectTypeDynamic(boolean value)
          Set the value of Attribut IsDataObjectTypeDynamic.
 void setDataStore(BPDataStore value)
          Set the value of Foreign Key DataStore.
 void setItemSubjectRefOfStore(BPItemDefinition value)
          Set the value of View ItemSubjectRefOfStore.
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPFlowElement
assignToLane, getFlowElementContainer, getGroupArtifact, getIncomingAssociationArtifact, getLane, getLaneAssigned, getLaneAssigned, getLaneAssignedInLaneSet, getLaneAssignedInTopLaneSet, getLaneAssignedTransitiveUp, getLaneAssignedTransitiveUp, getLaneSetAssigned, getLaneSetAssigned, getLaneSetAssignedTransitiveUp, getLaneSetAssignedTransitiveUp, getTopFlowElementContainer, setGroupArtifact
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCPropertyAble
getAssignedPropertySet, getOwnedAdHocProperty, getPropertySetsAssigned, getPropertySetsAssigned, setPropertySetsAssigned
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAble
getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPPathAble
getElementAtPathR, getPath, getPath, getPresentationInMasterView, getPresentationInStandardView
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPItemAwareElement
assignStructureDefinition, getDataIOAssociationAtSrc, getDataIOAssociationAtTrg, getDataStateDefinition, getInState, getInState, getItemSubjectRef, getObjectname, getObjectstate, getObjectstructure, getOutgoingItemDefinitionRel, getPathAbleInReach, getPathAbleInReach, getStateDefinitionLanguage, getTopItemAwareElementContainer, isStateReused, isUsedInPath, setDataStateDefinition, setInState, setItemSubjectRef, setObjectname, setObjectstate, setObjectstructure, setStateReused
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble
getClientMappingDependency, getOutgoingConceptRealization, getProxyAsgProperty, getRealizedConcept, getRealizedConcept, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, replaceRealizedConcepts, setMapped, setRealizedConcept, setRequirementOfStakeholder
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble
getOwnedComment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble
assignStereotypeDlg, cloneElement, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, isCloneAbleElement, modifyStereotypePropertyValuesByName, setStereotype, setStereotypePropertyInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCBaseElement
getBusinessIdentifier, setBusinessIdentifier
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble
getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
getUUID, setUUID
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement
buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble
getAnnotation, getLogic, getLogic, getPresentationContext, getSection
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble
getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRowList, getTabElementRowTypeList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble
getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble
getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble
getValueReUseAble, setValueReUseAble
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble
getCheckSetNotToLocalizeAttribute, getClientDependency, getNotToLocalizeAttribute, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedLocalizedValue, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, resetNotToLocalizeAttribute, setNotToLocalizeAttribute, sortContents
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble
delete
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement
getMESupplierDependency, getMESupplierMappingDependency
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 

Method Detail

assignInputSet

List<BPObjInputSetRef> assignInputSet(List<? extends ELElement> seq)
                                      throws InoNetException,
                                             SrvErrorException
Assigns a list of elements to this input data.

Parameters:
seq - List of ELElement
Throws:
InoNetException
SrvErrorException

assignOutputSet

List<BPObjOutputSetRef> assignOutputSet(List<? extends ELElement> seq)
                                        throws InoNetException,
                                               SrvErrorException
Assigns a list of elements to this output data.

Parameters:
seq - List of ELElement
Throws:
InoNetException
SrvErrorException

getDataInputOfCall

List<BPDataObject> getDataInputOfCall(K_CONTROL_OPTION... behaviourFlags)
                                      throws InoNetException,
                                             SrvErrorException
The inputs of the call tasks.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getDataInputOfCall

List<BPDataObject> getDataInputOfCall(MMStereotype stereotype,
                                      K_CONTROL_OPTION... behaviourFlags)
                                      throws InoNetException,
                                             SrvErrorException
The method calls getDataInputOfCall and filters its return values according to the given stereotype value.

Parameters:
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

getDataInputOfCalledElement

BPDataObject getDataInputOfCalledElement()
                                         throws InoNetException,
                                                SrvErrorException
The input of the callable element.

Throws:
InoNetException
SrvErrorException

getDataObjectOfCall

List<BPDataObject> getDataObjectOfCall()
                                       throws InoNetException,
                                              SrvErrorException
The object of the call activity.

Throws:
InoNetException
SrvErrorException

getDataObjectOfCalledElement

BPDataObject getDataObjectOfCalledElement()
                                          throws InoNetException,
                                                 SrvErrorException
The object of the callable element.

Throws:
InoNetException
SrvErrorException

getDataObjectType

K_BP_DATA_OBJECT_TYPE getDataObjectType()
                                        throws InoNetException,
                                               SrvErrorException
The type of the BPDataObject. The type corresponds to different specializations of the BPItemAwareElement metaclass in BPMN.

Throws:
InoNetException
SrvErrorException

getDataOutputOfCall

List<BPDataObject> getDataOutputOfCall(K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException
The outputs of the call tasks.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getDataOutputOfCall

List<BPDataObject> getDataOutputOfCall(MMStereotype stereotype,
                                       K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException
The method calls getDataOutputOfCall and filters its return values according to the given stereotype value.

Parameters:
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

getDataOutputOfCalledElement

BPDataObject getDataOutputOfCalledElement()
                                          throws InoNetException,
                                                 SrvErrorException
The output of the callable element.

Throws:
InoNetException
SrvErrorException

getDataStore

BPDataStore getDataStore()
                         throws InoNetException,
                                SrvErrorException
The reuseable data store element being referenced.

Throws:
InoNetException
SrvErrorException

getInputOutputSpecifyAble

BPInputOutputSpecifyAble getInputOutputSpecifyAble()
                                                   throws InoNetException,
                                                          SrvErrorException
The BPInputOutputSpecifyAble of the BPDataObject.

Throws:
InoNetException
SrvErrorException

getInputSetR

List<BPObjInputSetRef> getInputSetR(K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException
All BPObjInputSetRef which contain the object.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getItemSubjectRefOfStore

BPItemDefinition getItemSubjectRefOfStore()
                                          throws InoNetException,
                                                 SrvErrorException
The business object that is represented by the assigned BPDataStore.

Throws:
InoNetException
SrvErrorException

getOutputSetR

List<BPObjOutputSetRef> getOutputSetR(K_CONTROL_OPTION... behaviourFlags)
                                      throws InoNetException,
                                             SrvErrorException
All BPObjOutputSetRef which contain the BPDataObject.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getOwningEvent

BPEventNode getOwningEvent()
                           throws InoNetException,
                                  SrvErrorException
The BPEventNode of the object.

Throws:
InoNetException
SrvErrorException

isCollection

boolean isCollection()
                     throws InoNetException,
                            SrvErrorException
Defines if the Data Object represents a collection of elements.

Throws:
InoNetException
SrvErrorException

isDataObjectTypeDynamic

boolean isDataObjectTypeDynamic()
                                throws InoNetException,
                                       SrvErrorException
If this flag is true, the data object type is automatically modified if the context of the BPDataObject changes.

Throws:
InoNetException
SrvErrorException

setCollection

void setCollection(boolean value)
                   throws InoNetException,
                          SrvErrorException
Set the value of Attribut IsCollection.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setDataObjectOfCall

void setDataObjectOfCall(List<? extends BPDataObject> values)
                         throws InoNetException,
                                SrvErrorException
Set the value of Foreign Key DataObjectOfCall.

Parameters:
values - The value to be set.
Throws:
InoNetException
SrvErrorException

setDataObjectOfCalledElement

void setDataObjectOfCalledElement(BPDataObject value)
                                  throws InoNetException,
                                         SrvErrorException
Set the value of Foreign Key DataObjectOfCalledElement.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setDataObjectType

void setDataObjectType(K_BP_DATA_OBJECT_TYPE value)
                       throws InoNetException,
                              SrvErrorException
Set the value of Attribut DataObjectType.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setDataObjectTypeDynamic

void setDataObjectTypeDynamic(boolean value)
                              throws InoNetException,
                                     SrvErrorException
Set the value of Attribut IsDataObjectTypeDynamic.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setDataStore

void setDataStore(BPDataStore value)
                  throws InoNetException,
                         SrvErrorException
Set the value of Foreign Key DataStore.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setItemSubjectRefOfStore

void setItemSubjectRefOfStore(BPItemDefinition value)
                              throws InoNetException,
                                     SrvErrorException
Set the value of View ItemSubjectRefOfStore.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException