com.nomagic.magicdraw.core.options

Class TeamworkOptionsGroup

java.lang.Object

com.nomagic.magicdraw.core.options.OptionsGroup

com.nomagic.magicdraw.core.options.AbstractPropertyOptionsGroup

com.nomagic.magicdraw.core.options.VersionedOptionsGroup

com.nomagic.magicdraw.core.options.TeamworkOptionsGroup

All Implemented Interfaces:

java.lang.Cloneable

@OpenApiAll
public class TeamworkOptionsGroup
extends com.nomagic.magicdraw.core.options.VersionedOptionsGroup

Teamwork options.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_NEW_PROJECT_VERSION_CHECK Default value for New Project Version Notification
static java.lang.String	DEFAULT_NEW_PROJECT_VERSION_CHECK_INTERVAL_IN_SECONDS
static int	DEFAULT_PROJECT_USAGES_UPDATE_SHOW_NOTIFICATION_INDEX Default setting when to show notification about available project usages updates to latest version
static java.lang.String	ID
static java.lang.String	INCLUDE_VERSION_INTO_ELEMENT_URL_ASK
static java.lang.String	INCLUDE_VERSION_INTO_ELEMENT_URL_DO_NOT_INCLUDE
static java.lang.String	INCLUDE_VERSION_INTO_ELEMENT_URL_INCLUDE
static java.util.List	PROJECT_USAGES_UPDATE_SHOW_NOTIFICATION_OPTION_CHOICES List of options when to show notification about available project usages updates to latest version
static java.lang.String	PROJECTS_TREE_TABLE_MODE_FLAT Mode of teamwork projects tree table when only projects are displayed in flat list.
static java.lang.String	PROJECTS_TREE_TABLE_MODE_ORIGINAL Mode of teamwork projects tree table when categories and projects are displayed in tree form, no presentation modifications are made to original structure

Fields inherited from class com.nomagic.magicdraw.core.options.VersionedOptionsGroup

CURRENT_EXPORTER_VERSION

Constructor Summary

Constructors

Constructor and Description
TeamworkOptionsGroup()

Method Summary

