ProjectModule

java.lang.Object
- com.nomagic.magicdraw.magicreport.tools.ProjectModule

@OpenApiAll
public class ProjectModule
extends java.lang.Object

Wrapper Class of IAttachedProject.

Since:: Feb 11, 2019

Constructor Summary

Constructors
Constructor and Description

ProjectModule(IAttachedProject attachedProject)

Constructors
Constructor and Description
`ProjectModule(IAttachedProject attachedProject)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equalsIgnoreVersion(ProjectDescriptor module)`
`IAttachedProject`	`getAttachedProject()` Get real attached project.
`AbstractProjectAttachmentConfiguration`	`getAttachmentConfiguration()` Get attachmentConfiguration of attached project
`AutoLoadKind`	`getAutoLoadType()` Return load kind of attached project
`Project`	`getBelongsTo()` Returns MagicDraw project for attached project.
`java.lang.String`	`getDescription()` Get attached project description.
`XmiExporterDescription`	`getExporterDescription()` Provide information about project version and required resources/plugins for attached project.
`java.lang.String`	`getLatestVersion()` Get latest version of attached project.
`java.util.Collection<com.nomagic.ci.persistence.mounting.IMountPoint>`	`getMounts()` Gets mount points for attached project, i.e.
`java.lang.String`	`getName()` Get attached project name
`ProjectOptions`	`getOptions()` Get attached project options.
`ProjectVersion`	`getProjectVersion()` Return project version of attached project.
`java.lang.String`	`getRemoteID()` Return remote id for an attached project
`java.lang.String`	`getRepresentationString()` Return user friendly representation string about attached project
`java.lang.String`	`getRequiredVersion()` Get required version of attached project.
`StyleManager`	`getStyleManager()` Style manager of an attached project
`java.util.List<java.lang.String>`	`getTags()` Return a list of version tags.
`java.net.URI`	`getURI()` Convert EMF uri to java.net.URI
`java.lang.String`	`getUsedVersion()` Get used version of attached project.
`long`	`getVersion()` Get project version number.
`java.util.List<ProjectVersion>`	`getVersionList()` Return list of project version of attached project.
`java.util.List<ProjectVersion>`	`getVersions()` Return list of project version of attached project.
`java.util.List<ProjectVersion>`	`getVersions(java.lang.String sortType)` Return list of project version of attached project. The result will be sorted by specified sortType.
`boolean`	`isDirty()`
`boolean`	`isEditable()` Gets attachment mode
`boolean`	`isLatest()` Return true if the attached project is latest version.
`boolean`	`isLoaded()` Check if attached project is loaded.
`boolean`	`isLoadIndex()` Check if to load index.
`boolean`	`isLocked()` Check if attached project is loaded from old format file and can not be edited in current project.
`boolean`	`isManualUnloaded()` Load mode of the attached project, loaded manually if true.
`boolean`	`isRemote()` Check if an attached project is remote - from teamwork server or TW Cloud.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProjectModule
```
public ProjectModule(IAttachedProject attachedProject)
```
- Method Detail
  - getAttachedProject
```
public IAttachedProject getAttachedProject()
```
    Get real attached project.
    
    Returns:
    
    an IAttachedProject.
  - getAttachmentConfiguration
```
public AbstractProjectAttachmentConfiguration getAttachmentConfiguration()
```
    Get attachmentConfiguration of attached project
    
    Returns:
    
    an AbstractProjectAttachmentConfiguration
  - getName
```
public java.lang.String getName()
```
    Get attached project name
    
    Returns:
    
    attached project name
  - isLoaded
```
public boolean isLoaded()
```
    Check if attached project is loaded.
    
    Returns:
    
    true if attached project is loaded.
  - getAutoLoadType
```
public AutoLoadKind getAutoLoadType()
```
    Return load kind of attached project
    
    Parameters:
    
    attachment - attachment
    
    Returns:
    
    load kind
  - isLoadIndex
```
public boolean isLoadIndex()
```
    Check if to load index.
    
    Parameters:
    
    configuration - attachment configuration.
    
    Returns:
    
    true if option is set to load index.
  - isManualUnloaded
```
public boolean isManualUnloaded()
```
    Load mode of the attached project, loaded manually if true.
    
    Returns:
    
    true if load manually
  - getMounts
```
public java.util.Collection<com.nomagic.ci.persistence.mounting.IMountPoint> getMounts()
```
    Gets mount points for attached project, i.e. returns all mount points that are mounted share points of attached project. Returns empty set if there are no mount points to return.
    
    Returns:
    
    non-null set of mount points for specific project
  - getDescription
```
public java.lang.String getDescription()
```
    Get attached project description.
    
    Returns:
    
    attached project description
  - isLocked
```
public boolean isLocked()
```
    Check if attached project is loaded from old format file and can not be edited in current project.
    
    Returns:
    
    true if attached project is loaded from old format file and can not be edited in current project
  - getUsedVersion
```
public java.lang.String getUsedVersion()
```
    Get used version of attached project.
    
    Returns:
    
    used version
  - getLatestVersion
```
public java.lang.String getLatestVersion()
```
    Get latest version of attached project.
    
    Returns:
    
    latest version
  - getVersion
```
public long getVersion()
```
    Get project version number.
    
    Returns:
    
    version number as long
  - getRequiredVersion
```
public java.lang.String getRequiredVersion()
```
    Get required version of attached project.
    
    Returns:
    
    required version
  - isLatest
```
public boolean isLatest()
```
    Return true if the attached project is latest version.
    
    Returns:
    
    true if the attached project is latest version
  - equalsIgnoreVersion
```
public boolean equalsIgnoreVersion(ProjectDescriptor module)
```
  - getTags
```
public java.util.List<java.lang.String> getTags()
```
    Return a list of version tags.
    
    Returns:
    
    tags of the version if any
  - isEditable
```
public boolean isEditable()
```
    Gets attachment mode
    
    Returns:
    
    attachment mode
  - getBelongsTo
```
public Project getBelongsTo()
```
    Returns MagicDraw project for attached project.
    
    Returns:
    
    Project
  - getRemoteID
```
public java.lang.String getRemoteID()
```
    Return remote id for an attached project
    
    Returns:
    
    remote id
  - getURI
```
public java.net.URI getURI()
```
    Convert EMF uri to java.net.URI
    
    Returns:
    
    java net uri
  - isRemote
```
public boolean isRemote()
```
    Check if an attached project is remote - from teamwork server or TW Cloud.
    
    Returns:
    
    true if an attached project is from server
  - getStyleManager
```
public StyleManager getStyleManager()
```
    Style manager of an attached project
    
    Returns:
    
    style manager in an attached project options
  - getOptions
```
public ProjectOptions getOptions()
```
    Get attached project options.
    
    Returns:
    
    attached project options.
  - isDirty
```
public boolean isDirty()
```
  - getRepresentationString
```
public java.lang.String getRepresentationString()
```
    Return user friendly representation string about attached project
    
    Returns:
    
    user friendly representation
  - getExporterDescription
```
public XmiExporterDescription getExporterDescription()
```
    Provide information about project version and required resources/plugins for attached project.
    
    Returns:
    
    description of attached project
  - getProjectVersion
```
public ProjectVersion getProjectVersion()
```
    Return project version of attached project.
    
    Returns:
    
    a ProjectVersion of attached project
  - getVersionList
```
public java.util.List<ProjectVersion> getVersionList()
```
    Return list of project version of attached project.
    
    Returns:
    
    a list of ProjectVersion of attached project
  - getVersions
```
public java.util.List<ProjectVersion> getVersions()
```
    Return list of project version of attached project.
    The result will be sorted in descending order.
    
    Returns:
    
    a list of ProjectVersion of attached project
  - getVersions
```
public java.util.List<ProjectVersion> getVersions(java.lang.String sortType)
```
    Return list of project version of attached project.
    The result will be sorted by specified sortType.
    
    Parameters:
    
    sortType - type of sorting. Specify "desc" sort in descending order. Default is ascending sort.
    
    Returns:
    
    a list of ProjectVersion of attached project

Class ProjectModule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectModule

Method Detail

getAttachedProject

getAttachmentConfiguration

getName

isLoaded

getAutoLoadType

isLoadIndex

isManualUnloaded

getMounts

getDescription

isLocked

getUsedVersion

getLatestVersion

getVersion

getRequiredVersion

isLatest

equalsIgnoreVersion

getTags

isEditable

getBelongsTo

getRemoteID

getURI

isRemote

getStyleManager

getOptions

isDirty

getRepresentationString

getExporterDescription

getProjectVersion

getVersionList

getVersions

getVersions