Package de.mid.innovator.srv2api.icw2bp

Interface BPItemAwareElement

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, BCBaseElement, BCBaseNamedStereotypeAble, BPResourceRoleAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

BPDataObject, BPDataStore, BPProperty

public interface BPItemAwareElement
extends BPResourceRoleAble

This is a utility class for BPItemAwareElement that provides static methods for creation or other purposes.

Note:

The interface BPItemAwareElement describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BPItemAwareElement.VAttr

Method Summary

Modifier and Type	Method	Description
BPItemDefinition	assignStructureDefinition(ELClassifier structure)	Assigns a structure to an item aware element by using an existing or by creating a new item definition which connects the two elements.
List<BPDataIOAssociation>	getDataIOAssocAtSrc()	All data associations of the source element.
List<BPDataIOAssociation>	getDataIOAssocAtTrg()	All data associations of the target.
List<BPDataIOAssociation>	getDataIOAssociationAtSrc()	All BPDataIOAssociation of the element.
List<BPDataIOAssociation>	getDataIOAssociationAtTrg()	All data associations of the target.
String	getDataStateDefinition()	The local definition of the state of the item aware element.
<T extends BSState> List<T>	getInState(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Assigned BSState to BPItemAwareElement.
<T extends BSState> List<T>	getInState(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getInState and filters its return values according to the given stereotype value.
<T extends SMState> List<T>	getInUMLState(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All current states of the BPItemAwareElement.
BPItemDefinition	getItemSubjectRef()	The business object that is represented by the item aware element.
String	getObjectname()	Returns a name for the BPItemAwareElement that depends on a set of assigned elements.
String	getObjectstate()	Returns the name of all object states concatenated as a single string.
String	getObjectstructure()	Returns the name of the data structure of a maybe assigned BPItemDefinition.
BPItemDefinitionRel	getOutgoingItemDefinitionRel()	All BPItemDefinitionRel of the item aware element.
<T extends BPPathAble> List<T>	getPathAbleInReach(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All potential path elements in reach, either as the owner of the item aware element or reachable by a data association.
<T extends BPPathAble> List<T>	getPathAbleInReach(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getPathAbleInReach and filters its return values according to the given stereotype value.
List<BPDataResource>	getResource(K_CONTROL_OPTION... behaviourFlags)	All resource assignments of the BPItemAwareElement.
String	getStateDefinitionLanguage()	Specifies the languages which the definition is stated in.
BPFlowElementContainer	getTopItemAwareElementContainer()	Returns the process as top flow element container of this item aware element.
boolean	isStateReused()	True if the state of the object is specified using reusable states instead of a local state description, a mere string value.
boolean	isUsedInPath(BPPath refObj)	True, if the item aware element has a connection to an element which is part of the path.
void	setDataStateDefinition(String value)	Set the value of Attribut DataStateDefinition.
void	setInState(List<? extends BSState> values)	Set the value of View InState.
void	setInUMLState(List<? extends SMState> values)	Set the value of Foreign Key InUMLState.
void	setItemSubjectRef(BPItemDefinition value)	Set the value of View ItemSubjectRef.
void	setObjectname(String value)	Set the value of Info Objectname.
void	setObjectstate(String value)	Set the value of Info Objectstate.
void	setObjectstructure(String value)	Set the value of Info Objectstructure.
void	setStateReused(boolean value)	Set the value of Attribut IsStateReused.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

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

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.icw2meta.ADM2AttrModifyAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2bc.BCBaseElement

getBusinessIdentifier, setBusinessIdentifier

Methods inherited from interface de.mid.innovator.srv2api.icw2bp.BPResourceRoleAble

getResourceAssigned, getResourceAssigned, getResourceRole, getResourceRoleByRACIType, getResourceRoleByRACIType, getUseResources, setResourceAssigned, setUseResources

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods 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, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods 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, setElementColor

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2model.METermAble

getTerm, setTerm

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

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.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, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

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

Method Details

getDataStateDefinition

String getDataStateDefinition()
                       throws InoNetException,
SrvErrorException

The local definition of the state of the item aware element.

Throws:

InoNetException

SrvErrorException

setDataStateDefinition

void setDataStateDefinition(String value)
                     throws InoNetException,
SrvErrorException

Set the value of Attribut DataStateDefinition.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getStateDefinitionLanguage

String getStateDefinitionLanguage()
                           throws InoNetException,
SrvErrorException

Specifies the languages which the definition is stated in. The interpretation of the definition depends on the language. If the languages are unspecified, they might be implicit from the expression body or the context.

Throws:

InoNetException

SrvErrorException

isStateReused

boolean isStateReused()
               throws InoNetException,
SrvErrorException

True if the state of the object is specified using reusable states instead of a local state description, a mere string value.

Throws:

InoNetException

SrvErrorException

setStateReused

void setStateReused(boolean value)
             throws InoNetException,
SrvErrorException

Set the value of Attribut IsStateReused.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isUsedInPath

boolean isUsedInPath(BPPath refObj)
              throws InoNetException,
SrvErrorException

True, if the item aware element has a connection to an element which is part of the path.

Parameters:

refObj - A further instance of type BPPath which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

getObjectname

String getObjectname()
              throws InoNetException,
SrvErrorException

Returns a name for the BPItemAwareElement that depends on a set of assigned elements. If the object is defined by a BPItemDefinition then the name of this element is returned. If the BPItemAwareElement is a data store node and has a BPDataStore assigned (but no BPItemDefinition) then the name of the data store is delivered. In all other cases the name of the BPItemAwareElement will appear.

Throws:

InoNetException

SrvErrorException

setObjectname

void setObjectname(String value)
            throws InoNetException,
SrvErrorException

Set the value of Info Objectname.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getObjectstate

String getObjectstate()
               throws InoNetException,
SrvErrorException

Returns the name of all object states concatenated as a single string. Depending on the property 'uses Global State' only assigned global or local states are evaluated.

Throws:

InoNetException

SrvErrorException

setObjectstate

void setObjectstate(String value)
             throws InoNetException,
SrvErrorException

Set the value of Info Objectstate.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getObjectstructure

String getObjectstructure()
                   throws InoNetException,
SrvErrorException

Returns the name of the data structure of a maybe assigned BPItemDefinition.

Throws:

InoNetException

SrvErrorException

setObjectstructure

void setObjectstructure(String value)
                 throws InoNetException,
SrvErrorException

Set the value of Info Objectstructure.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getItemSubjectRef

BPItemDefinition getItemSubjectRef()
                            throws InoNetException,
SrvErrorException

The business object that is represented by the item aware element.

Throws:

InoNetException

SrvErrorException

setItemSubjectRef

void setItemSubjectRef(BPItemDefinition value)
                throws InoNetException,
SrvErrorException

Set the value of View ItemSubjectRef.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getInState

<T extends BSState> List<T> getInState(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

Assigned BSState to BPItemAwareElement.

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:

InoNetException

SrvErrorException

getInState

<T extends BSState> List<T> getInState(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
SrvErrorException

The method calls getInState 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 list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

setInState

void setInState(List<? extends BSState> values)
         throws InoNetException,
SrvErrorException

Set the value of View InState.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

getTopItemAwareElementContainer

BPFlowElementContainer getTopItemAwareElementContainer()
                                                throws InoNetException,
SrvErrorException

Returns the process as top flow element container of this item aware element.

Throws:

InoNetException

SrvErrorException

getPathAbleInReach

<T extends BPPathAble> List<T> getPathAbleInReach(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                           throws InoNetException,
SrvErrorException

All potential path elements in reach, either as the owner of the item aware element or reachable by a 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:

InoNetException

SrvErrorException

getPathAbleInReach

<T extends BPPathAble> List<T> getPathAbleInReach(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                           throws InoNetException,
SrvErrorException

The method calls getPathAbleInReach 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 list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

assignStructureDefinition

BPItemDefinition assignStructureDefinition(ELClassifier structure)
                                    throws InoNetException,
SrvErrorException

Assigns a structure to an item aware element by using an existing or by creating a new item definition which connects the two elements.

Parameters:

structure - The element which defines the structure.

Throws:

InoNetException

SrvErrorException

getDataIOAssociationAtSrc

List<BPDataIOAssociation> getDataIOAssociationAtSrc()
                                             throws InoNetException,
SrvErrorException

All BPDataIOAssociation of the element.

Throws:

InoNetException

SrvErrorException

getDataIOAssociationAtTrg

List<BPDataIOAssociation> getDataIOAssociationAtTrg()
                                             throws InoNetException,
SrvErrorException

All data associations of the target.

Throws:

InoNetException

SrvErrorException

getOutgoingItemDefinitionRel

BPItemDefinitionRel getOutgoingItemDefinitionRel()
                                          throws InoNetException,
SrvErrorException

All BPItemDefinitionRel of the item aware element.

Throws:

InoNetException

SrvErrorException

getDataIOAssocAtSrc

List<BPDataIOAssociation> getDataIOAssocAtSrc()
                                       throws InoNetException,
SrvErrorException

All data associations of the source element.

Throws:

InoNetException

SrvErrorException

getDataIOAssocAtTrg

List<BPDataIOAssociation> getDataIOAssocAtTrg()
                                       throws InoNetException,
SrvErrorException

All data associations of the target.

Throws:

InoNetException

SrvErrorException

getResource

List<BPDataResource> getResource(K_CONTROL_OPTION... behaviourFlags)
                          throws InoNetException,
SrvErrorException

All resource assignments of the BPItemAwareElement.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getInUMLState

<T extends SMState> List<T> getInUMLState(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                   throws InoNetException,
SrvErrorException

All current states of the BPItemAwareElement.

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:

InoNetException

SrvErrorException

setInUMLState

void setInUMLState(List<? extends SMState> values)
            throws InoNetException,
SrvErrorException

Set the value of Foreign Key InUMLState.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException