A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule
$project.getServerModule()
This function returns the list of used server modules.
Name
Type
Description
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule
$project.getServerModule(includeAuxiliary)
This function returns the list of used server modules as well as auxiliary resources.
Name
Type
Description
Parameter(s)
includeAuxiliary
boolean
Returns server modules including auxiliary resources when this value is True. Default is false.
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule
$project.getLocalModule()
This function returns the list of used local modules.
Name
Type
Description
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule
$project.getLocalModule(includeAuxiliary)
This function returns the list of used local modules as well as auxiliary resources.
Name
Type
Description
Parameter(s)
includeAuxiliary
boolean
Returns local modules including auxiliary resources when this value is True. Default is false.
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule
$project.getAuxiliaryResource()
This function returns a list of auxiliary resources.
Name
Type
Description
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule
ProjectVersion
Full class name is com.nomagic.magicdraw.magicreport.tools.ProjectVersion ProjectVersion is a class that represents some version of the project or module. It contains date, user, and number, etc. ProjectVersion contains following properties:
Property
Return Type
Description
comment
java.lang.String
Return a version committed comment
date
java.util.Date
Return a committed date
dateAsString
java.lang.String
Return a committed date as text
number
long
Return a committed version
numberAsString
java.lang.String
Return a committed version as text
user
java.lang.String
Return a committer’s name
version
java.lang.Object
Return a version object that can be com.nomagic.teamwork.common.projects.Version for Teamwork project or com.nomagic.magicdraw.esi.project.project.IEsiVersionDescriptor for Teamwork Cloud project.
tags
java.util.List<java.lang.String>
Return all tags
Sample code
Code Block
language
text
title
Sample code
Current version : $project.version
All version:
#foreach ($version in $project.getVersionList())
Date : $version.date
Number : $version.number
Number As String : $version.numberAsString
User : $version.user
Comment : $version.comment
Tags: #foreach($tag in $version.tags)
- tag
#end
---
#end
ProjectModule
Full class name is com.nomagic.magicdraw.magicreport.tools.ProjectModule ProjectModule is a wrapper Class of an attached project (com.nomagic.ci.persistence.IAttachedProject) that represents a special kind of project that is used as a component in current project. Example properties and methods of ProjectModule:
Property / Method
Return Type
Description
representationString
java.lang.String
Return user friendly representation string about the module
description
java.lang.String
Return project description of the module.
version
long
Return version number of the module.
requiredVersion
java.lang.String
Return required version of the module. This property works for Teamwork Server project. It will return -1 when module is latest version and required version is not set.