ModuleDescriptor

All Superinterfaces:

Commitable, IProject, ModulesManager, ProjectDescriptor

Deprecated.
Check MagicDraw OpenAPI User Guide for migration details.
```
@Deprecated
 @OpenApiAll
public interface ModuleDescriptor
extends ProjectDescriptor, IProject
```
Descriptor of used module. It contains all information about what module provides.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADDED_MODULES_PROPERTY` Deprecated.
`static java.lang.String`	`AUTO_LOAD_KIND_PROPERTY` Deprecated.
`static java.lang.String`	`DESCRIPTION_PROPERTY` Deprecated.
`static java.lang.String`	`DIRTY_PROPERTY` Deprecated.
`static java.lang.String`	`EDITABLE_PROPERTY` Deprecated.
`static java.lang.String`	`EXPORTED_DESCRIPTION_PROPERTY` Deprecated.
`static java.lang.String`	`LATEST_PROPERTY` Deprecated.
`static java.lang.String`	`LOAD_INDEX_PROPERTY` Deprecated.
`static java.lang.String`	`LOADED_PROPERTY` Deprecated.
`static java.lang.String`	`LOCKED_PROPERTY` Deprecated.
`static java.lang.String`	`MANUALY_UNLOADED_PROPERTY` Deprecated.
`static java.lang.String`	`MOUNT_TABLE_PROPERTY` Deprecated.
`static java.lang.String`	`OPTIONS_PROPERTY` Deprecated.
`static java.lang.String`	`PROJECT_DESCRIPTOR_PROPERTY` Deprecated.
`static java.lang.String`	`REMOVE_PROPERTY` Deprecated.
`static java.lang.String`	`REMOVED_MODULES_PROPERTY` Deprecated.
`static java.lang.String`	`REQUIRED_VERSION_PROPERTY` Deprecated.
`static java.lang.String`	`SHARE_TABLE_PROPERTY` Deprecated.
`static java.lang.String`	`STYLE_MANAGER_PROPERTY` Deprecated.
`static java.lang.String`	`USED_VERSION_PROPERTY` Deprecated.
`static java.lang.String`	`VERSION_PROPERTY` Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addMount(MountInfo mount)` Deprecated. Adds new mount to this module.
`MountInfo`	`addMount(Package pack, java.lang.String preferredPath)` Deprecated. Adds new mount.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Deprecated.
`void`	`addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener)` Deprecated.
`boolean`	`equalsIgnoreVersion(ProjectDescriptor module)` Deprecated.
`AutoLoadKind`	`getAutoLoadType()` Deprecated. Returns module handling mode.
`java.lang.String`	`getDescription()` Deprecated.
`java.util.Collection<MountInfo>`	`getMounts()` Deprecated. Return all mount points from this module.
`int`	`getRequiredVersion()` Deprecated.
`java.lang.String`	`getUsedVersion()` Deprecated.
`long`	`getVersion()` Deprecated.
`boolean`	`isLatest()` Deprecated.
`boolean`	`isLoaded()` Deprecated.
`boolean`	`isLoadIndex()` Deprecated.
`boolean`	`isLocked()` Deprecated.
`boolean`	`isManualUnloaded()` Deprecated.
`void`	`removeMount(MountInfo mount)` Deprecated. Removes given mount
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Deprecated.
`void`	`removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener)` Deprecated.
`void`	`setDescription(java.lang.String description)` Deprecated. Sets new description for module.
`void`	`setEditable(boolean value)` Deprecated. Sets new editable flag.
`void`	`setLatest(boolean latest)` Deprecated.
`void`	`setLoaded(boolean loaded)` Deprecated. Marks this module as loaded or not loaded.
`void`	`setLoadIndex(boolean load)` Deprecated. Sets new value of module load index property
`void`	`setLoadType(AutoLoadKind type)` Deprecated. Sets auto load type.
`void`	`setLocked(boolean b)` Deprecated. Marks module as locked.
`void`	`setManualyUnloaded(boolean value)` Deprecated. Marks or clears this module as manually unloaded.
`void`	`setOptions(ProjectOptions options)` Deprecated.
`void`	`setRequiredVersion(int version)` Deprecated.
`void`	`setStyleManager(StyleManager managerToRead)` Deprecated.
`void`	`setUsedVersion(java.lang.String version)` Deprecated. Sets used version of this module.
`void`	`setVersion(long version)` Deprecated. Sets version of this module.
`void`	`updateLocation(java.net.URI uri)` Deprecated. Sets new location

Methods inherited from interface com.nomagic.magicdraw.core.project.ProjectDescriptor
getRepresentationString, getURI, isRemote

Methods inherited from interface com.nomagic.magicdraw.core.modules.IProject
getBelongsTo, getExporterDescription, getOptions, getStyleManager, getTags, isDirty, isEditable, setDirty, setExporterDescription, setMountTable, setShareTable, setTags

Methods inherited from interface com.nomagic.magicdraw.core.modules.ModulesManager
getMountTable, getShareTable

Methods inherited from interface com.nomagic.magicdraw.core.modules.Commitable
getAddedModules, getAddedObjectIDS, getRemoteID, getRemovedIDS, getRemovedModules, setAddedModules, setRemote, setRemovedModules

- Field Detail
  - AUTO_LOAD_KIND_PROPERTY
```
static final java.lang.String AUTO_LOAD_KIND_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - MANUALY_UNLOADED_PROPERTY
```
static final java.lang.String MANUALY_UNLOADED_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - LOAD_INDEX_PROPERTY
```
static final java.lang.String LOAD_INDEX_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION_PROPERTY
```
static final java.lang.String DESCRIPTION_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SHARE_TABLE_PROPERTY
```
static final java.lang.String SHARE_TABLE_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - MOUNT_TABLE_PROPERTY
```
static final java.lang.String MOUNT_TABLE_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - LOCKED_PROPERTY
```
static final java.lang.String LOCKED_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - VERSION_PROPERTY
```
static final java.lang.String VERSION_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - USED_VERSION_PROPERTY
```
static final java.lang.String USED_VERSION_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - REQUIRED_VERSION_PROPERTY
```
static final java.lang.String REQUIRED_VERSION_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - LATEST_PROPERTY
```
static final java.lang.String LATEST_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - STYLE_MANAGER_PROPERTY
```
static final java.lang.String STYLE_MANAGER_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - OPTIONS_PROPERTY
```
static final java.lang.String OPTIONS_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - EDITABLE_PROPERTY
```
static final java.lang.String EDITABLE_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ADDED_MODULES_PROPERTY
```
static final java.lang.String ADDED_MODULES_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - REMOVED_MODULES_PROPERTY
```
static final java.lang.String REMOVED_MODULES_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DIRTY_PROPERTY
```
static final java.lang.String DIRTY_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - REMOVE_PROPERTY
```
static final java.lang.String REMOVE_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROJECT_DESCRIPTOR_PROPERTY
```
static final java.lang.String PROJECT_DESCRIPTOR_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - LOADED_PROPERTY
```
static final java.lang.String LOADED_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - EXPORTED_DESCRIPTION_PROPERTY
```
static final java.lang.String EXPORTED_DESCRIPTION_PROPERTY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isLoaded
```
boolean isLoaded()
```
    Deprecated.
    
    Returns:
    
    true if module is loaded.
  - getAutoLoadType
```
AutoLoadKind getAutoLoadType()
```
    Deprecated.
    
    Returns module handling mode.
    
    Returns:
    
    module auto load type.
    
    See Also:
    
    AutoLoadKind
  - isLoadIndex
```
boolean isLoadIndex()
```
    Deprecated.
    
    Returns:
    
    true if index is loaded for this module.
  - isManualUnloaded
```
boolean isManualUnloaded()
```
    Deprecated.
    
    Returns:
    
    true if module was manually unloaded.
  - setLoadType
```
void setLoadType(AutoLoadKind type)
```
    Deprecated.
    
    Sets auto load type.
    
    Parameters:
    
    type - new auto load type.
  - setManualyUnloaded
```
void setManualyUnloaded(boolean value)
```
    Deprecated.
    
    Marks or clears this module as manually unloaded.
    
    Parameters:
    
    value - new manually unloaded value.
  - setEditable
```
void setEditable(boolean value)
```
    Deprecated.
    
    Sets new editable flag. If module is editable it can be saved into its own file.
    
    Parameters:
    
    value - new value of editable.
  - getMounts
```
java.util.Collection<MountInfo> getMounts()
```
    Deprecated.
    
    Return all mount points from this module.
    
    Returns:
    
    all mount points from this module.
    
    See Also:
    
    MountInfo
  - getDescription
```
java.lang.String getDescription()
```
    Deprecated.
    
    Returns:
    
    description set when exporting/sharing this module. Does not returns null.
  - setLoadIndex
```
void setLoadIndex(boolean load)
```
    Deprecated.
    
    Sets new value of module load index property
    
    Parameters:
    
    load - new value
  - removeMount
```
void removeMount(MountInfo mount)
```
    Deprecated.
    
    Removes given mount
    
    Parameters:
    
    mount - mount info to remove.
  - addMount
```
MountInfo addMount(Package pack,
                   java.lang.String preferredPath)
