A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
$project.getServerModule()
Returns a list of used server modules.
Name
Type
Description
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
$project.getServerModule(includeAuxiliary)
Returns a list of used server modules as well as auxiliary resources.
Name
Type
Description
Parameter(s)
includeAuxiliary
boolean
Returns server modules including auxiliary resources if this value is true (false by default).
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
$project.getLocalModule()
Returns a list of used local modules.
Name
Type
Description
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
$project.getLocalModule(includeAuxiliary)
Returns a list of used local modules as well as auxiliary resources.
Name
Type
Description
Parameter(s)
includeAuxiliary
boolean
Returns local modules including auxiliary resources if this value is true (false by default).
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
$project.getAuxiliaryResource()
Returns a list of auxiliary resources.
Name
Type
Description
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
Project Version
The 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, number, etc.
ProjectVersion contains the following properties:
Property
Return type
Description
comment
java.lang.String
Returns a version committed comment.
date
java.util.Date
Returns a committed date.
dateAsString
java.lang.String
Returns a committed date as text.
number
long
Returns a committed version.
numberAsString
java.lang.String
Returns a committed version as text.
user
java.lang.String
Returns a committer’s name.
version
java.lang.Object
Returns a version object that can be com.nomagic.teamwork.common.projects.Version for a Teamwork project or com.nomagic.magicdraw.esi.project.project.IEsiVersionDescriptor for a Teamwork Cloud project.
tags
java.util.List<java.lang.String>
Returns all tags.
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
Project Module
The 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 the project that is used as a component in the current project.
The following are some properties and methods of ProjectModule:
Property / Method
Return type
Description
representationString
java.lang.String
Returns user-friendly representation string about the module.
description
java.lang.String
Returns project description of the module.
version
long
Returns a version number of the module.
requiredVersion
java.lang.String
Returns a required version of the module. This property works for Teamwork Server projects. It will return -1 when the module is the latest version, and the required version is not set.