Modifier and Type	Method and Description
protected void	afterLoad(com.nomagic.magicdraw.lic.MDVersion version, boolean pluginsLoaded)
void	clearMUUserPassword() Clears user password to MU server
java.lang.String	getAuthServerName() gets Last used authentication server name
java.util.List<java.lang.String>	getAuthServerNames() Returns the list of authentication server names, which where entered by user, and successfully connected.
com.nomagic.ui.banners.Banner	getBanner()
boolean	getCreateMountRelationshipsOnImportToCEDW() Gets value of this property.
java.util.List<java.lang.String>	getDefaultServerNames()
java.lang.String	getIncludeVersionIntoURLMode()
java.lang.String	getLastCameoResourceId() Returns last cameo resource ID.
java.util.Collection<java.lang.String>	getLastExpandedCategories() Gets collection of identifiers of categories that were recently expanded.
java.util.Collection<java.lang.String>	getLastExpandedProjectUsagesCategories() Gets collection of identifiers of project usages categories that were recently expanded.
java.lang.String	getLastSelectedEsiOfflineServerID() Gets last selected esi offline server.
java.lang.String	getLastUsedEsiBranches()
java.lang.String	getLoginToken() gets login token to server
java.lang.String	getMUServerName() gets Last used server name
java.lang.String	getMUUserLogin() gets user login to MU server
java.lang.String	getMUUserPassword() gets user password to MU server
int	getNewProjectVersionCheckInterval() Returns currently selected interval between version checks.
java.lang.String	getProjectsTreeTableMode() Gets the teamwork projects tree table display mode.
int	getProjectUsagesUpdateNotification() Gets when to show notification about available project usages updates to latest version.
java.util.List<java.lang.String>	getServerNames() Returns the list of server names, which where entered by user, and successfully connected.
java.lang.String	getWebAppServerUrl() Gets WebApp URL.
boolean	isAutoCommitOnProjectMigration() Determines whether projects should be auto-commit after project migration to a new version.
boolean	isAutoLoginToMU() is login to MU server auto
boolean	isEmptyTeamworkProjectsCategoriesVisible() Indicates if teamwork projects tree table shall display an empty categories as well.
boolean	isEnableLockingWithoutForceUpdate() Determines whether elements can be locked without update project.
boolean	isKeepLocks()
boolean	isNewProjectVersionCheckEnabled() Method checks whether the New Project Version Notification property is enabled
boolean	isRememberServerBetweenSessions() Is server will be remembered between sessions
boolean	isRememberUserNameBetweenSessions() Is entered user login name will be remembered between sessions.
boolean	isShowModuleVersionsConflictWarning()
boolean	isSSOLoginTabVisible() Determines whether sso login tab should be visible.
boolean	isUseSecureConnection()
void	setAuthServerName(java.lang.String name) sets server name as a last used server name.
void	setAuthServerNames(java.util.List<java.lang.String> serverNames) Setter for Single Sign On server list (server names)
void	setAutoCommitOnProjectMigration(boolean autoCommit) Sets new value for the autoCommitOnProjectMigration property
void	setAutoLoginToMU(boolean log) sets auto login to MU server
void	setCreateMountRelationshipsOnImportToCEDW(boolean enable) Sets new value for this property.
void	setDefaultValues() Sets default values for the properties contained in this group.
void	setEmptyTeamworkProjectsCategoriesVisible(boolean visible) Sets if teamwork projects tree table shall display an empty categories as well
void	setEnableLockingWithoutForceUpdate(boolean enable) Sets new value for the isEnableLockingWithoutForceUpdate() property
void	setIncludeVersionIntoURLMode(java.lang.String value)
void	setKeepLocks(boolean keepLocks)
void	setLastCameoResourceId(java.lang.String id) Sets last used cameo resource(project) ID.
void	setLastExpandedCategories(java.util.Collection<java.lang.String> categoryIds) Sets collection of identifiers of categories that were recently expanded.
void	setLastExpandedProjectUsagesCategories(java.util.Collection<java.lang.String> categoryIds) Sets collection of identifiers of project usages categories that were recently expanded.
void	setLastSelectedEsiOfflineServerID(java.lang.String serverId) Sets server identifiers that was last selected as offline server.
void	setLastUsedEsiBranches(java.lang.String info)
void	setLoginToken(java.lang.String token) sets login token to server
void	setMUServerName(java.lang.String name) sets server name as a last used server name.
void	setMUUserLogin(java.lang.String name) sets user login to MU server
void	setMUUserPassword(java.lang.String name) sets user password to MU server
void	setMUUserPasswordAndEncrypt(java.lang.String psw) set encrypted password
void	setNewProjectVersionCheckInterval(java.lang.String initialValue) Sets the initial interval between version checks for.
void	setNewProjectVersionNotification(boolean value) Sets whether the New Project Version Notification should be set to enabled or not.
void	setProjectsTreeTableMode(java.lang.String value) Sets the teamwork projects tree table display mode.
void	setProjectUsagesUpdateNotification(int choice) Sets when to show notification about available project usages updates to latest version.
void	setRememberServerBetweenSessions(boolean remember) Sets that server will be remembered during sessions.
void	setRememberUserNameBetweenSessions(boolean remember) Sets that login will be remembered during sessions.
void	setServerNames(java.util.List<java.lang.String> serverNames) Setter for team server list (server names)
void	setShowModuleVersionsConflictWarning(boolean show)
void	setSSOLoginTabVisible(boolean visible) Sets new value for the SSOLoginTabVisible property
void	setUseSecureConnection(boolean use)
void	setWebAppServerUrl(java.lang.String url) Sets WebApp URL.

Methods inherited from class com.nomagic.magicdraw.core.options.VersionedOptionsGroup

beforeLoad, getExporterVersion, getOptionsToSave, isExporterVersionEarlier, isExporterVersionEarlier, loadOptions

Methods inherited from class com.nomagic.magicdraw.core.options.AbstractPropertyOptionsGroup

addInvisibleProperty, addProperty, addProperty, addProperty, getOptions, getProperty, getVisibleOptions, removeProperty, setOptions, setPropertiesInvisible, setPropertyInvisible

Methods inherited from class com.nomagic.magicdraw.core.options.OptionsGroup

