Package de.mid.innovator.srv2api.icw2bp

Interface BPItemDefinition

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, BCBaseElement, BCBaseNamedStereotypeAble, BCPropertyAble, BCRootReuseAbleElement, BCTerm, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELPictureAble, ELShortNameAble, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, METerm, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface BPItemDefinition
extends BCTerm, ELPictureAble, ELShortNameAble

The Business Object defines an object important for the definition of business processes or concepts. It can be linked to a definition of the structure of the object.

See Also:

• BPItemDefinitionHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BPItemDefinition.VAttr

Method Summary

Modifier and Type	Method	Description
List<BSDia>	getBSDia()	All business object state diagrams with a representation of the BPItemDefinition.
ELClassifier	getClassifier()	The ELClassifier defining the structure of this business object.
List<BPError>	getError()	Assigned BPError.
List<BPError>	getError(MMStereotype stereotype)	The method calls getError and filters its return values according to the given stereotype value.
List<BPEscalation>	getEscalation()	Assigned BPEscalation.
List<BPEscalation>	getEscalation(MMStereotype stereotype)	The method calls getEscalation and filters its return values according to the given stereotype value.
List<BPItemDefinitionRel>	getIncomingDefinitionRel()	All incoming business object relationships connecting this business object.
<T extends BPItemAwareElement> List<T>	getItemAwareElement(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Assigned BPItemAwareElement.
<T extends BPItemAwareElement> List<T>	getItemAwareElement(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getItemAwareElement and filters its return values according to the given stereotype value.
<T extends BPItemAwareElement> List<T>	getItemAwareElementAtPath(Class<T> returnType, BPElementAtPath refObj, K_CONTROL_OPTION... behaviourFlags)	All item aware elements of this business object used in the path up to the specified path element.
<T extends BPItemAwareElement> List<T>	getItemAwareElementAtPath(Class<T> returnType, MMStereotype stereotype, BPElementAtPath refObj, K_CONTROL_OPTION... behaviourFlags)	The method calls getItemAwareElementAtPath and filters its return values according to the given stereotype value.
K_BP_ITEM_KIND	getItemKind()	This defines the nature of the Item.
List<BPMessage>	getMessage()	Assigned BPMessage.
List<BPMessage>	getMessage(MMStereotype stereotype)	The method calls getMessage and filters its return values according to the given stereotype value.
List<BSTransition>	getOwnedTransition(K_CONTROL_OPTION... behaviourFlags)	All transitions owned by this BPItemDefinition.
<T extends BSVertex> List<T>	getOwnedVertex(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All vertex owned by this BPItemDefinition.
<T extends BSState> List<T>	getPossibleState(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All states of the BPItemDefinition.
List<BPProcess>	getProcessWithItemAwareElement()	All processes containing at least one item aware element of this item definition.
List<BPProcess>	getProcessWithItemAwareElement(MMStereotype stereotype)	The method calls getProcessWithItemAwareElement and filters its return values according to the given stereotype value.
List<BPSignal>	getSignal()	Assigned BPSignal.
List<BPSignal>	getSignal(MMStereotype stereotype)	The method calls getSignal and filters its return values according to the given stereotype value.
List<BSDiaStateMachineNode>	getStateMachineNode()	All business object lifecycle nodes representing the BPItemDefinition.
boolean	hasStructureCompatibleTo(ELClassifier refObj)	The structure of the business object is considered to be compatible with the parameter structure if one of them either is a view based on the other structure or contains a view group being deduced from the other structure.
boolean	isCollection()	Setting this flag to true indicates that the actual data type is a collection.
void	setClassifier(ELClassifier value)	Set the value of Foreign Key Classifier.
void	setCollection(boolean value)	Set the value of Attribut IsCollection.
void	setItemKind(K_BP_ITEM_KIND value)	Set the value of Attribut ItemKind.

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

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

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.ADLockAble

getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock

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

getOwnedOption, modifyOptionDlg

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

getReferenceContainer, setReferenceContainer

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

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

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

getBusinessIdentifier, setBusinessIdentifier

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

getAssignedPropertySet, getOwnedAdHocProperty, getPropertySetsAssigned, getPropertySetsAssigned, setPropertySetsAssigned

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

getOwningCollaboration, getOwningProcess

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

getGeneralTerm, getRefinedTerm, getTermDefinition, getTermDefinitionLanguage, setTermDefinition, setTermDefinitionLanguage

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.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.icw2elem.ELNamespaceAsgnAble

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

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.ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

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

getOwnedPicture, getOwnedPictures, getPictureRawData, pictureSetRawData

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

getShortName, getShortNameKind, setShortName, setShortNameKind, setUniqueShortName

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.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

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

getComponent, getManifest

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.METerm

getOwnedSynonym, getSynonym, getSynonymTerms, getSynonymTerms, getTermAble, setSynonymTerms, setTermAble

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

getItemKind

K_BP_ITEM_KIND getItemKind()
                    throws InoNetException,
SrvErrorException

This defines the nature of the Item. Possible values are 'Physical' or 'Information'. The default value is 'Information'. Only information items may be used universally in processes as data objects or messages.

Throws:

InoNetException

SrvErrorException

setItemKind

void setItemKind(K_BP_ITEM_KIND value)
          throws InoNetException,
SrvErrorException

Set the value of Attribut ItemKind.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isCollection

boolean isCollection()
              throws InoNetException,
SrvErrorException

Setting this flag to true indicates that the actual data type is a collection.

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

hasStructureCompatibleTo

boolean hasStructureCompatibleTo(ELClassifier refObj)
                          throws InoNetException,
SrvErrorException

The structure of the business object is considered to be compatible with the parameter structure if one of them either is a view based on the other structure or contains a view group being deduced from the other structure.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getItemAwareElement

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

Assigned 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

getItemAwareElement

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

The method calls getItemAwareElement 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

getMessage

List<BPMessage> getMessage()
                    throws InoNetException,
SrvErrorException

Assigned BPMessage.

Throws:

InoNetException

SrvErrorException

getMessage

List<BPMessage> getMessage(MMStereotype stereotype)
                    throws InoNetException,
SrvErrorException

The method calls getMessage and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getError

List<BPError> getError()
                throws InoNetException,
SrvErrorException

Assigned BPError.

Throws:

InoNetException

SrvErrorException

getError

List<BPError> getError(MMStereotype stereotype)
                throws InoNetException,
SrvErrorException

The method calls getError and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getEscalation

List<BPEscalation> getEscalation()
                          throws InoNetException,
SrvErrorException

Assigned BPEscalation.

Throws:

InoNetException

SrvErrorException

getEscalation

List<BPEscalation> getEscalation(MMStereotype stereotype)
                          throws InoNetException,
SrvErrorException

The method calls getEscalation and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getSignal

List<BPSignal> getSignal()
                  throws InoNetException,
SrvErrorException

Assigned BPSignal.

Throws:

InoNetException

SrvErrorException

getSignal

List<BPSignal> getSignal(MMStereotype stereotype)
                  throws InoNetException,
SrvErrorException

The method calls getSignal and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getItemAwareElementAtPath

<T extends BPItemAwareElement> List<T> getItemAwareElementAtPath(Class<T> returnType,
 BPElementAtPath refObj,
 K_CONTROL_OPTION... behaviourFlags)
                                                          throws InoNetException,
SrvErrorException

All item aware elements of this business object used in the path up to the specified path element.

Parameters:

returnType - Specifies the type of elements to be returned.

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

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

Throws:

InoNetException

SrvErrorException

getItemAwareElementAtPath

<T extends BPItemAwareElement> List<T> getItemAwareElementAtPath(Class<T> returnType,
 MMStereotype stereotype,
 BPElementAtPath refObj,
 K_CONTROL_OPTION... behaviourFlags)
                                                          throws InoNetException,
SrvErrorException

The method calls getItemAwareElementAtPath 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

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

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

Throws:

InoNetException

SrvErrorException

getProcessWithItemAwareElement

List<BPProcess> getProcessWithItemAwareElement()
                                        throws InoNetException,
SrvErrorException

All processes containing at least one item aware element of this item definition.

Throws:

InoNetException

SrvErrorException

getProcessWithItemAwareElement

List<BPProcess> getProcessWithItemAwareElement(MMStereotype stereotype)
                                        throws InoNetException,
SrvErrorException

The method calls getProcessWithItemAwareElement and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

Throws:

InoNetException

SrvErrorException

getBSDia

List<BSDia> getBSDia()
              throws InoNetException,
SrvErrorException

All business object state diagrams with a representation of the BPItemDefinition.

Throws:

InoNetException

SrvErrorException

getPossibleState

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

All states of the BPItemDefinition.

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

getStateMachineNode

List<BSDiaStateMachineNode> getStateMachineNode()
                                         throws InoNetException,
SrvErrorException

All business object lifecycle nodes representing the BPItemDefinition.

Throws:

InoNetException

SrvErrorException

getClassifier

ELClassifier getClassifier()
                    throws InoNetException,
SrvErrorException

The ELClassifier defining the structure of this business object.

Throws:

InoNetException

SrvErrorException

setClassifier

void setClassifier(ELClassifier value)
            throws InoNetException,
SrvErrorException

Set the value of Foreign Key Classifier.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getIncomingDefinitionRel

List<BPItemDefinitionRel> getIncomingDefinitionRel()
                                            throws InoNetException,
SrvErrorException

All incoming business object relationships connecting this business object.

Throws:

InoNetException

SrvErrorException

getOwnedTransition

List<BSTransition> getOwnedTransition(K_CONTROL_OPTION... behaviourFlags)
                               throws InoNetException,
SrvErrorException

All transitions owned by this BPItemDefinition.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwnedVertex

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

All vertex owned by this BPItemDefinition.

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

Sorted:

the result may be sorted.