com.vp.plugin

Class ApplicationManager

java.lang.Object

com.vp.plugin.ApplicationManager

public abstract class ApplicationManager
extends java.lang.Object

This class provides access for various service in Open API. Different services are provided through its own Manager class and all of them can be retrieved from here.

Constructor Summary

Constructors

Constructor and Description
ApplicationManager()

Method Summary

Methods

Modifier and Type	Method and Description
abstract ActionManager	getActionManager() Deprecated.
abstract java.lang.String	getBuildNo() Deprecated. Replaced by VPProductInfo.getBuildNumber()
abstract CodeSyncManager	getCodeSyncManager() Obtain the CodeSyncManager in current running Visual Paradigm application.
abstract DatabaseManager	getDatabaseManager() Obtain the DatabaseManager in current running Visual Paradigm application.
abstract DiagramManager	getDiagramManager() Obtain the DiagramManager in current running Visual Paradigm application.
abstract DocumentationManager	getDocumentationManager() Obtain the DocumentationManager in current running Visual Paradigm application.
abstract java.io.File	getInstallationDir() Retrieve the installation directory of the Visual Paradigm.
abstract java.lang.String	getLoggedInEmail() Obtain the email who is logged in now.
abstract java.lang.String	getLoggedInUserName() Obtain the user name who is logged in now.
abstract ModelConvertionManager	getModelConvertionManager() Obtain ModelConvertionManager in current running Visual Paradigm application.
abstract VPPluginInfo	getPluginInfo(java.lang.String pluginId) To retrieve the information of specific plugins which being deployed to Visual Paradigm client.
abstract VPPluginInfo[]	getPluginInfos() To retrieve the information for all plugins which being deployed to Visual Paradigm client.
abstract VPProductInfo	getProductInfo() To retrieve the product information of Visual Paradigm software.
abstract ProjectManager	getProjectManager() Obtain ProjectManager in current running Visual Paradigm application.
abstract ReportManager	getReportManager() Deprecated. Replaced by getDocumentationManager()
abstract ResourceManager	getResourceManager() Obtain the ResourceManager in current running Visual Paradigm application.
abstract java.lang.String	getUserLanguage() Obtain the UI language the current Visual Paradigm using.
abstract IUserPathOptions	getUserPathOptions() Obtain the User Path Options from workspace.
abstract ViewManager	getViewManager() Obtain the ViewManager in current running Visual Paradigm application.
abstract java.io.File	getWorkspaceLocation() Obtain the location of the current Visual Paradigm workspace.
static ApplicationManager	instance() Get the ApplicationManager
abstract boolean	isLoggedIn()
abstract void	reloadPluginClasses(java.lang.String pluginId) To reload the specific plugin from the pool.
static void	setInstance(ApplicationManager instance)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationManager

public ApplicationManager()

Method Detail

instance

public static final ApplicationManager instance()

Get the ApplicationManager

Returns:

application manager

setInstance

public static final void setInstance(ApplicationManager instance)

getProductInfo

public abstract VPProductInfo getProductInfo()

To retrieve the product information of Visual Paradigm software.

Returns:

the product information of the running Visual Paradigm software.

getPluginInfos

public abstract VPPluginInfo[] getPluginInfos()

To retrieve the information for all plugins which being deployed to Visual Paradigm client.

Returns:

the information of all plugins which being deployed.

getPluginInfo

public abstract VPPluginInfo getPluginInfo(java.lang.String pluginId)

To retrieve the information of specific plugins which being deployed to Visual Paradigm client.

Parameters:

pluginId - the ID of the plugin for obtain its information.

Returns:

the information of the plugin.

reloadPluginClasses

public abstract void reloadPluginClasses(java.lang.String pluginId)

To reload the specific plugin from the pool. For more details, please refer to http://knowhow.visual-paradigm.com/openapi/reload-your-plugin-without-restart-the-application

Parameters:

pluginId - the ID of the plugin to reload.

getInstallationDir

public abstract java.io.File getInstallationDir()

Retrieve the installation directory of the Visual Paradigm. For installed Visual Paradigm it will return the folder where the it was installed. For InstallFree it will return the Application folder of your unzipped VP InstallFree package. For IDE Integration it will return the "sde" folder inside the working directory of the IDE.

Returns:

the File object of the installation directory.

getWorkspaceLocation

public abstract java.io.File getWorkspaceLocation()

Obtain the location of the current Visual Paradigm workspace.

Returns:

the file object of the workspace folder.

getUserLanguage

public abstract java.lang.String getUserLanguage()

Obtain the UI language the current Visual Paradigm using.

Returns:

the language of UI VP using.

isLoggedIn

public abstract boolean isLoggedIn()

getLoggedInEmail

public abstract java.lang.String getLoggedInEmail()

Obtain the email who is logged in now.

Returns:

the email

getLoggedInUserName

public abstract java.lang.String getLoggedInUserName()

Obtain the user name who is logged in now.

Returns:

the user name

getUserPathOptions

public abstract IUserPathOptions getUserPathOptions()

Obtain the User Path Options from workspace. Details about the use of User Path can be found at https://knowhow.visual-paradigm.com/diagramming/how-to-make-referenced-file-accessible-under-different-environments/

Returns:

the user path options.

getProjectManager

public abstract ProjectManager getProjectManager()

Obtain ProjectManager in current running Visual Paradigm application.

Returns:

the ProjectManager.

getActionManager

public abstract ActionManager getActionManager()

Deprecated.

getModelConvertionManager

public abstract ModelConvertionManager getModelConvertionManager()

Obtain ModelConvertionManager in current running Visual Paradigm application.

Returns:

the ModelConvertionManager.

getReportManager

public abstract ReportManager getReportManager()

Deprecated. Replaced by getDocumentationManager()

getDocumentationManager

public abstract DocumentationManager getDocumentationManager()

Obtain the DocumentationManager in current running Visual Paradigm application.

Returns:

the DocumentationManager.

getDiagramManager

public abstract DiagramManager getDiagramManager()

Obtain the DiagramManager in current running Visual Paradigm application.

Returns:

the DiagramManager.

getViewManager

public abstract ViewManager getViewManager()

Obtain the ViewManager in current running Visual Paradigm application.

Returns:

the ViewManager.

getCodeSyncManager

public abstract CodeSyncManager getCodeSyncManager()

Obtain the CodeSyncManager in current running Visual Paradigm application.

Returns:

the CodeSyncManager.

getResourceManager

public abstract ResourceManager getResourceManager()

Obtain the ResourceManager in current running Visual Paradigm application.

Returns:

the ResourceManager.

getDatabaseManager

public abstract DatabaseManager getDatabaseManager()

Obtain the DatabaseManager in current running Visual Paradigm application.

Returns:

the DatabaseManager.

getBuildNo

public abstract java.lang.String getBuildNo()

Deprecated. Replaced by VPProductInfo.getBuildNumber()