getGroupIcon, getIcon, getName

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

DEFAULT_NEW_PROJECT_VERSION_CHECK

public static final boolean DEFAULT_NEW_PROJECT_VERSION_CHECK

Default value for New Project Version Notification

See Also:

Constant Field Values

DEFAULT_NEW_PROJECT_VERSION_CHECK_INTERVAL_IN_SECONDS

public static final java.lang.String DEFAULT_NEW_PROJECT_VERSION_CHECK_INTERVAL_IN_SECONDS

See Also:

Constant Field Values

DEFAULT_PROJECT_USAGES_UPDATE_SHOW_NOTIFICATION_INDEX

public static final int DEFAULT_PROJECT_USAGES_UPDATE_SHOW_NOTIFICATION_INDEX

Default setting when to show notification about available project usages updates to latest version

See Also:

Constant Field Values

INCLUDE_VERSION_INTO_ELEMENT_URL_ASK

public static final java.lang.String INCLUDE_VERSION_INTO_ELEMENT_URL_ASK

See Also:

Constant Field Values

INCLUDE_VERSION_INTO_ELEMENT_URL_INCLUDE

public static final java.lang.String INCLUDE_VERSION_INTO_ELEMENT_URL_INCLUDE

See Also:

Constant Field Values

INCLUDE_VERSION_INTO_ELEMENT_URL_DO_NOT_INCLUDE

public static final java.lang.String INCLUDE_VERSION_INTO_ELEMENT_URL_DO_NOT_INCLUDE

See Also:

Constant Field Values

PROJECT_USAGES_UPDATE_SHOW_NOTIFICATION_OPTION_CHOICES

public static final java.util.List PROJECT_USAGES_UPDATE_SHOW_NOTIFICATION_OPTION_CHOICES

List of options when to show notification about available project usages updates to latest version

PROJECTS_TREE_TABLE_MODE_ORIGINAL

public static final java.lang.String PROJECTS_TREE_TABLE_MODE_ORIGINAL

Mode of teamwork projects tree table when categories and projects are displayed in tree form, no presentation modifications are made to original structure

See Also:

Constant Field Values

PROJECTS_TREE_TABLE_MODE_FLAT

public static final java.lang.String PROJECTS_TREE_TABLE_MODE_FLAT

Mode of teamwork projects tree table when only projects are displayed in flat list.

See Also:

Constant Field Values

Constructor Detail

TeamworkOptionsGroup

public TeamworkOptionsGroup()

Method Detail

setDefaultValues

public void setDefaultValues()

Description copied from class: AbstractPropertyOptionsGroup

Sets default values for the properties contained in this group. Overriding classes should set default values to the properties.

Overrides:

setDefaultValues in class com.nomagic.magicdraw.core.options.VersionedOptionsGroup

afterLoad

protected void afterLoad(com.nomagic.magicdraw.lic.MDVersion version,
                         boolean pluginsLoaded)

Overrides:

afterLoad in class com.nomagic.magicdraw.core.options.VersionedOptionsGroup

setAutoLoginToMU

public void setAutoLoginToMU(boolean log)

sets auto login to MU server

isAutoLoginToMU

public boolean isAutoLoginToMU()

is login to MU server auto

setMUServerName

public void setMUServerName(java.lang.String name)

sets server name as a last used server name.

setAuthServerName

public void setAuthServerName(java.lang.String name)

sets server name as a last used server name.

Parameters:

name - server name

getMUServerName

public java.lang.String getMUServerName()

gets Last used server name

getAuthServerName

public java.lang.String getAuthServerName()

gets Last used authentication server name

setMUUserLogin

public void setMUUserLogin(java.lang.String name)

sets user login to MU server

getMUUserLogin

public java.lang.String getMUUserLogin()

gets user login to MU server

setLoginToken

public void setLoginToken(java.lang.String token)

sets login token to server

Parameters:

token - authentication token

getLoginToken

public java.lang.String getLoginToken()

gets login token to server

getMUUserPassword

public java.lang.String getMUUserPassword()

gets user password to MU server

Returns:

secret password

setMUUserPasswordAndEncrypt

public void setMUUserPasswordAndEncrypt(java.lang.String psw)

set encrypted password

setMUUserPassword

public void setMUUserPassword(java.lang.String name)

sets user password to MU server

clearMUUserPassword

public void clearMUUserPassword()

Clears user password to MU server

setShowModuleVersionsConflictWarning

public void setShowModuleVersionsConflictWarning(boolean show)

isShowModuleVersionsConflictWarning

public boolean isShowModuleVersionsConflictWarning()

setLastUsedEsiBranches

public void setLastUsedEsiBranches(java.lang.String info)

getLastUsedEsiBranches

public java.lang.String getLastUsedEsiBranches()

getServerNames

public java.util.List<java.lang.String> getServerNames()

Returns the list of server names, which where entered by user, and successfully connected.

getAuthServerNames

public java.util.List<java.lang.String> getAuthServerNames()

Returns the list of authentication server names, which where entered by user, and successfully connected.

Returns:

list of servers used earlier

setAuthServerNames

public void setAuthServerNames(java.util.List<java.lang.String> serverNames)

Setter for Single Sign On server list (server names)

getDefaultServerNames

public java.util.List<java.lang.String> getDefaultServerNames()

setServerNames

public void setServerNames(java.util.List<java.lang.String> serverNames)

Setter for team server list (server names)

getIncludeVersionIntoURLMode

public java.lang.String getIncludeVersionIntoURLMode()

setIncludeVersionIntoURLMode

public void setIncludeVersionIntoURLMode(java.lang.String value)

getLastExpandedCategories

public java.util.Collection<java.lang.String> getLastExpandedCategories()

Gets collection of identifiers of categories that were recently expanded.

Returns:

collection of category id.

setLastExpandedCategories

public void setLastExpandedCategories(java.util.Collection<java.lang.String> categoryIds)

Sets collection of identifiers of categories that were recently expanded.

getLastExpandedProjectUsagesCategories

public java.util.Collection<java.lang.String> getLastExpandedProjectUsagesCategories()

Gets collection of identifiers of project usages categories that were recently expanded.

Returns:

collection of category id.

setLastExpandedProjectUsagesCategories

public void setLastExpandedProjectUsagesCategories(java.util.Collection<java.lang.String> categoryIds)

Sets collection of identifiers of project usages categories that were recently expanded.

getLastSelectedEsiOfflineServerID

@CheckForNull
public java.lang.String getLastSelectedEsiOfflineServerID()

Gets last selected esi offline server.

Returns:

server id

setLastSelectedEsiOfflineServerID

public void setLastSelectedEsiOfflineServerID(java.lang.String serverId)

Sets server identifiers that was last selected as offline server.

Parameters:

serverId - server ID (esi server cluster ID)

getProjectsTreeTableMode

public java.lang.String getProjectsTreeTableMode()

Gets the teamwork projects tree table display mode.

Returns:

mode

See Also:

PROJECTS_TREE_TABLE_MODE_ORIGINAL, PROJECTS_TREE_TABLE_MODE_FLAT

setProjectsTreeTableMode

public void setProjectsTreeTableMode(java.lang.String value)

Sets the teamwork projects tree table display mode.

See Also:

PROJECTS_TREE_TABLE_MODE_ORIGINAL, PROJECTS_TREE_TABLE_MODE_FLAT

isEmptyTeamworkProjectsCategoriesVisible

public boolean isEmptyTeamworkProjectsCategoriesVisible()

Indicates if teamwork projects tree table shall display an empty categories as well.

Returns:

true to show empty, otherwise false

setEmptyTeamworkProjectsCategoriesVisible

public void setEmptyTeamworkProjectsCategoriesVisible(boolean visible)

Sets if teamwork projects tree table shall display an empty categories as well

setUseSecureConnection

public void setUseSecureConnection(boolean use)

isUseSecureConnection

public boolean isUseSecureConnection()

getBanner

public com.nomagic.ui.banners.Banner getBanner()

Overrides:

getBanner in class OptionsGroup

setRememberServerBetweenSessions

public void setRememberServerBetweenSessions(boolean remember)

Sets that server will be remembered during sessions.

Parameters:

remember - - true to remember, false not to remember.

isRememberServerBetweenSessions

