Package de.mid.innovator.srv2api.icw2meta

Interface ADXModel

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADModel, ADOptionAble, ADVersionAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackage, ELPackageAble, ELUUIDAble, ELValueContainerAble, MMAttachmentAble, MMFormatAble, MMLabelAble, MMLabelTextAttachmentAble, MMMenuAble, MMStereotypeAble, MMTextAble

public interface ADXModel
extends ADModel

Represents an InoX model.

See Also:

• ADXModelHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ADXModel.VAttr

Method Summary

Modifier and Type	Method	Description
ARG_ConfigChangeSet	getChangeSetConfig()	Returns the configuration of change sets for this ADXModel.
String	getExpandedVariableModelName()	provides the model's version name according the pattern specified in property 'VariableModelName'.
MESection	getModelSection()	The section of this model:
List<DBConnection>	getOwnedDBConnection(K_CONTROL_OPTION... behaviourFlags)	All database connetions owned by this ADXModel.
List<MESection>	getOwnedSection(K_CONTROL_OPTION... behaviourFlags)	All sections owned by this model.
List<ARG_TabAbleClassification>	getTabAbleClassifications(List<Class<? extends ELObject>> seqVOcl)	The result list contains stereotypes for each element type of the parameter list, which are allowed as table.
String	getUserWorkRestriction()	Restriction of user rights within this model.
String	getVariableModelName()	Variable name of the ADXModel.
List<ARG_MenuAbleTime>	getVisibleDiagrams(List<String> seqUUID, List<? extends ADClientAble> seqDia)	Returns a list of all menu able elements which are visible for the current login.
<T extends ELContAsgnAble> List<T>	getVisibleOwnedElementTransitiveDownExcludeProfiles(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Returns the current object's result of OwnedElementTransitiveDown subtracted by the union of OwnedElementTransitiveDown applied to all the current object's profiles.
<T extends ELContAsgnAble> List<T>	getVisibleOwnedElementTransitiveDownExcludeProfiles(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getVisibleOwnedElementTransitiveDownExcludeProfiles and filters its return values according to the given stereotype value.
ARG_VisibleTypes	getVisibleTypes()	Returns a list of structures containing a MMStereotype and a list of elements usable as ELType.
void	loadMigration(String name)	Loads the specified migration file.
void	saveMigration(String name, String lang, List<? extends ADVersionAble> seqSel, ADVersionAble mandatory)	Saves a migration file according to the input parameters.
void	setUserWorkRestriction(String value)	Set the value of Info UserWorkRestriction.
void	setVariableModelName(String value)	Set the value of Attribut VariableModelName.

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

allowLogin, deleteInactiveLogins, deleteUpdateCreateInstances, export, getAliases, getAllowGenerationSvg, getAllStereotype, getApplicationConfigurationByPurpose, getBI2DimensionCycleElements, getBI2DimensionCycleElements, getBitmap, getChangeSetOptionLogIsActive, getChangeSetOptionLogWithExport, getChangeSetOptionSetIsActive, getConceptualModels, getConceptualModels, getCopy, getCopyToFile, getCurrentBranchDetails, getDatabaseModels, getDatabaseModels, getDataModels, getDataModels, getDBCycleElements, getDBCycleElements, getDiffRelationshipsAndProperties, getERCycleElements, getERCycleElements, getExportWithUserNotification, getFindByUUID, getFindByUUID, getHyperlinkURI, getListRole, getLoginList, getM2LocaleDetails, getManageUserNotification, getMdlAdmin, getMdlGeneratorSvg, getMdlGuest, getMetaClassInstantiable, getMetaClassStereotypeAbleNotAbstract, getMethod, getModelLocaleCode, getModifyModelNameAndBitmapDlgInit, getMultiVersionFile, getMultiVersionList, getNotifyConfiguration, getNotifyCounters, getOwnedAlias, getOwnedApplicationConfiguration, getOwnedChangeSet, getOwnedConfigTranslation, getOwnedCSInstance, getOwnedElementTransitiveDownExcludeProfiles, getOwnedElementTransitiveDownExcludeProfiles, getOwnedElementTransitiveDownOfProfiles, getOwnedElementTransitiveDownOfProfiles, getOwnedEventLogEntry, getOwnedMdlLogOption, getOwnedMdlUser, getOwnedModelTranslation, getOwnedProfile, getOwnedProfileTranslation, getOwnedSystemModel, getOwnedUsrRole, getOwnedVersion, getPurpose, getRepository, getRootProfile, getSelfAndOwnedElementTransitiveDownExcludeProfiles, getSelfAndOwnedElementTransitiveDownExcludeProfiles, getStandardAlias, getStereotype, getTemplate, importVersion, importVersionFile, isModelNotificationActive, loadConfig, loadUserConfig, modifyMaxHistory, modifyModelNameAndBitmapDlg, modifyPassword, paste, pasteFromFile, saveConfig, saveUserConfig, setAllowGenerationSvg, setBitmap, setChangeSetOptionLogIsActive, setChangeSetOptionLogWithExport, setChangeSetOptionSetIsActive, setExportWithUserNotification, setManageUserNotification, setModelLocaleCode, setModelNotificationActive, setPurpose

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

getOwnedOption, modifyOptionDlg

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

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

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

getAppliedProfile, getAppliedProfileTransitive, getImportingNamespace, getImportingNamespace, getImportingNamespaceTransitive, getImportingNamespaceTransitive, getPackagedElement, getPackageImported, getPublicImportedPackage, getPublicImportedPackage, getPublicImportedPackageTransitive, getPublicImportedPackageTransitive, setAppliedProfile

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

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

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

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

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

copyFormatDlg, copyFormatRule, getCopyFormatDlgInit, getFormat

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

getMenu, getMenuItem, getMenuItemsForTransform

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

getVariableModelName

String getVariableModelName()
                     throws InoNetException,
SrvErrorException

Variable name of the ADXModel. The variable may contain the place holders: '$(model)' and '$(version)'.

Throws:

InoNetException

SrvErrorException

setVariableModelName

void setVariableModelName(String value)
                   throws InoNetException,
SrvErrorException

Set the value of Attribut VariableModelName.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getUserWorkRestriction

String getUserWorkRestriction()
                       throws InoNetException,
SrvErrorException

Restriction of user rights within this model.

Throws:

InoNetException

SrvErrorException

setUserWorkRestriction

void setUserWorkRestriction(String value)
                     throws InoNetException,
SrvErrorException

Set the value of Info UserWorkRestriction.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getExpandedVariableModelName

String getExpandedVariableModelName()
                             throws InoNetException,
SrvErrorException

provides the model's version name according the pattern specified in property 'VariableModelName'.

Throws:

InoNetException

SrvErrorException

getVisibleOwnedElementTransitiveDownExcludeProfiles

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

Returns the current object's result of OwnedElementTransitiveDown subtracted by the union of OwnedElementTransitiveDown applied to all the current object's profiles. The list is restricted to elements with read permission for the current login.

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

getVisibleOwnedElementTransitiveDownExcludeProfiles

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

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

getChangeSetConfig

ARG_ConfigChangeSet getChangeSetConfig()
                                throws InoNetException,
SrvErrorException

Returns the configuration of change sets for this ADXModel.

Throws:

InoNetException

SrvErrorException

getTabAbleClassifications

List<ARG_TabAbleClassification> getTabAbleClassifications(List<Class<? extends ELObject>> seqVOcl)
                                                   throws InoNetException,
SrvErrorException

The result list contains stereotypes for each element type of the parameter list, which are allowed as table. If the parameter list is empty, the result list contains all element types, which are allowed as table.

Parameters:

seqVOcl - list of element types

Throws:

InoNetException

SrvErrorException

getVisibleDiagrams

List<ARG_MenuAbleTime> getVisibleDiagrams(List<String> seqUUID,
 List<? extends ADClientAble> seqDia)
                                   throws InoNetException,
SrvErrorException

Returns a list of all menu able elements which are visible for the current login. The list contains a time stamp for each element. This is the time of the last modification or the creation if the element has not been modified. The list of menu able elements may be restricted to elements matching an entry of the uuid or the diagram list.

Parameters:

seqUUID - list of uuids of diagram or behavior

seqDia - list of diagrams or behaviors

Throws:

InoNetException

SrvErrorException

getVisibleTypes

ARG_VisibleTypes getVisibleTypes()
                          throws InoNetException,
SrvErrorException

Returns a list of structures containing a MMStereotype and a list of elements usable as ELType. The list of types contains only elements which are visible for the current login.

Throws:

InoNetException

SrvErrorException

loadMigration

void loadMigration(String name)
            throws InoNetException,
SrvErrorException

Loads the specified migration file.

Parameters:

name - name of the migration file

Throws:

InoNetException

SrvErrorException

saveMigration

void saveMigration(String name,
 String lang,
 List<? extends ADVersionAble> seqSel,
 ADVersionAble mandatory)
            throws InoNetException,
SrvErrorException

Saves a migration file according to the input parameters.

Parameters:

name - name of the migration file

lang - de | en

seqSel - sequence of elements to be used

mandatory - mandatory element

Throws:

InoNetException

SrvErrorException

getOwnedSection

List<MESection> getOwnedSection(K_CONTROL_OPTION... behaviourFlags)
                         throws InoNetException,
SrvErrorException

All sections owned by this model.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getModelSection

MESection getModelSection()
                   throws InoNetException,
SrvErrorException

The section of this model:

Throws:

InoNetException

SrvErrorException

getOwnedDBConnection

List<DBConnection> getOwnedDBConnection(K_CONTROL_OPTION... behaviourFlags)
                                 throws InoNetException,
SrvErrorException

All database connetions owned by this ADXModel.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.