```
    Deprecated.
    
    Adds new mount.
    
    Parameters:
    
    pack - package to be mounted
    
    preferredPath - preferred path for package
    
    Returns:
    
    MountInfo
  - setDescription
```
void setDescription(java.lang.String description)
```
    Deprecated.
    
    Sets new description for module.
    
    Parameters:
    
    description - new description
    
    Throws:
    
    ReadOnlyModuleException
  - setLocked
```
void setLocked(boolean b)
```
    Deprecated.
    
    Marks module as locked. This means that module is loaded from old format file and can not be edit in current project.
    
    Parameters:
    
    b -
  - isLocked
```
boolean isLocked()
```
    Deprecated.
    
    Returns:
    
    true if module was loaded from old format file (without mount and share table) such module can not be modified in current project.
  - getVersion
```
long getVersion()
```
    Deprecated.
    
    Specified by:
    
    getVersion in interface IProject
    
    Returns:
    
    remote project version. In case of local module returns file modification; The version is set while loading or using module.
  - setVersion
```
void setVersion(long version)
```
    Deprecated.
    
    Sets version of this module.
    
    Specified by:
    
    setVersion in interface IProject
    
    Parameters:
    
    version -
  - getUsedVersion
```
java.lang.String getUsedVersion()
```
    Deprecated.
    
    Returns:
    
    used module version. In case of local module version differ to prevent to open file and get incorrect model.
  - setUsedVersion
```
void setUsedVersion(java.lang.String version)
```
    Deprecated.
    
    Sets used version of this module.
    
    Parameters:
    
    version -
  - getRequiredVersion
```
int getRequiredVersion()
```
    Deprecated.
    
    Returns:
    
    required version for this module, -1 if latest.
  - setRequiredVersion
```
void setRequiredVersion(int version)
```
    Deprecated.
    
    Parameters:
    
    version - required version (used in teamwork projects)
  - isLatest
```
boolean isLatest()
```
    Deprecated.
    
    Returns:
    
    true if latest module version is used (used in teamwork projects)
  - setLatest
```
void setLatest(boolean latest)
```
    Deprecated.
  - equalsIgnoreVersion
```
boolean equalsIgnoreVersion(ProjectDescriptor module)
```
    Deprecated.
  - updateLocation
```
void updateLocation(java.net.URI uri)
```
    Deprecated.
    
    Sets new location
    
    Parameters:
    
    uri - new location
    
    See Also:
    
    ;
  - addMount
```
void addMount(MountInfo mount)
```
    Deprecated.
    
    Adds new mount to this module.
    
    Parameters:
    
    mount -
  - setStyleManager
```
void setStyleManager(StyleManager managerToRead)
```
    Deprecated.
  - setOptions
```
void setOptions(ProjectOptions options)
```
    Deprecated.
  - setLoaded
```
void setLoaded(boolean loaded)
```
    Deprecated.
    
    Marks this module as loaded or not loaded.
    
    Parameters:
    
    loaded - new value of loaded flag.
  - addPropertyChangeListener
```
void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Deprecated.
  - removePropertyChangeListener
```
void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Deprecated.
  - addPropertyChangeListener
```
void addPropertyChangeListener(java.lang.String property,
                               java.beans.PropertyChangeListener listener)
```
    Deprecated.
  - removePropertyChangeListener
```
void removePropertyChangeListener(java.lang.String property,
                                  java.beans.PropertyChangeListener listener)
```
    Deprecated.

Interface ModuleDescriptor

Field Summary

Method Summary

Methods inherited from interface com.nomagic.magicdraw.core.project.ProjectDescriptor

Methods inherited from interface com.nomagic.magicdraw.core.modules.IProject

Methods inherited from interface com.nomagic.magicdraw.core.modules.ModulesManager

Methods inherited from interface com.nomagic.magicdraw.core.modules.Commitable

Field Detail

AUTO_LOAD_KIND_PROPERTY

MANUALY_UNLOADED_PROPERTY

LOAD_INDEX_PROPERTY

DESCRIPTION_PROPERTY

SHARE_TABLE_PROPERTY

MOUNT_TABLE_PROPERTY

LOCKED_PROPERTY

VERSION_PROPERTY

USED_VERSION_PROPERTY

REQUIRED_VERSION_PROPERTY

LATEST_PROPERTY

STYLE_MANAGER_PROPERTY

OPTIONS_PROPERTY

EDITABLE_PROPERTY

ADDED_MODULES_PROPERTY

REMOVED_MODULES_PROPERTY

DIRTY_PROPERTY

REMOVE_PROPERTY

PROJECT_DESCRIPTOR_PROPERTY

LOADED_PROPERTY

EXPORTED_DESCRIPTION_PROPERTY

Method Detail

isLoaded

getAutoLoadType

isLoadIndex

isManualUnloaded

setLoadType

setManualyUnloaded

setEditable

getMounts

getDescription

setLoadIndex

removeMount

addMount

setDescription

setLocked

isLocked

getVersion

setVersion

getUsedVersion

setUsedVersion

getRequiredVersion

setRequiredVersion

isLatest

setLatest

equalsIgnoreVersion

updateLocation

addMount

setStyleManager

setOptions

setLoaded

addPropertyChangeListener

removePropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener