com.starbase.starteam
Class StarTeamClientOptions

java.lang.Object
  |
  +--com.starbase.starteam.StarTeamClientOptions

public class StarTeamClientOptions

extends java.lang.Object

Field Summary

static java.lang.String	CHANGE_CHECK_NEW_ITEM_ACTIVATED
static java.lang.String	CHANGE_CHECK_NEW_ITEM_INTERVAL
static java.lang.String	CHANGE_READ_ON_SELECT_CHANGE_ACTIVATED
static java.lang.String	CHANGE_SELECTED_ITEM_TIMER_ACTIVATED
static java.lang.String	CHANGE_SELECTED_ITEM_TIMER_INTERVAL
static java.lang.String	FILE_CENTRAL_STATUS_DIRECTORY
static java.lang.String	FILE_CLEAR_LOCKS_ON_CHECK_IN
static java.lang.String	FILE_COMPARE_OPTIONS
static java.lang.String	FILE_COMPARE_PATH
static java.lang.String	FILE_DEFAULT_ENCODING
static java.lang.String	FILE_DEFAULT_EOL
static java.lang.String	FILE_DEFAULT_STATUS_METHOD
static java.lang.String	FILE_EDITOR_OPTIONS
static java.lang.String	FILE_EDITOR_PATH
static java.lang.String	FILE_LOCALDIRECTORYWATCH
static java.lang.String	FILE_LOCK_FILES_EXCLUSIVELY_ON_CHECK_OUT
static java.lang.String	FILE_MARK_UNLOCKED_FILES_READ_ONLY
static java.lang.String	FILE_MERGE_OPTIONS
static java.lang.String	FILE_MERGE_PATH
static java.lang.String	FILE_OPTIMIZE_FOR_SLOW_CONNECTIONS
static java.lang.String	FILE_PERFORM_EOL_CONVERSION
static java.lang.String	FILE_POPUP_VISMERGE_ALWAYS
static java.lang.String	FILE_USE_ALTERNATE_COMPARE
static java.lang.String	FILE_USE_ALTERNATE_EDITOR
static java.lang.String	FILE_USE_ALTERNATE_MERGE
static java.lang.String	FILE_USE_MD5_TO_CALCULATE_STATUS
static java.lang.String	FILE_USE_MODIFIED_TIME_STAMP
static java.lang.String	FILE_USE_NON_EXCLUSIVE_LOCKS_IN_INTEGRATIONS
static java.lang.String	TASK_CHECK_NEW_ITEM_ACTIVATED
static java.lang.String	TASK_CHECK_NEW_ITEM_INTERVAL
static java.lang.String	TASK_READ_ON_SELECT_CHANGE_ACTIVATED
static java.lang.String	TASK_SELECTED_ITEM_TIMER_ACTIVATED
static java.lang.String	TASK_SELECTED_ITEM_TIMER_INTERVAL
static java.lang.String	TOPIC_CHECK_NEW_ITEM_ACTIVATED
static java.lang.String	TOPIC_CHECK_NEW_ITEM_INTERVAL
static java.lang.String	TOPIC_READ_ON_SELECT_CHANGE_ACTIVATED
static java.lang.String	TOPIC_SELECTED_ITEM_TIMER_ACTIVATED
static java.lang.String	TOPIC_SELECTED_ITEM_TIMER_INTERVAL
static java.lang.String	WORKSPACE_AUTO_REFRESH
static java.lang.String	WORKSPACE_CHANGE_SCOPE_FOLDER
static java.lang.String	WORKSPACE_CONFIRM_DELETE
static java.lang.String	WORKSPACE_CONFIRM_MOVE
static java.lang.String	WORKSPACE_FALCON
static java.lang.String	WORKSPACE_FOLDER_CONTEXT
static java.lang.String	WORKSPACE_HISTORY_UTC
static java.lang.String	WORKSPACE_INSTANT_REFRESH
static java.lang.String	WORKSPACE_INSTANT_REFRESH_MAX_TIME
static java.lang.String	WORKSPACE_INSTANT_REFRESH_MIN_TIME
static java.lang.String	WORKSPACE_LOG_COMMAND_DETAILS
static java.lang.String	WORKSPACE_LOG_COMMANDS
static java.lang.String	WORKSPACE_LOG_ERRORS
static java.lang.String	WORKSPACE_LOG_EVENTS
static java.lang.String	WORKSPACE_LOG_OUTPUT_PATH
static java.lang.String	WORKSPACE_LOG_THRESHOLD
static java.lang.String	WORKSPACE_LOG_UI_OPERATIONS
static java.lang.String	WORKSPACE_MAINTAIN_GROUP_STATE
static java.lang.String	WORKSPACE_REFRESH_TIME
static java.lang.String	WORKSPACE_REPORT_OUTPUT_PATH
static java.lang.String	WORKSPACE_RESTORE_SHORTCUTS
static java.lang.String	WORKSPACE_SHOW_STATUSBAR
static java.lang.String	WORKSPACE_SHOW_TOOLBARS
static java.lang.String	WORKSPACE_SHOW_VIRTUAL_MEETING_OPTIONS
static java.lang.String	WORKSPACE_WARNINGS

Constructor Summary

StarTeamClientOptions()
Creates a new StarTeamClientOptions instance which can be used to get/set client side options used by StarTeam clients.

Method Summary

void	clearProcessItem(View view) Deprecated. Applications that use this method cannot support process items that reside in a view other than the target view.
boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
Item[]	getAllProcessItems(Server s) Gets the list of items that have been set as the current process item for at least one view on the given server.
java.lang.String	getCentralStatusDirectory() Returns the path to be user for storing centralized status information.
boolean	getChangeCheckNewItemActivated() Returns the workstation option value.
int	getChangeCheckNewItemInterval() Returns the workstation option value.
boolean	getChangeReadOnSelectChangeActivated() Returns the workstation option value.
boolean	getChangeSelectedItemTimerActivated() Returns the workstation option value.
int	getChangeSelectedItemTimerInterval() Returns the workstation option value.
java.lang.String	getComponentOption(java.lang.String componentName, java.lang.String optionName, java.lang.String defaultValue) Returns the specified workstation option.
static StarTeamClientOptions	getDefault() Returns the singleton default StarTeamClientOptions object based on the default options file location.
static java.io.File	getDefaultFile() Returns the default StarTeamClientOptions file.
StatusMethod	getDefaultStatusMethod()
boolean	getFileClearLocksOnCheckIn() Returns the workstation option value.
java.lang.String	getFileCompareOptions() Returns the workstation option value.
java.lang.String	getFileComparePath() Returns the workstation option value.
java.lang.String	getFileDefaultEncoding() Returns the workstation option value.
java.lang.String	getFileDefaultEOL() Returns the workstation option value.
java.lang.String	getFileEditorOptions() Returns the workstation option value.
java.lang.String	getFileEditorPath() Returns the workstation option value.
boolean	getFileLocalDirectoryWatch() Returns the workstation option value.
boolean	getFileLockFilesExclusivelyOnCheckOut() Returns the workstation option value.
boolean	getFileMarkUnlockedFilesReadOnly() Returns the workstation option value.
java.lang.String	getFileMergeOptions() Returns the workstation option value.
java.lang.String	getFileMergePath() Returns the workstation option value.
boolean	getFileOptimizeForSlowConnections() Returns the workstation option value.
boolean	getFilePerformEOLConversion() Returns the workstation option value.
boolean	getFilePopupVisMergeAlways() Returns the workstation option value.
boolean	getFileUseAlternateCompare() Returns the workstation option value.
boolean	getFileUseAlternateEditor() Returns the workstation option value.
boolean	getFileUseAlternateMerge() Returns the workstation option value.
boolean	getFileUseMD5ToCalculateStatus() Returns the workstation option value.
boolean	getFileUseModifiedTimeStamp() Returns the workstation option value.
boolean	getFileUseNonExclusiveLocksInIntegrations() Returns the workstation option value.
java.lang.String	getFolderAlternatePath(Folder folder) Returns the alternate working directory for the specified folder.
boolean	getFolderAlternatePathEnabled(Folder folder) Return true if the alternate working directory is enabled for this folder.
boolean	getFolderUserVisible(Folder folder) Return true if the specified folder is user visible.
boolean	getMPXEnabled() Returns the workstation option value to enable mpx.
java.lang.String	getOption(java.lang.String optionName, java.lang.String defaultValue) Returns the specified workstation option.
Item	getProcessItem(View target) Gets the current process item in the given target view.
int	getProcessItemClassID(View view) Deprecated. Applications that use this method cannot support process items that reside in a view other than the target view.
int	getProcessItemID(View view) Deprecated. Applications that use this method cannot support process items that reside in a view other than the target view.
boolean	getTaskCheckNewItemActivated() Returns the workstation option value.
int	getTaskCheckNewItemInterval() Returns the workstation option value.
boolean	getTaskReadOnSelectChangeActivated() Returns the workstation option value.
boolean	getTaskSelectedItemTimerActivated() Returns the workstation option value.
int	getTaskSelectedItemTimerInterval() Returns the workstation option value.
boolean	getTopicCheckNewItemActivated() Returns the workstation option value.
int	getTopicCheckNewItemInterval() Returns the workstation option value.
boolean	getTopicReadOnSelectChangeActivated() Returns the workstation option value.
boolean	getTopicSelectedItemTimerActivated() Returns the workstation option value.
int	getTopicSelectedItemTimerInterval() Returns the workstation option value.
java.lang.String	getViewAlternatePath(View view) Returns the alternate working directory for the specified view.
boolean	getViewAlternatePathEnabled(View view) Return true if the alternate working directory is enabled for this view.
StatusMethod	getViewStatusMethodOverride(View view) Returns the option value stored for the specified View's status method.
boolean	getWorkspaceAutoRefresh() Returns the workstation option value.
boolean	getWorkspaceChangeScopeFolder() Returns the workstation option value.
boolean	getWorkspaceConfirmDelete() Returns the workstation option value.
boolean	getWorkspaceConfirmMove() Returns the workstation option value.
boolean	getWorkspaceFalcon() Deprecated. Use getMPXEnabled instead
boolean	getWorkspaceFolderContext() Returns the workstation option value.
boolean	getWorkspaceHistoryUTC() Returns the workstation option value.
boolean	getWorkspaceInstantRefresh() Returns the workstation option value.
int	getWorkspaceInstantRefreshMaxTime() Returns the workstation option value.
int	getWorkspaceInstantRefreshMinTime() Returns the workstation option value.
boolean	getWorkspaceLogCommandDetails() Returns the workstation option value.
boolean	getWorkspaceLogCommands() Returns the workstation option value.
boolean	getWorkspaceLogErrors() Returns the workstation option value.
boolean	getWorkspaceLogEvents() Returns the workstation option value.
java.lang.String	getWorkspaceLogOutputPath() Returns the workstation option value.
int	getWorkspaceLogThreshold() Returns the workstation option value.
boolean	getWorkspaceLogUIOperations() Returns the workstation option value.
boolean	getWorkspaceMaintainGroupState() Returns the workstation option value.
boolean	getWorkspaceRefreshTime() Returns the workstation option value.
java.lang.String	getWorkspaceReportOutputPath() Returns the workstation option value.
boolean	getWorkspaceRestoreShortcuts() Returns the workstation option value.
boolean	getWorkspaceShowStatusBar() Returns the workstation option value.
boolean	getWorkspaceShowToolbars() Returns the workstation option value.
boolean	getWorkspaceShowVirtualMeetingOptions() Returns the workstation option value.
boolean	getWorkspaceWarnings() Returns the workstation option value.
int	hashCode() returns a unique hash for all instances of this type
void	load(java.io.File file) Load the options from the specified file.
void	loadDefault() Loads the options from the default file.
void	reload() Re-loads the underlying options file.
void	reloadIfNeeded() Re-loads the ini only if the file's last modified time stamp has changed.
void	save() Writes the options to the underlying file.
void	saveTo(java.io.File file) Saves the options to the new file.
void	setCentralStatusDirectory(java.lang.String path) Set the path to be user for storing centralized status information.
void	setChangeCheckNewItemActivated(boolean value) Sets the workstation option value.
void	setChangeCheckNewItemInterval(int value) Sets the workstation option value.
void	setChangeReadOnSelectChangeActivated(boolean value) Sets the workstation option value.
void	setChangeSelectedItemTimerActivated(boolean value) Sets the workstation option value.
void	setChangeSelectedItemTimerInterval(int value) Sets the workstation option value.
void	setComponentOption(java.lang.String componentName, java.lang.String optionName, java.lang.String value) Sets the specified workstation option.
void	setDefaultStatusMethod(StatusMethod method) Sets the default status method to be used by the client.
void	setFileClearLocksOnCheckIn(boolean value) Sets the workstation option value.
void	setFileCompareOptions(java.lang.String value) Sets the workstation option value.
void	setFileComparePath(java.lang.String value) Sets the workstation option value.
void	setFileDefaultEncoding(java.lang.String value) Sets the workstation option value.
void	setFileDefaultEOL(java.lang.String value) Sets the workstation option value.
void	setFileEditorOptions(java.lang.String value) Sets the workstation option value.
void	setFileEditorPath(java.lang.String value) Sets the workstation option value.
void	setFileLocalDirectoryWatch(boolean value) Sets the workstation option value.
void	setFileLockFilesExclusivelyOnCheckOut(boolean value) Sets the workstation option value.
void	setFileMarkUnlockedFilesReadOnly(boolean value) Sets the workstation option value.
void	setFileMergeOptions(java.lang.String value) Sets the workstation option value.
void	setFileMergePath(java.lang.String value) Sets the workstation option value.
void	setFileOptimizeForSlowConnections(boolean value) Sets the workstation option value.
void	setFilePerformEOLConversion(boolean value) Sets the workstation option value.
void	setFilePopupVisMergeAlways(boolean value) Sets the workstation option value.
void	setFileUseAlternateCompare(boolean value) Sets the workstation option value.
void	setFileUseAlternateEditor(boolean value) Sets the workstation option value.
void	setFileUseAlternateMerge(boolean value) Sets the workstation option value.
void	setFileUseMD5ToCalculateStatus(boolean value) Sets the workstation option value.
void	setFileUseModifiedTimeStamp(boolean value) Sets the workstation option value.
void	setFileUseNonExclusiveLocksInIntegrations(boolean value) Sets the workstation option value.
void	setFolderAlternatePath(Folder folder, java.lang.String path) Change the option value stored for the specified Folder's alternate working directory.
void	setFolderAlternatePathEnabled(Folder folder, boolean enabled) Change whether or not the alternate working directory should be used for the specified folder.
void	setFolderUserVisible(Folder folder, boolean visible) Change whether or not the specified folder should be visible.
void	setMPXEnabled(boolean value) Sets the workstation option value to enable mpx.
void	setOption(java.lang.String optionName, java.lang.String value) Sets the specified workstation option.
void	setProcessItem(Item item) Deprecated. Applications that use this method cannot support process items that reside in a view other than the target view.
void	setProcessItem(Item item, View target) Sets the current process item for the given target view.
void	setTaskCheckNewItemActivated(boolean value) Sets the workstation option value.
void	setTaskCheckNewItemInterval(int value) Sets the workstation option value.
void	setTaskReadOnSelectChangeActivated(boolean value) Sets the workstation option value.
void	setTaskSelectedItemTimerActivated(boolean value) Sets the workstation option value.
void	setTaskSelectedItemTimerInterval(int value) Sets the workstation option value.
void	setTopicCheckNewItemActivated(boolean value) Sets the workstation option value.
void	setTopicCheckNewItemInterval(int value) Sets the workstation option value.
void	setTopicReadOnSelectChangeActivated(boolean value) Sets the workstation option value.
void	setTopicSelectedItemTimerActivated(boolean value) Sets the workstation option value.
void	setTopicSelectedItemTimerInterval(int value) Sets the workstation option value.
void	setViewAlternatePath(View view, java.lang.String path) Change the option value stored for the specified View's alternate working directory.
void	setViewAlternatePathEnabled(View view, boolean enabled) Change whether or not the alternate working directory should be used for the specified view.
void	setViewStatusMethodOverride(View view, StatusMethod method) Change the option value stored for the specified View's status method This does not modify the view object.
void	setWorkspaceAutoRefresh(boolean value) Sets the workstation option value.
void	setWorkspaceChangeScopeFolder(boolean value) Sets the workstation option value.
void	setWorkspaceConfirmDelete(boolean value) Sets the workstation option value.
void	setWorkspaceConfirmMove(boolean value) Sets the workstation option value.
void	setWorkspaceFalcon(boolean value) Deprecated. Use setMPXEnabled instead
void	setWorkspaceFolderContext(boolean value) Sets the workstation option value.
void	setWorkspaceHistoryUTC(boolean value) Sets the workstation option value.
void	setWorkspaceInstantRefresh(boolean value) Sets the workstation option value.
void	setWorkspaceInstantRefreshMaxTime(int value) Sets the workstation option value.
void	setWorkspaceInstantRefreshMinTime(int value) Sets the workstation option value.
void	setWorkspaceLogCommandDetails(boolean value) Sets the workstation option value.
void	setWorkspaceLogCommands(boolean value) Sets the workstation option value.
void	setWorkspaceLogErrors(boolean value) Sets the workstation option value.
void	setWorkspaceLogEvents(boolean value) Sets the workstation option value.
void	setWorkspaceLogOutputPath(java.lang.String value) Sets the workstation option value.
void	setWorkspaceLogThreshold(int value) Sets the workstation option value.
void	setWorkspaceLogUIOperations(boolean value) Sets the workstation option value.
void	setWorkspaceMaintainGroupState(boolean value) Sets the workstation option value.
void	setWorkspaceRefreshTime(boolean value) Sets the workstation option value.
void	setWorkspaceReportOutputPath(java.lang.String value) Sets the workstation option value.
void	setWorkspaceRestoreShortcuts(boolean value) Sets the workstation option value.
void	setWorkspaceShowStatusBar(boolean value) Sets the workstation option value.
void	setWorkspaceShowToolbars(boolean value) Sets the workstation option value.
void	setWorkspaceShowVirtualMeetingOptions(boolean value) Sets the workstation option value.
void	setWorkspaceWarnings(boolean value) Sets the workstation option value.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHANGE_CHECK_NEW_ITEM_ACTIVATED

public static final java.lang.String CHANGE_CHECK_NEW_ITEM_ACTIVATED

See Also:

Constant Field Values

CHANGE_CHECK_NEW_ITEM_INTERVAL

public static final java.lang.String CHANGE_CHECK_NEW_ITEM_INTERVAL

See Also:

Constant Field Values

CHANGE_READ_ON_SELECT_CHANGE_ACTIVATED

public static final java.lang.String CHANGE_READ_ON_SELECT_CHANGE_ACTIVATED

See Also:

Constant Field Values

CHANGE_SELECTED_ITEM_TIMER_ACTIVATED

public static final java.lang.String CHANGE_SELECTED_ITEM_TIMER_ACTIVATED

See Also:

Constant Field Values

CHANGE_SELECTED_ITEM_TIMER_INTERVAL

public static final java.lang.String CHANGE_SELECTED_ITEM_TIMER_INTERVAL

See Also:

Constant Field Values

FILE_CLEAR_LOCKS_ON_CHECK_IN

public static final java.lang.String FILE_CLEAR_LOCKS_ON_CHECK_IN

See Also:

Constant Field Values

FILE_COMPARE_OPTIONS

public static final java.lang.String FILE_COMPARE_OPTIONS

See Also:

Constant Field Values

FILE_COMPARE_PATH

public static final java.lang.String FILE_COMPARE_PATH

See Also:

Constant Field Values

FILE_EDITOR_PATH

public static final java.lang.String FILE_EDITOR_PATH

See Also:

Constant Field Values

FILE_EDITOR_OPTIONS

public static final java.lang.String FILE_EDITOR_OPTIONS

See Also:

Constant Field Values

FILE_LOCALDIRECTORYWATCH

public static final java.lang.String FILE_LOCALDIRECTORYWATCH

See Also:

Constant Field Values

FILE_LOCK_FILES_EXCLUSIVELY_ON_CHECK_OUT

public static final java.lang.String FILE_LOCK_FILES_EXCLUSIVELY_ON_CHECK_OUT

See Also:

Constant Field Values

FILE_MARK_UNLOCKED_FILES_READ_ONLY

public static final java.lang.String FILE_MARK_UNLOCKED_FILES_READ_ONLY

See Also:

Constant Field Values

FILE_MERGE_OPTIONS

public static final java.lang.String FILE_MERGE_OPTIONS

See Also:

Constant Field Values

FILE_MERGE_PATH

public static final java.lang.String FILE_MERGE_PATH

See Also:

Constant Field Values

FILE_OPTIMIZE_FOR_SLOW_CONNECTIONS

public static final java.lang.String FILE_OPTIMIZE_FOR_SLOW_CONNECTIONS

See Also:

Constant Field Values

FILE_POPUP_VISMERGE_ALWAYS

public static final java.lang.String FILE_POPUP_VISMERGE_ALWAYS

See Also:

Constant Field Values

FILE_USE_ALTERNATE_COMPARE

public static final java.lang.String FILE_USE_ALTERNATE_COMPARE

See Also:

Constant Field Values

FILE_USE_ALTERNATE_EDITOR

public static final java.lang.String FILE_USE_ALTERNATE_EDITOR

See Also:

Constant Field Values

FILE_USE_ALTERNATE_MERGE

public static final java.lang.String FILE_USE_ALTERNATE_MERGE

See Also:

Constant Field Values

FILE_USE_MD5_TO_CALCULATE_STATUS

public static final java.lang.String FILE_USE_MD5_TO_CALCULATE_STATUS

See Also:

Constant Field Values

FILE_USE_MODIFIED_TIME_STAMP

public static final java.lang.String FILE_USE_MODIFIED_TIME_STAMP

See Also:

Constant Field Values

FILE_PERFORM_EOL_CONVERSION

public static final java.lang.String FILE_PERFORM_EOL_CONVERSION

See Also:

Constant Field Values

FILE_DEFAULT_EOL

public static final java.lang.String FILE_DEFAULT_EOL

See Also:

Constant Field Values

FILE_DEFAULT_ENCODING

public static final java.lang.String FILE_DEFAULT_ENCODING

See Also:

Constant Field Values

FILE_USE_NON_EXCLUSIVE_LOCKS_IN_INTEGRATIONS

public static final java.lang.String FILE_USE_NON_EXCLUSIVE_LOCKS_IN_INTEGRATIONS

See Also:

Constant Field Values

FILE_DEFAULT_STATUS_METHOD

public static final java.lang.String FILE_DEFAULT_STATUS_METHOD

See Also:

Constant Field Values

FILE_CENTRAL_STATUS_DIRECTORY

public static final java.lang.String FILE_CENTRAL_STATUS_DIRECTORY

See Also:

Constant Field Values

TASK_CHECK_NEW_ITEM_ACTIVATED

public static final java.lang.String TASK_CHECK_NEW_ITEM_ACTIVATED

See Also:

Constant Field Values

TASK_CHECK_NEW_ITEM_INTERVAL

public static final java.lang.String TASK_CHECK_NEW_ITEM_INTERVAL

See Also:

Constant Field Values

TASK_READ_ON_SELECT_CHANGE_ACTIVATED

public static final java.lang.String TASK_READ_ON_SELECT_CHANGE_ACTIVATED

See Also:

Constant Field Values

TASK_SELECTED_ITEM_TIMER_ACTIVATED

public static final java.lang.String TASK_SELECTED_ITEM_TIMER_ACTIVATED

See Also:

Constant Field Values

TASK_SELECTED_ITEM_TIMER_INTERVAL

public static final java.lang.String TASK_SELECTED_ITEM_TIMER_INTERVAL

See Also:

Constant Field Values

TOPIC_CHECK_NEW_ITEM_ACTIVATED

public static final java.lang.String TOPIC_CHECK_NEW_ITEM_ACTIVATED

See Also:

Constant Field Values

TOPIC_CHECK_NEW_ITEM_INTERVAL

public static final java.lang.String TOPIC_CHECK_NEW_ITEM_INTERVAL

See Also:

Constant Field Values

TOPIC_READ_ON_SELECT_CHANGE_ACTIVATED

public static final java.lang.String TOPIC_READ_ON_SELECT_CHANGE_ACTIVATED

See Also:

Constant Field Values

TOPIC_SELECTED_ITEM_TIMER_ACTIVATED

public static final java.lang.String TOPIC_SELECTED_ITEM_TIMER_ACTIVATED

See Also:

Constant Field Values

TOPIC_SELECTED_ITEM_TIMER_INTERVAL

public static final java.lang.String TOPIC_SELECTED_ITEM_TIMER_INTERVAL

See Also:

Constant Field Values

WORKSPACE_AUTO_REFRESH

public static final java.lang.String WORKSPACE_AUTO_REFRESH

See Also:

Constant Field Values

WORKSPACE_CHANGE_SCOPE_FOLDER

public static final java.lang.String WORKSPACE_CHANGE_SCOPE_FOLDER

See Also:

Constant Field Values

WORKSPACE_CONFIRM_DELETE

public static final java.lang.String WORKSPACE_CONFIRM_DELETE

See Also:

Constant Field Values

WORKSPACE_CONFIRM_MOVE

public static final java.lang.String WORKSPACE_CONFIRM_MOVE

See Also:

Constant Field Values

WORKSPACE_FALCON

public static final java.lang.String WORKSPACE_FALCON

See Also:

Constant Field Values

WORKSPACE_FOLDER_CONTEXT

public static final java.lang.String WORKSPACE_FOLDER_CONTEXT

See Also:

Constant Field Values

WORKSPACE_HISTORY_UTC

public static final java.lang.String WORKSPACE_HISTORY_UTC

See Also:

Constant Field Values

WORKSPACE_INSTANT_REFRESH

public static final java.lang.String WORKSPACE_INSTANT_REFRESH

See Also:

Constant Field Values

WORKSPACE_INSTANT_REFRESH_MAX_TIME

public static final java.lang.String WORKSPACE_INSTANT_REFRESH_MAX_TIME

See Also:

Constant Field Values

WORKSPACE_INSTANT_REFRESH_MIN_TIME

public static final java.lang.String WORKSPACE_INSTANT_REFRESH_MIN_TIME

See Also:

Constant Field Values

WORKSPACE_LOG_COMMAND_DETAILS

public static final java.lang.String WORKSPACE_LOG_COMMAND_DETAILS

See Also:

Constant Field Values

WORKSPACE_LOG_COMMANDS

public static final java.lang.String WORKSPACE_LOG_COMMANDS

See Also:

Constant Field Values

WORKSPACE_LOG_ERRORS

public static final java.lang.String WORKSPACE_LOG_ERRORS

See Also:

Constant Field Values

WORKSPACE_LOG_EVENTS

public static final java.lang.String WORKSPACE_LOG_EVENTS

See Also:

Constant Field Values

WORKSPACE_LOG_OUTPUT_PATH

public static final java.lang.String WORKSPACE_LOG_OUTPUT_PATH

See Also:

Constant Field Values

WORKSPACE_LOG_THRESHOLD

public static final java.lang.String WORKSPACE_LOG_THRESHOLD

See Also:

Constant Field Values

WORKSPACE_LOG_UI_OPERATIONS

public static final java.lang.String WORKSPACE_LOG_UI_OPERATIONS

See Also:

Constant Field Values

WORKSPACE_MAINTAIN_GROUP_STATE

public static final java.lang.String WORKSPACE_MAINTAIN_GROUP_STATE

See Also:

Constant Field Values

WORKSPACE_REFRESH_TIME

public static final java.lang.String WORKSPACE_REFRESH_TIME

See Also:

Constant Field Values

WORKSPACE_REPORT_OUTPUT_PATH

public static final java.lang.String WORKSPACE_REPORT_OUTPUT_PATH

See Also:

Constant Field Values

WORKSPACE_RESTORE_SHORTCUTS

public static final java.lang.String WORKSPACE_RESTORE_SHORTCUTS

See Also:

Constant Field Values

WORKSPACE_SHOW_STATUSBAR

public static final java.lang.String WORKSPACE_SHOW_STATUSBAR

See Also:

Constant Field Values

WORKSPACE_SHOW_TOOLBARS

public static final java.lang.String WORKSPACE_SHOW_TOOLBARS

See Also:

Constant Field Values

WORKSPACE_SHOW_VIRTUAL_MEETING_OPTIONS

public static final java.lang.String WORKSPACE_SHOW_VIRTUAL_MEETING_OPTIONS

See Also:

Constant Field Values

WORKSPACE_WARNINGS

public static final java.lang.String WORKSPACE_WARNINGS

See Also:

Constant Field Values

Constructor Detail

StarTeamClientOptions

public StarTeamClientOptions()

Creates a new StarTeamClientOptions instance which can be used to get/set client side options used by StarTeam clients.

Method Detail

getDefault

public static StarTeamClientOptions getDefault()
                                        throws java.io.IOException

Returns the singleton default StarTeamClientOptions object based on the default options file location.

java.io.IOException

getDefaultFile

public static java.io.File getDefaultFile()
                                   throws java.io.IOException

Returns the default StarTeamClientOptions file. On Windows this will be the value of the environment variable "StarTeam". On non-windows platforms this will be the file called "StarTeam.ini" in the user's home directory.

java.io.IOException

loadDefault

public void loadDefault()
                 throws java.io.IOException

Loads the options from the default file.

java.io.IOException

save

public void save()
          throws java.io.IOException

Writes the options to the underlying file.

java.io.IOException

saveTo

public void saveTo(java.io.File file)
            throws java.io.IOException

Saves the options to the new file. This becomes the new underlying file for this StarTeamClientOptions object.

java.io.IOException

load

public void load(java.io.File file)
          throws java.io.IOException

Load the options from the specified file. This file becomes the new underlying file for this StarTeamClientOptions object.

java.io.IOException

reload

public void reload()
            throws java.io.IOException

Re-loads the underlying options file.

Throws:

java.io.IOException - if any errors occur while loading the file

reloadIfNeeded

public void reloadIfNeeded()
                    throws java.io.IOException

Re-loads the ini only if the file's last modified time stamp has changed.

Throws:

java.io.IOException - if any errors occur while loading the file

getComponentOption

public java.lang.String getComponentOption(java.lang.String componentName,
                                           java.lang.String optionName,
                                           java.lang.String defaultValue)

Returns the specified workstation option. If the option is not set then the specified default value is returned.

Parameters:

componentName - the component name of the option

optionName - the component specific options name

defaultValue - the default value to return if the option is not set

setComponentOption

public void setComponentOption(java.lang.String componentName,
                               java.lang.String optionName,
                               java.lang.String value)

Sets the specified workstation option. This does not automatically save the changes to the underlying file. You need to explicitly call one of the save methods.

Parameters:

componentName - the component name of the option

optionName - the component specific options name

value - the new option value

getOption

public java.lang.String getOption(java.lang.String optionName,
                                  java.lang.String defaultValue)

Returns the specified workstation option. If the option is not set then the specified default value is returned.

Parameters:

optionName - the option name

defaultValue - the default value to return if the option is not set

setOption

public void setOption(java.lang.String optionName,
                      java.lang.String value)

Sets the specified workstation option. This does not automatically save the changes to the underlying file. You need to explicitly call one of the save methods.

Parameters:

optionName - the option name

value - the new option value

setViewStatusMethodOverride

public void setViewStatusMethodOverride(View view,
                                        StatusMethod method)

Change the option value stored for the specified View's status method This does not modify the view object.

Parameters:

view - the view whose status method is to be overriden

method - the new status method to use for files in this view

See Also:

View.setStatusMethodOverride(com.starbase.starteam.StatusMethod), View.getStatusMethodOverride()

getViewStatusMethodOverride

public StatusMethod getViewStatusMethodOverride(View view)

Returns the option value stored for the specified View's status method.

Parameters:

view - the view whose status method is to be returned

See Also:

View.getStatusMethodOverride(), View.setStatusMethodOverride(com.starbase.starteam.StatusMethod)

setCentralStatusDirectory

public void setCentralStatusDirectory(java.lang.String path)

Set the path to be user for storing centralized status information.

Parameters:

path - the new directory path for central status

See Also:

StatusMethod.setCentralStatusDirectory(java.lang.String), StatusMethod.getCentralStatusDirectory()

getCentralStatusDirectory

public java.lang.String getCentralStatusDirectory()
                                           throws java.io.IOException

Returns the path to be user for storing centralized status information. If not set in this options file this will return a default location.

java.io.IOException

See Also:

StatusMethod.setCentralStatusDirectory(java.lang.String), StatusMethod.getCentralStatusDirectory(), ConfigFiles.getDefaultCentralStatusDirectory()

setDefaultStatusMethod

public void setDefaultStatusMethod(StatusMethod method)

Sets the default status method to be used by the client.

Parameters:

method - the new status method. Can not be null and can not be StatusMethod.DEFAULT

getDefaultStatusMethod

public StatusMethod getDefaultStatusMethod()

Returns:

the default status method to be used by the client. If not set in these options then this method CENTRAL.

setProcessItem

public void setProcessItem(Item item)
                    throws java.io.IOException

Deprecated. Applications that use this method cannot support process items that reside in a view other than the target view.

Sets the process item for the specified item's view.

Parameters:

item - the item which is to be the process item. May not be null.

java.io.IOException

See Also:

StarTeamClientOptions.setProcessItem(Item,View)

clearProcessItem

public void clearProcessItem(View view)
                      throws java.io.IOException

Deprecated. Applications that use this method cannot support process items that reside in a view other than the target view.

Clears the process item for the specified view.

Parameters:

view - the view whose process item is to be cleared.

java.io.IOException

See Also:

StarTeamClientOptions.setProcessItem(Item,View)

getProcessItemID

public int getProcessItemID(View view)
                     throws java.io.IOException

Deprecated. Applications that use this method cannot support process items that reside in a view other than the target view.

Returns the item ID of the process item for the specified view. Will return -1 if no process item is specified for the view.

Parameters:

view - the view whose process item ID is to be returned

Returns:

the item ID of the view's process item, or -1 if no process item is defined for the view.

java.io.IOException

See Also:

StarTeamClientOptions.setProcessItem(Item,View)

getProcessItemClassID

public int getProcessItemClassID(View view)
                          throws java.io.IOException

Deprecated. Applications that use this method cannot support process items that reside in a view other than the target view.

Returns the class ID of the process item for the specified view. Will return -1 if no process item is specified for the view.

Parameters:

view - the view whose process item class ID is to be returned

Returns:

the class ID of the view's process item, or -1 if no process item is defined for the view.

java.io.IOException

See Also:

StarTeamClientOptions.setProcessItem(Item,View)

setProcessItem

public void setProcessItem(Item item,
                           View target)

Sets the current process item for the given target view.

Parameters:

item - A process item, or null to clear the process item in the given target view.

target - The target view.

getProcessItem

public Item getProcessItem(View target)

Gets the current process item in the given target view.

Parameters:

target - The target view.

Returns:

The current process item in the given target view, or null if there is no current process item in that view.

getAllProcessItems

public Item[] getAllProcessItems(Server s)

Gets the list of items that have been set as the current process item for at least one view on the given server.

Parameters:

s - A StarTeam server.

Returns:

Item[] The list of items that have been set as the current process item for at least one view on the given server.

setViewAlternatePath

public void setViewAlternatePath(View view,
                                 java.lang.String path)

Change the option value stored for the specified View's alternate working directory. This does not modify the view object.

Parameters:

view - the view whose working directory is to be overriden

path - the new alternate working directory for the view

setViewAlternatePathEnabled

public void setViewAlternatePathEnabled(View view,
                                        boolean enabled)

Change whether or not the alternate working directory should be used for the specified view.

Parameters:

view - the view whose working directory is to be overriden

enabled - true if the alternate path is to be applied

setFolderAlternatePath

public void setFolderAlternatePath(Folder folder,
                                   java.lang.String path)

Change the option value stored for the specified Folder's alternate working directory. This does not modify the folder object.

Parameters:

folder - the folder whose working directory is to be overriden

path - the new alternate working directory for the folder

setFolderAlternatePathEnabled

public void setFolderAlternatePathEnabled(Folder folder,
                                          boolean enabled)

Change whether or not the alternate working directory should be used for the specified folder.

Parameters:

enabled - true if the alternate path is to be applied

setFolderUserVisible

public void setFolderUserVisible(Folder folder,
                                 boolean visible)

Change whether or not the specified folder should be visible. Typically, a UI should not display items in an invisible folder.

Parameters:

folder - the folder whose working directory is to be overriden

visible - true if the folder should be visible, false otherwise

See Also:

Folder.getUserVisible(), Folder.setUserVisible(boolean), Folder.resolveUserVisible()

getViewAlternatePath

public java.lang.String getViewAlternatePath(View view)

Returns the alternate working directory for the specified view. This may return null.

getViewAlternatePathEnabled

public boolean getViewAlternatePathEnabled(View view)

Return true if the alternate working directory is enabled for this view.

getFolderAlternatePath

public java.lang.String getFolderAlternatePath(Folder folder)

Returns the alternate working directory for the specified folder. This may return null.

getFolderAlternatePathEnabled

public boolean getFolderAlternatePathEnabled(Folder folder)

Return true if the alternate working directory is enabled for this folder.

getFolderUserVisible

public boolean getFolderUserVisible(Folder folder)

Return true if the specified folder is user visible. A UI should not display items in an invisible folder.

Parameters:

folder - the folder whose visiblity is to be determined

Returns:

true if this Folder is user visible.

See Also:

Folder.getUserVisible(), Folder.setUserVisible(boolean), Folder.resolveUserVisible()

getChangeCheckNewItemActivated

public boolean getChangeCheckNewItemActivated()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setChangeCheckNewItemActivated

public void setChangeCheckNewItemActivated(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getChangeCheckNewItemInterval

public int getChangeCheckNewItemInterval()

Returns the workstation option value.

Returns:

option value. Default if not defined: 600

setChangeCheckNewItemInterval

public void setChangeCheckNewItemInterval(int value)

Sets the workstation option value.

Parameters:

value - the new option value

getChangeReadOnSelectChangeActivated

public boolean getChangeReadOnSelectChangeActivated()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setChangeReadOnSelectChangeActivated

public void setChangeReadOnSelectChangeActivated(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getChangeSelectedItemTimerActivated

public boolean getChangeSelectedItemTimerActivated()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setChangeSelectedItemTimerActivated

public void setChangeSelectedItemTimerActivated(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getChangeSelectedItemTimerInterval

public int getChangeSelectedItemTimerInterval()

Returns the workstation option value.

Returns:

option value. Default if not defined: 45

setChangeSelectedItemTimerInterval

public void setChangeSelectedItemTimerInterval(int value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileClearLocksOnCheckIn

public boolean getFileClearLocksOnCheckIn()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFileClearLocksOnCheckIn

public void setFileClearLocksOnCheckIn(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileCompareOptions

public java.lang.String getFileCompareOptions()

Returns the workstation option value.

Returns:

option value. Default if not defined: ""

setFileCompareOptions

public void setFileCompareOptions(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileComparePath

public java.lang.String getFileComparePath()

Returns the workstation option value.

Returns:

option value. Default if not defined: ""

setFileComparePath

public void setFileComparePath(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileDefaultEncoding

public java.lang.String getFileDefaultEncoding()

Returns the workstation option value.

Returns:

option value. Default if not defined: the value of the system property "file.encoding"

setFileDefaultEncoding

public void setFileDefaultEncoding(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileEditorPath

public java.lang.String getFileEditorPath()

Returns the workstation option value.

Returns:

option value. Default if not defined: ""

setFileEditorPath

public void setFileEditorPath(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileEditorOptions

public java.lang.String getFileEditorOptions()

Returns the workstation option value.

Returns:

option value. Default if not defined: ""

setFileEditorOptions

public void setFileEditorOptions(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileLocalDirectoryWatch

public boolean getFileLocalDirectoryWatch()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setFileLocalDirectoryWatch

public void setFileLocalDirectoryWatch(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileLockFilesExclusivelyOnCheckOut

public boolean getFileLockFilesExclusivelyOnCheckOut()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFileLockFilesExclusivelyOnCheckOut

public void setFileLockFilesExclusivelyOnCheckOut(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileMarkUnlockedFilesReadOnly

public boolean getFileMarkUnlockedFilesReadOnly()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFileMarkUnlockedFilesReadOnly

public void setFileMarkUnlockedFilesReadOnly(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileMergeOptions

public java.lang.String getFileMergeOptions()

Returns the workstation option value.

Returns:

option value. Default if not defined: ""

setFileMergeOptions

public void setFileMergeOptions(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileMergePath

public java.lang.String getFileMergePath()

Returns the workstation option value.

Returns:

option value. Default if not defined: ""

setFileMergePath

public void setFileMergePath(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileOptimizeForSlowConnections

public boolean getFileOptimizeForSlowConnections()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFileOptimizeForSlowConnections

public void setFileOptimizeForSlowConnections(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFilePopupVisMergeAlways

public boolean getFilePopupVisMergeAlways()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setFilePopupVisMergeAlways

public void setFilePopupVisMergeAlways(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileUseAlternateCompare

public boolean getFileUseAlternateCompare()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFileUseAlternateCompare

public void setFileUseAlternateCompare(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileUseAlternateEditor

public boolean getFileUseAlternateEditor()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFileUseAlternateEditor

public void setFileUseAlternateEditor(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileUseAlternateMerge

public boolean getFileUseAlternateMerge()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFileUseAlternateMerge

public void setFileUseAlternateMerge(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileUseMD5ToCalculateStatus

public boolean getFileUseMD5ToCalculateStatus()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFileUseMD5ToCalculateStatus

public void setFileUseMD5ToCalculateStatus(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileUseModifiedTimeStamp

public boolean getFileUseModifiedTimeStamp()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFileUseModifiedTimeStamp

public void setFileUseModifiedTimeStamp(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFilePerformEOLConversion

public boolean getFilePerformEOLConversion()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setFilePerformEOLConversion

public void setFilePerformEOLConversion(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileDefaultEOL

public java.lang.String getFileDefaultEOL()

Returns the workstation option value.

Returns:

option value. Default if not defined: "CRLF"

setFileDefaultEOL

public void setFileDefaultEOL(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileUseNonExclusiveLocksInIntegrations

public boolean getFileUseNonExclusiveLocksInIntegrations()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setFileUseNonExclusiveLocksInIntegrations

public void setFileUseNonExclusiveLocksInIntegrations(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getTaskCheckNewItemActivated

public boolean getTaskCheckNewItemActivated()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setTaskCheckNewItemActivated

public void setTaskCheckNewItemActivated(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getTaskCheckNewItemInterval

public int getTaskCheckNewItemInterval()

Returns the workstation option value.

Returns:

option value. Default if not defined: 600

setTaskCheckNewItemInterval

public void setTaskCheckNewItemInterval(int value)

Sets the workstation option value.

Parameters:

value - the new option value

getTaskReadOnSelectChangeActivated

public boolean getTaskReadOnSelectChangeActivated()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setTaskReadOnSelectChangeActivated

public void setTaskReadOnSelectChangeActivated(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getTaskSelectedItemTimerActivated

public boolean getTaskSelectedItemTimerActivated()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setTaskSelectedItemTimerActivated

public void setTaskSelectedItemTimerActivated(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getTaskSelectedItemTimerInterval

public int getTaskSelectedItemTimerInterval()

Returns the workstation option value.

Returns:

option value. Default if not defined: 45

setTaskSelectedItemTimerInterval

public void setTaskSelectedItemTimerInterval(int value)

Sets the workstation option value.

Parameters:

value - the new option value

getTopicCheckNewItemActivated

public boolean getTopicCheckNewItemActivated()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setTopicCheckNewItemActivated

public void setTopicCheckNewItemActivated(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getTopicCheckNewItemInterval

public int getTopicCheckNewItemInterval()

Returns the workstation option value.

Returns:

option value. Default if not defined: 600

setTopicCheckNewItemInterval

public void setTopicCheckNewItemInterval(int value)

Sets the workstation option value.

Parameters:

value - the new option value

getTopicReadOnSelectChangeActivated

public boolean getTopicReadOnSelectChangeActivated()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setTopicReadOnSelectChangeActivated

public void setTopicReadOnSelectChangeActivated(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getTopicSelectedItemTimerActivated

public boolean getTopicSelectedItemTimerActivated()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setTopicSelectedItemTimerActivated

public void setTopicSelectedItemTimerActivated(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getTopicSelectedItemTimerInterval

public int getTopicSelectedItemTimerInterval()

Returns the workstation option value.

Returns:

option value. Default if not defined: 45

setTopicSelectedItemTimerInterval

public void setTopicSelectedItemTimerInterval(int value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceAutoRefresh

public boolean getWorkspaceAutoRefresh()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setWorkspaceAutoRefresh

public void setWorkspaceAutoRefresh(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceChangeScopeFolder

public boolean getWorkspaceChangeScopeFolder()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setWorkspaceChangeScopeFolder

public void setWorkspaceChangeScopeFolder(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceConfirmDelete

public boolean getWorkspaceConfirmDelete()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceConfirmDelete

public void setWorkspaceConfirmDelete(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceConfirmMove

public boolean getWorkspaceConfirmMove()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceConfirmMove

public void setWorkspaceConfirmMove(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceFalcon

public boolean getWorkspaceFalcon()

Deprecated. Use getMPXEnabled instead

Returns the workstation option value to enable mpx.

Returns:

option value. Default if not defined: true

setWorkspaceFalcon

public void setWorkspaceFalcon(boolean value)

Deprecated. Use setMPXEnabled instead

Sets the workstation option value to enable mpx.

Parameters:

value - the new option value

setMPXEnabled

public void setMPXEnabled(boolean value)

Sets the workstation option value to enable mpx.

Parameters:

value - the new option value

getMPXEnabled

public boolean getMPXEnabled()

Returns the workstation option value to enable mpx.

Returns:

option value. Default if not defined: true

getWorkspaceFolderContext

public boolean getWorkspaceFolderContext()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceFolderContext

public void setWorkspaceFolderContext(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceHistoryUTC

public boolean getWorkspaceHistoryUTC()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setWorkspaceHistoryUTC

public void setWorkspaceHistoryUTC(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceInstantRefresh

public boolean getWorkspaceInstantRefresh()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceInstantRefresh

public void setWorkspaceInstantRefresh(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceInstantRefreshMaxTime

public int getWorkspaceInstantRefreshMaxTime()

Returns the workstation option value.

Returns:

option value. Default if not defined: 30

setWorkspaceInstantRefreshMaxTime

public void setWorkspaceInstantRefreshMaxTime(int value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceInstantRefreshMinTime

public int getWorkspaceInstantRefreshMinTime()

Returns the workstation option value.

Returns:

option value. Default if not defined: 5

setWorkspaceInstantRefreshMinTime

public void setWorkspaceInstantRefreshMinTime(int value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceLogCommandDetails

public boolean getWorkspaceLogCommandDetails()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setWorkspaceLogCommandDetails

public void setWorkspaceLogCommandDetails(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceLogCommands

public boolean getWorkspaceLogCommands()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setWorkspaceLogCommands

public void setWorkspaceLogCommands(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceLogErrors

public boolean getWorkspaceLogErrors()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceLogErrors

public void setWorkspaceLogErrors(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceLogEvents

public boolean getWorkspaceLogEvents()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setWorkspaceLogEvents

public void setWorkspaceLogEvents(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceLogOutputPath

public java.lang.String getWorkspaceLogOutputPath()

Returns the workstation option value.

Returns:

option value. Default if not defined: ""

setWorkspaceLogOutputPath

public void setWorkspaceLogOutputPath(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceLogThreshold

public int getWorkspaceLogThreshold()

Returns the workstation option value.

Returns:

option value. Default if not defined: 10

setWorkspaceLogThreshold

public void setWorkspaceLogThreshold(int value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceLogUIOperations

public boolean getWorkspaceLogUIOperations()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setWorkspaceLogUIOperations

public void setWorkspaceLogUIOperations(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceMaintainGroupState

public boolean getWorkspaceMaintainGroupState()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceMaintainGroupState

public void setWorkspaceMaintainGroupState(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceRefreshTime

public boolean getWorkspaceRefreshTime()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setWorkspaceRefreshTime

public void setWorkspaceRefreshTime(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceReportOutputPath

public java.lang.String getWorkspaceReportOutputPath()

Returns the workstation option value.

Returns:

option value. Default if not defined: ""

setWorkspaceReportOutputPath

public void setWorkspaceReportOutputPath(java.lang.String value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceRestoreShortcuts

public boolean getWorkspaceRestoreShortcuts()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceRestoreShortcuts

public void setWorkspaceRestoreShortcuts(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceShowStatusBar

public boolean getWorkspaceShowStatusBar()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceShowStatusBar

public void setWorkspaceShowStatusBar(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceShowToolbars

public boolean getWorkspaceShowToolbars()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceShowToolbars

public void setWorkspaceShowToolbars(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceShowVirtualMeetingOptions

public boolean getWorkspaceShowVirtualMeetingOptions()

Returns the workstation option value.

Returns:

option value. Default if not defined: false

setWorkspaceShowVirtualMeetingOptions

public void setWorkspaceShowVirtualMeetingOptions(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getWorkspaceWarnings

public boolean getWorkspaceWarnings()

Returns the workstation option value.

Returns:

option value. Default if not defined: true

setWorkspaceWarnings

public void setWorkspaceWarnings(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class java.lang.Object

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type