A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
$project.getServerModule()
This function returns the 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)
This function returns the 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
when
if this value is
True. Default is false
true (false by default).
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
$project.getLocalModule()
This function returns the 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)
This function returns the 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
when
if this value is
True. Default is false
true (false by default).
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
$project.getAuxiliaryResource()
This function returns Returns a list of auxiliary resources.
Name
Type
Description
Return
-
java.util.Collection
A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.
ProjectVersionProject Version
Full 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, and number, etc. ProjectVersion contains the following properties:
Property
Return
Type
type
Description
comment
java.lang.String
Return
Returns a version committed comment.
date
java.util.Date
Return
Returns a committed date.
dateAsString
java.lang.String
Return
Returns a committed date as text.
number
long
Return
Returns a committed version.
numberAsString
java.lang.String
Return
Returns a committed version as text.
user
java.lang.String
Return
Returns a committer’s name.
version
java.lang.Object
Return
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>
Return
Returns 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
ProjectModuleProject Module
Full 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. Example The following are some properties and methods of ProjectModule:
Property / Method
Return
Type
type
Description
representationString
java.lang.String
Return
Returns user-friendly representation string about the module.
description
java.lang.String
Return
Returns project description of the module.
version
long
Return
Returns a version number of the module.
requiredVersion
java.lang.String
Return
Returns a required version of the module. This property works for Teamwork Server
project
projects. It will return -1 when the module is the latest version, and the required version is not set.
Returns a list of version descriptors of the module.
isRemote()
boolean
Check
Checks if the module is remote - from Teamwork server or
TW
Teamwork Cloud.
Sample code
Code Block
language
text
title
Sample code
#foreach($module in $project.getModuleList())
Name : $module.representationString
Description : $module.description
Version : $module.version
RemoteID : $module.remoteID
URI : $module.URI
#if($module.isRemote())
#set($version = $module.projectVersion)
Current module version :
date : $version.date
number : $version.number
numberAsString : $version.numberAsString
user : $version.user
comment : $version.comment
tags: #foreach($tag in $version.tags)- $tag#end
AllAll
module versions :#foreach($version in $module.versionList)
date : $version.date
number : $version.number
numberAsString : $version.numberAsString
user : $version.usercomment : $version.comment
tags:#foreach($tag in $version.tags)- $tag#end----------#end#end
Shared module:#foreach ($child in $project.getSharedModule($module))- $child.representationString
#end
#end