com.nomagic.magicdraw.visualization.projectsmap

Class ProjectMapHelper

java.lang.Object

com.nomagic.magicdraw.visualization.projectsmap.ProjectMapHelper

@OpenApiAll
public class ProjectMapHelper
extends java.lang.Object

Open Api methods for project usage map.

Constructor Summary

Constructors

Constructor and Description
ProjectMapHelper()

Method Summary

Modifier and Type	Method and Description
static void	exportProjectMapToModel(java.lang.String sourceProjectName, java.lang.String sourceProjectVersion, ProgressStatus progressStatus) Exports project map to model by given source project name and version number.
static void	exportProjectMapToModel(java.lang.String sourceProjectName, java.lang.String sourceProjectVersion, java.lang.String modelProjectID, ProgressStatus progressStatus) Exports project map to model by given source project name and version number.
static void	exportRepositoryMapToModel(ProgressStatus progressStatus) Exports repository map to model.
static void	exportRepositoryMapToModel(java.lang.String modelProjectID, ProgressStatus progressStatus) Exports repository map to model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProjectMapHelper

public ProjectMapHelper()

Method Detail

exportRepositoryMapToModel

public static void exportRepositoryMapToModel(@CheckForNull
                                              ProgressStatus progressStatus)
                                       throws java.rmi.RemoteException,
                                              com.nomagic.ci.persistence.PersistenceException

Exports repository map to model. Sets repository id to exported model. NOTE: Repository id is generated by teamwork server randomly for repository. If repository is migrated to other teamwork server repository id will be changed.

Parameters:

progressStatus - instance of ProgressStatus may be null.

Throws:

java.rmi.RemoteException

com.nomagic.ci.persistence.PersistenceException

java.lang.IllegalArgumentException - if project with given name was not found in server.

exportRepositoryMapToModel

public static void exportRepositoryMapToModel(@Nonnull
                                              java.lang.String modelProjectID,
                                              @CheckForNull
                                              ProgressStatus progressStatus)
                                       throws java.rmi.RemoteException,
                                              com.nomagic.ci.persistence.PersistenceException

Exports repository map to model. Sets model project id to exported model.

Parameters:

modelProjectID - id which will be given to exported model.

progressStatus - instance of ProgressStatus may be null.

Throws:

java.rmi.RemoteException

com.nomagic.ci.persistence.PersistenceException

exportProjectMapToModel

public static void exportProjectMapToModel(@Nonnull
                                           java.lang.String sourceProjectName,
                                           @CheckForNull
                                           java.lang.String sourceProjectVersion,
                                           @CheckForNull
                                           ProgressStatus progressStatus)
                                    throws java.rmi.RemoteException,
                                           com.nomagic.ci.persistence.PersistenceException,
                                           com.nomagic.magicdraw.visualization.projectsmap.model.ProjectAccessDeniedException

Exports project map to model by given source project name and version number. Sets repository id to exported model. NOTE: Repository id is generated by teamwork server randomly for repository. If repository is migrated to other teamwork server repository id will be changed.

Parameters:

sourceProjectName - name of project which is in server.

sourceProjectVersion - project version number or null if we want to export the latest version of project.

progressStatus - instance of ProgressStatus may be null.

Throws:

java.rmi.RemoteException

com.nomagic.ci.persistence.PersistenceException

java.lang.SecurityException - if user do not have permission to read model.

java.lang.IllegalArgumentException - if project with given name was not found in server.

com.nomagic.magicdraw.visualization.projectsmap.model.ProjectAccessDeniedException

exportProjectMapToModel

public static void exportProjectMapToModel(@Nonnull
                                           java.lang.String sourceProjectName,
                                           @CheckForNull
                                           java.lang.String sourceProjectVersion,
                                           @Nonnull
                                           java.lang.String modelProjectID,
                                           @CheckForNull
                                           ProgressStatus progressStatus)
                                    throws java.rmi.RemoteException,
                                           com.nomagic.ci.persistence.PersistenceException,
                                           com.nomagic.magicdraw.visualization.projectsmap.model.ProjectAccessDeniedException

Exports project map to model by given source project name and version number. Sets model project id to exported model.

Parameters:

sourceProjectName - name of project which is in server.

sourceProjectVersion - project version number or null if we want to export the latest version of project.

modelProjectID - id which will be given to exported model.

progressStatus - instance of ProgressStatus may be null.

Throws:

java.rmi.RemoteException

com.nomagic.ci.persistence.PersistenceException

java.lang.SecurityException - if user do not have permission to read model.

com.nomagic.magicdraw.visualization.projectsmap.model.ProjectAccessDeniedException