Package 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:
Cloneable
@OpenApiAll public class TeamworkOptionsGroup extends com.nomagic.magicdraw.core.options.VersionedOptionsGroup
Teamwork options.

  • Field Details

    • ID

      public static final String ID
      See Also:

    • DEFAULT_NEW_PROJECT_VERSION_CHECK

      public static final boolean DEFAULT_NEW_PROJECT_VERSION_CHECK
      Default value for New Project Version Notification
      See Also:

    • DEFAULT_NEW_PROJECT_VERSION_CHECK_INTERVAL_IN_SECONDS

      public static final String DEFAULT_NEW_PROJECT_VERSION_CHECK_INTERVAL_IN_SECONDS
      See Also:

    • 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:

    • INCLUDE_VERSION_INTO_ELEMENT_URL_ASK

      public static final String INCLUDE_VERSION_INTO_ELEMENT_URL_ASK
      See Also:

    • INCLUDE_VERSION_INTO_ELEMENT_URL_INCLUDE

      public static final String INCLUDE_VERSION_INTO_ELEMENT_URL_INCLUDE
      See Also:

    • INCLUDE_VERSION_INTO_ELEMENT_URL_DO_NOT_INCLUDE

      public static final String INCLUDE_VERSION_INTO_ELEMENT_URL_DO_NOT_INCLUDE
      See Also:

    • PROJECT_USAGES_UPDATE_SHOW_NOTIFICATION_OPTION_CHOICES

      public static final 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 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:

    • PROJECTS_TREE_TABLE_MODE_FLAT

      public static final String PROJECTS_TREE_TABLE_MODE_FLAT
      Mode of teamwork projects tree table when only projects are displayed in flat list.
      See Also:

    • USERS_REPRESENTATION_CHOICES

      public static final List USERS_REPRESENTATION_CHOICES
      List of options how to display users

    • USERS_REPRESENTATION_USER_NAME

      public static final int USERS_REPRESENTATION_USER_NAME
      Display user name option
      See Also:

    • USERS_REPRESENTATION_FULL_NAME

      public static final int USERS_REPRESENTATION_FULL_NAME
      Display full user name option
      See Also:

    • USERS_REPRESENTATION_EMAIL

      public static final int USERS_REPRESENTATION_EMAIL
      Display user email option
      See Also:

  • Constructor Details

    • TeamworkOptionsGroup

      public TeamworkOptionsGroup()

  • Method Details

    • 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

    • isEnable3DExperience

      public boolean isEnable3DExperience()

    • 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(String name)
      sets server name as a last used server name.

    • setAuthServerName

      public void setAuthServerName(String name)
      sets server name as a last used server name.
      Parameters:
      name - server name

    • getMUServerName

      public String getMUServerName()
      gets Last used server name

    • getAuthServerName

      public String getAuthServerName()
      gets Last used authentication server name

    • setMUUserLogin

      public void setMUUserLogin(String name)
      sets user login to MU server

    • getMUUserLogin

      public String getMUUserLogin()
      gets user login to MU server

    • setLoginToken

      public void setLoginToken(String token)
      sets login token to server
      Parameters:
      token - authentication token

    • getLoginToken

      public String getLoginToken()
      gets login token to server

    • getMUUserPassword

      public String getMUUserPassword()
      gets user password to MU server
      Returns:
      secret password

    • setMUUserPasswordAndEncrypt

      public void setMUUserPasswordAndEncrypt(String psw)
      set encrypted password

    • setMUUserPassword

      public void setMUUserPassword(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(String info)

    • getLastUsedEsiBranches

      public String getLastUsedEsiBranches()

    • getServerNames

      public List<String> getServerNames()
      Returns the list of server names, which where entered by user, and successfully connected.

    • getAuthServerNames

      public List<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(List<String> serverNames)
      Setter for Single Sign On server list (server names)

    • getDefaultServerNames

      public List<String> getDefaultServerNames()

    • setServerNames

      public void setServerNames(List<String> serverNames)
      Setter for team server list (server names)

    • getIncludeVersionIntoURLMode

      public String getIncludeVersionIntoURLMode()

    • setIncludeVersionIntoURLMode

      public void setIncludeVersionIntoURLMode(String value)

    • getLastExpandedCategories

      public Collection<String> getLastExpandedCategories()
      Gets collection of identifiers of categories that were recently expanded.
      Returns:
      collection of category id.

    • setLastExpandedCategories

      public void setLastExpandedCategories(Collection<String> categoryIds)
      Sets collection of identifiers of categories that were recently expanded.

    • getLastExpandedProjectUsagesCategories

      public Collection<String> getLastExpandedProjectUsagesCategories()
      Gets collection of identifiers of project usages categories that were recently expanded.
      Returns:
      collection of category id.

    • setLastExpandedProjectUsagesCategories

      public void setLastExpandedProjectUsagesCategories(Collection<String> categoryIds)
      Sets collection of identifiers of project usages categories that were recently expanded.

    • getLastSelectedEsiOfflineServerID

      @CheckForNull public String getLastSelectedEsiOfflineServerID()
      Gets last selected esi offline server.
      Returns:
      server id

    • setLastSelectedEsiOfflineServerID

      public void setLastSelectedEsiOfflineServerID(String serverId)
      Sets server identifiers that was last selected as offline server.
      Parameters:
      serverId - server ID (esi server cluster ID)

    • getProjectsTreeTableMode

      public String getProjectsTreeTableMode()
      Gets the teamwork projects tree table display mode.
      Returns:
      mode
      See Also:

    • setProjectsTreeTableMode

      public void setProjectsTreeTableMode(String value)
      Sets the teamwork projects tree table display mode.
      See Also:

    • 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()

    • 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(String id)
      Sets last used cameo resource(project) ID.
      Parameters:
      id - unique id of resource.

    • getLastCameoResourceId

      @CheckForNull public 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(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(String url)
      Sets WebApp URL.
      Parameters:
      url - new URL

    • getWebAppServerUrl

      @CheckForNull public String getWebAppServerUrl()
      Gets WebApp URL.
      Returns:
      WebApp URL

    • setRepresentationOfUsers

      public void setRepresentationOfUsers(int choice)
      Sets how to display users
      Parameters:
      choice - field to show (user name = 0, full name = 1, email = 2)

    • getRepresentationOfUsers

      public int getRepresentationOfUsers()
      Gets how to display users
      Returns:
      field to show (user name = 0, full name = 1, email = 2)