public boolean isRememberServerBetweenSessions()

Is server will be remembered between sessions

setRememberUserNameBetweenSessions

public void setRememberUserNameBetweenSessions(boolean remember)

Sets that login will be remembered during sessions.

Parameters:

remember - - true to remember, false not to remember.

isRememberUserNameBetweenSessions

public boolean isRememberUserNameBetweenSessions()

Is entered user login name will be remembered between sessions.

setLastCameoResourceId

public void setLastCameoResourceId(java.lang.String id)

Sets last used cameo resource(project) ID.

Parameters:

id - unique id of resource.

getLastCameoResourceId

@CheckForNull
public java.lang.String getLastCameoResourceId()

Returns last cameo resource ID.

setKeepLocks

public void setKeepLocks(boolean keepLocks)

isKeepLocks

public boolean isKeepLocks()

setAutoCommitOnProjectMigration

public void setAutoCommitOnProjectMigration(boolean autoCommit)

Sets new value for the autoCommitOnProjectMigration property

Parameters:

autoCommit - the value to set

isAutoCommitOnProjectMigration

public boolean isAutoCommitOnProjectMigration()

Determines whether projects should be auto-commit after project migration to a new version. It is a general setting, however it is up to every different migration to decide whether it should conform to it

Returns:

true if project should be auto-committed after migration, false if not

setSSOLoginTabVisible

public void setSSOLoginTabVisible(boolean visible)

Sets new value for the SSOLoginTabVisible property

Parameters:

visible - the value to set

isSSOLoginTabVisible

public boolean isSSOLoginTabVisible()

Determines whether sso login tab should be visible.

Returns:

true if login tab should be visible, false if not

setNewProjectVersionCheckInterval

public void setNewProjectVersionCheckInterval(java.lang.String initialValue)

Sets the initial interval between version checks for.

Parameters:

initialValue - value to select in the choice box

getNewProjectVersionCheckInterval

public int getNewProjectVersionCheckInterval()

Returns currently selected interval between version checks.

Returns:

interval between version checks in seconds

setNewProjectVersionNotification

public void setNewProjectVersionNotification(boolean value)

Sets whether the New Project Version Notification should be set to enabled or not.

Parameters:

value - identifies the state of the property(true means enabled)

isNewProjectVersionCheckEnabled

public boolean isNewProjectVersionCheckEnabled()

Method checks whether the New Project Version Notification property is enabled

Returns:

true if the property is enabled

setProjectUsagesUpdateNotification

public void setProjectUsagesUpdateNotification(int choice)

Sets when to show notification about available project usages updates to latest version. Default option is 0 (on open).

Parameters:

choice - when to show notification about available project usages updates to latest version (open = 0, open, update and save = 1, never = 2).

getProjectUsagesUpdateNotification

public int getProjectUsagesUpdateNotification()

Gets when to show notification about available project usages updates to latest version. Default option is 0 (on open).

Returns:

when to show notification about available project usages updates to latest version (open = 0, open, update and save = 1, never = 2).

setEnableLockingWithoutForceUpdate

public void setEnableLockingWithoutForceUpdate(boolean enable)

Sets new value for the isEnableLockingWithoutForceUpdate() property

Parameters:

enable - enable lock without update

isEnableLockingWithoutForceUpdate

public boolean isEnableLockingWithoutForceUpdate()

Determines whether elements can be locked without update project. Locking without update can be done only if there is no changes done with elements in upcoming server versions.

Returns:

false if project if forced to update

setCreateMountRelationshipsOnImportToCEDW

public void setCreateMountRelationshipsOnImportToCEDW(boolean enable)

Sets new value for this property.

Parameters:

enable - new value

getCreateMountRelationshipsOnImportToCEDW

public boolean getCreateMountRelationshipsOnImportToCEDW()

Gets value of this property.

Returns:

true if property value is true, or if property does not exist at all.

setWebAppServerUrl

public void setWebAppServerUrl(java.lang.String url)

Sets WebApp URL.

Parameters:

url - new URL

getWebAppServerUrl

@CheckForNull
public java.lang.String getWebAppServerUrl()

Gets WebApp URL.

Returns:

WebApp URL