com.starteam
Class StarTeamClientOptions

java.lang.Object
  com.starteam.StarTeamClientOptions

public final class StarTeamClientOptions
extends java.lang.Object

Client Options maintained in the StarTeamClientOptions.xml file

Field Summary

static java.lang.String	FILE_CENTRAL_STATUS_DIRECTORY File Central Status Directory
static java.lang.String	FILE_CLEAR_LOCKS_ON_CHECK_IN Clear File Locks on Checkin
static java.lang.String	FILE_COMPARE_OPTIONS File Compare Options
static java.lang.String	FILE_COMPARE_PATH File Compare Path
static java.lang.String	FILE_DEFAULT_ENCODING Set File Default Encoding
static java.lang.String	FILE_DEFAULT_EOL Set File Default EOL
static java.lang.String	FILE_DEFAULT_STATUS_METHOD Default File Status Method
static java.lang.String	FILE_EDITOR_OPTIONS File Editor Options
static java.lang.String	FILE_EDITOR_PATH File Editor Path
static java.lang.String	FILE_LOCALDIRECTORYWATCH File Local Directory Watch
static java.lang.String	FILE_LOCK_FILES_EXCLUSIVELY_ON_CHECK_OUT Lock File Exclusively on Checkout
static java.lang.String	FILE_MARK_UNLOCKED_FILES_READ_ONLY Mark Unlocked Files Read Only
static java.lang.String	FILE_MERGE_OPTIONS File Merge Options
static java.lang.String	FILE_MERGE_PATH File Merge Path
static java.lang.String	FILE_OPTIMIZE_FOR_SLOW_CONNECTIONS Optimize File Transfer for Slow Connections
static java.lang.String	FILE_PERFORM_EOL_CONVERSION Perform File EOL Conversion
static java.lang.String	FILE_POPUP_VISMERGE_ALWAYS Always pop up VisiMerge
static java.lang.String	FILE_USE_ALTERNATE_COMPARE Use Alternate File Compare Tool
static java.lang.String	FILE_USE_ALTERNATE_EDITOR Use ALternate File Editor
static java.lang.String	FILE_USE_ALTERNATE_MERGE Use Alternate File Merge Tool
static java.lang.String	FILE_USE_MD5_TO_CALCULATE_STATUS Use MD5 to caluclate File Status
static java.lang.String	FILE_USE_MODIFIED_TIME_STAMP Use Modified File Time Stamp to calculate Status
static java.lang.String	FILE_USE_NON_EXCLUSIVE_LOCKS_IN_INTEGRATIONS Use non exclusive file locks in integrations
static java.lang.String	WORKSPACE_AUTO_REFRESH Auto Refresh Rate
static java.lang.String	WORKSPACE_CHANGE_SCOPE_FOLDER Change Scope Folder
static java.lang.String	WORKSPACE_CONFIRM_DELETE Confirm Delete
static java.lang.String	WORKSPACE_CONFIRM_MOVE Confirm Move
static java.lang.String	WORKSPACE_FALCON Select MPX
static java.lang.String	WORKSPACE_FOLDER_CONTEXT Folder Context
static java.lang.String	WORKSPACE_HISTORY_UTC History UTC
static java.lang.String	WORKSPACE_INSTANT_REFRESH Instant Refresh
static java.lang.String	WORKSPACE_INSTANT_REFRESH_MAX_TIME Instant Refresh Maximum Time
static java.lang.String	WORKSPACE_INSTANT_REFRESH_MIN_TIME Instant Refresh Minimum Time
static java.lang.String	WORKSPACE_LOG_COMMAND_DETAILS Log Command Details
static java.lang.String	WORKSPACE_LOG_COMMANDS Log Commands
static java.lang.String	WORKSPACE_LOG_ERRORS Log Errors
static java.lang.String	WORKSPACE_LOG_EVENTS Log Events
static java.lang.String	WORKSPACE_LOG_OUTPUT_PATH Log Output Path
static java.lang.String	WORKSPACE_LOG_THRESHOLD Log Threshold
static java.lang.String	WORKSPACE_LOG_UI_OPERATIONS Log UI Operations
static java.lang.String	WORKSPACE_MAINTAIN_GROUP_STATE Maintain Group State
static java.lang.String	WORKSPACE_REFRESH_TIME Refresh Time
static java.lang.String	WORKSPACE_REPORT_OUTPUT_PATH Report Output Path
static java.lang.String	WORKSPACE_RESTORE_SHORTCUTS Restore Shortcuts
static java.lang.String	WORKSPACE_SHOW_STATUSBAR Show Status Bar
static java.lang.String	WORKSPACE_SHOW_TOOLBARS Show Tool Bars
static java.lang.String	WORKSPACE_SHOW_VIRTUAL_MEETING_OPTIONS Show Virtual Meeting Options
static java.lang.String	WORKSPACE_WARNINGS Show 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

ViewMemberCollection	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 used for storing centralized status information.
boolean	getCheckNewItemActivated(java.lang.String componentName) Returns the workstation option value.
int	getCheckNewItemInterval(java.lang.String componentName) Returns the workstation option value.
java.lang.String[]	getComponentNames() Gets the names of all components for which at least one option has been set.
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() The default status method to be used by the client.
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.
Encoding	getFileDefaultEncoding() Returns the workstation option value.
int	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.
java.lang.String	getFolderAlternatePath(GUID repository, int folderID) 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	getFolderAlternatePathEnabled(GUID repository, int folderID) 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	getFolderUserVisible(GUID repository, int folderID) 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.
java.lang.String[]	getOptionNames(java.lang.String componentName) Gets the names of all options that have been set for a given component.
Item	getProcessItem(View target) Gets the current process item in the given target view.
boolean	getReadOnSelectChangeActivated(java.lang.String componentName) Returns the workstation option value.
boolean	getSelectedItemTimerActivated(java.lang.String componentName) Returns the workstation option value.
int	getSelectedItemTimerInterval(java.lang.String componentName) Returns the workstation option value.
java.lang.String	getViewAlternatePath(GUID repository, int viewID) Returns the alternate working directory for the specified view.
java.lang.String	getViewAlternatePath(View view) Returns the alternate working directory for the specified view.
boolean	getViewAlternatePathEnabled(GUID repository, int viewID) Return true if the alternate working directory is enabled for this 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	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.
int	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.
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.
boolean	reloadIfNeeded() Re-loads the file only if its last modified time stamp has changed.
void	save() Writes the options to the underlying file.
void	saveTo(java.io.File newfile) Saves the options to the new file.
void	setCentralStatusDirectory(java.lang.String path) Set the path to be used for storing centralized status information.
void	setCheckNewItemActivated(java.lang.String componentName, boolean value) Sets the workstation option value.
void	setCheckNewItemInterval(java.lang.String componentName, 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(Encoding value) Sets the workstation option value.
void	setFileDefaultEOL(int 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	setFolderAlternatePath(GUID repository, int folderID, 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	setFolderAlternatePathEnabled(GUID repository, int folderID, 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	setFolderUserVisible(GUID repository, int folderID, 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, View target) Sets the current process item for the given target view.
void	setReadOnSelectChangeActivated(java.lang.String componentName, boolean value) Sets the workstation option value.
void	setSelectedItemTimerActivated(java.lang.String componentName, boolean value) Sets the workstation option value.
void	setSelectedItemTimerInterval(java.lang.String componentName, int value) Sets the workstation option value.
void	setViewAlternatePath(GUID repository, int viewID, java.lang.String path) Change the option value stored for the specified View's alternate working directory.
void	setViewAlternatePath(View view, java.lang.String path) Change the option value stored for the specified View's alternate working directory.
void	setViewAlternatePathEnabled(GUID repository, int viewID, boolean enabled) Change whether or not the alternate working directory should be used for the specified view.
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	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(int 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

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

Field Detail

FILE_CLEAR_LOCKS_ON_CHECK_IN

public static final java.lang.String FILE_CLEAR_LOCKS_ON_CHECK_IN

Clear File Locks on Checkin

See Also:

Constant Field Values

FILE_COMPARE_OPTIONS

public static final java.lang.String FILE_COMPARE_OPTIONS

File Compare Options

See Also:

Constant Field Values

FILE_COMPARE_PATH

public static final java.lang.String FILE_COMPARE_PATH

File Compare Path

See Also:

Constant Field Values

FILE_EDITOR_PATH

public static final java.lang.String FILE_EDITOR_PATH

File Editor Path

See Also:

Constant Field Values

FILE_EDITOR_OPTIONS

public static final java.lang.String FILE_EDITOR_OPTIONS

File Editor Options

See Also:

Constant Field Values

FILE_LOCALDIRECTORYWATCH

public static final java.lang.String FILE_LOCALDIRECTORYWATCH

File Local Directory Watch

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

Lock File Exclusively on Checkout

See Also:

Constant Field Values

FILE_MARK_UNLOCKED_FILES_READ_ONLY

public static final java.lang.String FILE_MARK_UNLOCKED_FILES_READ_ONLY

Mark Unlocked Files Read Only

See Also:

Constant Field Values

FILE_MERGE_OPTIONS

public static final java.lang.String FILE_MERGE_OPTIONS

File Merge Options

See Also:

Constant Field Values

FILE_MERGE_PATH

public static final java.lang.String FILE_MERGE_PATH

File Merge Path

See Also:

Constant Field Values

FILE_OPTIMIZE_FOR_SLOW_CONNECTIONS

public static final java.lang.String FILE_OPTIMIZE_FOR_SLOW_CONNECTIONS

Optimize File Transfer for Slow Connections

See Also:

Constant Field Values

FILE_POPUP_VISMERGE_ALWAYS

public static final java.lang.String FILE_POPUP_VISMERGE_ALWAYS

Always pop up VisiMerge

See Also:

Constant Field Values

FILE_USE_ALTERNATE_COMPARE

public static final java.lang.String FILE_USE_ALTERNATE_COMPARE

Use Alternate File Compare Tool

See Also:

Constant Field Values

FILE_USE_ALTERNATE_EDITOR

public static final java.lang.String FILE_USE_ALTERNATE_EDITOR

Use ALternate File Editor

See Also:

Constant Field Values

FILE_USE_ALTERNATE_MERGE

public static final java.lang.String FILE_USE_ALTERNATE_MERGE

Use Alternate File Merge Tool

See Also:

Constant Field Values

FILE_USE_MD5_TO_CALCULATE_STATUS

public static final java.lang.String FILE_USE_MD5_TO_CALCULATE_STATUS

Use MD5 to caluclate File Status

See Also:

Constant Field Values

FILE_USE_MODIFIED_TIME_STAMP

public static final java.lang.String FILE_USE_MODIFIED_TIME_STAMP

Use Modified File Time Stamp to calculate Status

See Also:

Constant Field Values

FILE_PERFORM_EOL_CONVERSION

public static final java.lang.String FILE_PERFORM_EOL_CONVERSION

Perform File EOL Conversion

See Also:

Constant Field Values

FILE_DEFAULT_EOL

public static final java.lang.String FILE_DEFAULT_EOL

Set File Default EOL

See Also:

Constant Field Values

FILE_DEFAULT_ENCODING

public static final java.lang.String FILE_DEFAULT_ENCODING

Set 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

Use non exclusive file locks in integrations

See Also:

Constant Field Values

FILE_DEFAULT_STATUS_METHOD

public static final java.lang.String FILE_DEFAULT_STATUS_METHOD

Default File Status Method

See Also:

Constant Field Values

FILE_CENTRAL_STATUS_DIRECTORY

public static final java.lang.String FILE_CENTRAL_STATUS_DIRECTORY

File Central Status Directory

See Also:

Constant Field Values

WORKSPACE_AUTO_REFRESH

public static final java.lang.String WORKSPACE_AUTO_REFRESH

Auto Refresh Rate

See Also:

Constant Field Values

WORKSPACE_CHANGE_SCOPE_FOLDER

public static final java.lang.String WORKSPACE_CHANGE_SCOPE_FOLDER

Change Scope Folder

See Also:

Constant Field Values

WORKSPACE_CONFIRM_DELETE

public static final java.lang.String WORKSPACE_CONFIRM_DELETE

Confirm Delete

See Also:

Constant Field Values

WORKSPACE_CONFIRM_MOVE

public static final java.lang.String WORKSPACE_CONFIRM_MOVE

Confirm Move

See Also:

Constant Field Values

WORKSPACE_FALCON

public static final java.lang.String WORKSPACE_FALCON

Select MPX

See Also:

Constant Field Values

WORKSPACE_FOLDER_CONTEXT

public static final java.lang.String WORKSPACE_FOLDER_CONTEXT

Folder Context

See Also:

Constant Field Values

WORKSPACE_HISTORY_UTC

public static final java.lang.String WORKSPACE_HISTORY_UTC

History UTC

See Also:

Constant Field Values

WORKSPACE_INSTANT_REFRESH

public static final java.lang.String WORKSPACE_INSTANT_REFRESH

Instant Refresh

See Also:

Constant Field Values

WORKSPACE_INSTANT_REFRESH_MAX_TIME

public static final java.lang.String WORKSPACE_INSTANT_REFRESH_MAX_TIME

Instant Refresh Maximum Time

See Also:

Constant Field Values

WORKSPACE_INSTANT_REFRESH_MIN_TIME

public static final java.lang.String WORKSPACE_INSTANT_REFRESH_MIN_TIME

Instant Refresh Minimum Time

See Also:

Constant Field Values

WORKSPACE_LOG_COMMAND_DETAILS

public static final java.lang.String WORKSPACE_LOG_COMMAND_DETAILS

Log Command Details

See Also:

Constant Field Values

WORKSPACE_LOG_COMMANDS

public static final java.lang.String WORKSPACE_LOG_COMMANDS

Log Commands

See Also:

Constant Field Values

WORKSPACE_LOG_ERRORS

public static final java.lang.String WORKSPACE_LOG_ERRORS

Log Errors

See Also:

Constant Field Values

WORKSPACE_LOG_EVENTS

public static final java.lang.String WORKSPACE_LOG_EVENTS

Log Events

See Also:

Constant Field Values

WORKSPACE_LOG_OUTPUT_PATH

public static final java.lang.String WORKSPACE_LOG_OUTPUT_PATH

Log Output Path

See Also:

Constant Field Values

WORKSPACE_LOG_THRESHOLD

public static final java.lang.String WORKSPACE_LOG_THRESHOLD

Log Threshold

See Also:

Constant Field Values

WORKSPACE_LOG_UI_OPERATIONS

public static final java.lang.String WORKSPACE_LOG_UI_OPERATIONS

Log UI Operations

See Also:

Constant Field Values

WORKSPACE_MAINTAIN_GROUP_STATE

public static final java.lang.String WORKSPACE_MAINTAIN_GROUP_STATE

Maintain Group State

See Also:

Constant Field Values

WORKSPACE_REFRESH_TIME

public static final java.lang.String WORKSPACE_REFRESH_TIME

Refresh Time

See Also:

Constant Field Values

WORKSPACE_REPORT_OUTPUT_PATH

public static final java.lang.String WORKSPACE_REPORT_OUTPUT_PATH

Report Output Path

See Also:

Constant Field Values

WORKSPACE_RESTORE_SHORTCUTS

public static final java.lang.String WORKSPACE_RESTORE_SHORTCUTS

Restore Shortcuts

See Also:

Constant Field Values

WORKSPACE_SHOW_STATUSBAR

public static final java.lang.String WORKSPACE_SHOW_STATUSBAR

Show Status Bar

See Also:

Constant Field Values

WORKSPACE_SHOW_TOOLBARS

public static final java.lang.String WORKSPACE_SHOW_TOOLBARS

Show Tool Bars

See Also:

Constant Field Values

WORKSPACE_SHOW_VIRTUAL_MEETING_OPTIONS

public static final java.lang.String WORKSPACE_SHOW_VIRTUAL_MEETING_OPTIONS

Show Virtual Meeting Options

See Also:

Constant Field Values

WORKSPACE_WARNINGS

public static final java.lang.String WORKSPACE_WARNINGS

Show 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.

Returns:

the singleton default StarTeamClientOptions object

Throws:

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 "StarTeamClientOptions.xml" in the user's home directory.

Returns:

the default StarTeamClientOptions file

Throws:

java.io.IOException

loadDefault

public void loadDefault()
                 throws java.io.IOException

Loads the options from the default file.

Throws:

java.io.IOException

save

public void save()
          throws java.io.IOException

Writes the options to the underlying file.

Throws:

java.io.IOException

saveTo

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

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

Parameters:

newfile - the new file to which the options will be saved

Throws:

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.

Parameters:

file - the file from which the options will be loaded

Throws:

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 boolean reloadIfNeeded()
                       throws java.io.IOException

Re-loads the file only if its last modified time stamp has changed. Returns true if the file was reloaded, false if not.

Returns:

true if the file was re-loaded

Throws:

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

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

Returns:

the specified workstation option

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 overridden

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

See Also:

View.setStatusMethodOverride(com.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

Returns:

Status method object

See Also:

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

setCentralStatusDirectory

public void setCentralStatusDirectory(java.lang.String path)

Set the path to be used 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 used for storing centralized status information. If not set in this options file this will return a default location.

Returns:

path for storing centralized status.

Throws:

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

The default status method to be used by the client.

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,
                           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 ViewMemberCollection 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:

ViewMemberCollection 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 overridden

path - the new alternate working directory for the view

setViewAlternatePath

public void setViewAlternatePath(GUID repository,
                                 int viewID,
                                 java.lang.String path)

Change the option value stored for the specified View's alternate working directory.

Parameters:

repository - the GUID of the StarTeam server

viewID - the view whose alternate working directory path is to be overridden

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 overridden

enabled - true if the alternate path is to be applied

setViewAlternatePathEnabled

public void setViewAlternatePathEnabled(GUID repository,
                                        int viewID,
                                        boolean enabled)

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

Parameters:

repository - the GUID of the StarTeam server

viewID - the view whose alternate working directory path is to be overridden

enabled - true if the alternate path is to be applied

setFolderAlternatePath

public void setFolderAlternatePath(GUID repository,
                                   int folderID,
                                   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:

repository - the GUID of the StarTeam server

folderID - the folder whose working directory is to be overridden

path - the new alternate working directory for the folder

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 overridden

path - the new alternate working directory for the folder

setFolderAlternatePathEnabled

public void setFolderAlternatePathEnabled(GUID repository,
                                          int folderID,
                                          boolean enabled)

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

Parameters:

repository - the GUID of the StarTeam server

folderID - the folder whose working directory is to be overridden

enabled - true if the alternate path is to be applied

setFolderAlternatePathEnabled

public void setFolderAlternatePathEnabled(Folder folder,
                                          boolean enabled)

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

Parameters:

folder - the folder whose working directory is to be overridden

enabled - true if the alternate path is to be applied

setFolderUserVisible

public void setFolderUserVisible(GUID repository,
                                 int folderID,
                                 boolean visible)

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

Parameters:

repository - the GUID of the StarTeam server

folderID - the folder whose working directory is to be overridden

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

See Also:

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

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 overridden

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

See Also:

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

getViewAlternatePath

public java.lang.String getViewAlternatePath(GUID repository,
                                             int viewID)

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

Parameters:

repository - the GUID of the StarTeam server

Returns:

alternate working directory for the specified view

getViewAlternatePath

public java.lang.String getViewAlternatePath(View view)

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

Parameters:

view - the view whose alternate working directory path is required

Returns:

alternate working directory for the given view

getViewAlternatePathEnabled

public boolean getViewAlternatePathEnabled(GUID repository,
                                           int viewID)

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

Parameters:

repository - the GUID of the StarTeam server

viewID - the view to be checked

Returns:

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

getViewAlternatePathEnabled

public boolean getViewAlternatePathEnabled(View view)

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

Parameters:

view - the view to be checked

Returns:

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.

Parameters:

folder - the folder whose alternate working directory path is desired

Returns:

alternate working directory for the given folder

getFolderAlternatePath

public java.lang.String getFolderAlternatePath(GUID repository,
                                               int folderID)

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

Parameters:

repository - the GUID of the StarTeam server

folderID - the folder whose alternate working directory path is required

Returns:

alternate working directory for the given folder

getFolderAlternatePathEnabled

public boolean getFolderAlternatePathEnabled(GUID repository,
                                             int folderID)

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

Parameters:

repository - the GUID of the StarTeam server

folderID - the folder whose alternate working directory path is required

Returns:

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

getFolderAlternatePathEnabled

public boolean getFolderAlternatePathEnabled(Folder folder)

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

Parameters:

folder - the folder to check

Returns:

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 visibility is to be determined

Returns:

true if this Folder is user visible.

See Also:

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

getFolderUserVisible

public boolean getFolderUserVisible(GUID repository,
                                    int folderID)

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

Parameters:

repository - the GUID of the StarTeam server

folderID - the folder whose alternate working directory path is required

Returns:

true if this Folder is user visible.

See Also:

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

getCheckNewItemActivated

public boolean getCheckNewItemActivated(java.lang.String componentName)

Returns the workstation option value.

Parameters:

componentName - the component for which this option is being set

Returns:

option value. Default if not defined: true

setCheckNewItemActivated

public void setCheckNewItemActivated(java.lang.String componentName,
                                     boolean value)

Sets the workstation option value.

Parameters:

componentName - the component for which this option is being set

value - the new option value

getCheckNewItemInterval

public int getCheckNewItemInterval(java.lang.String componentName)

Returns the workstation option value.

Parameters:

componentName - the component for which this option is being set

Returns:

option value. Default if not defined: 600

setCheckNewItemInterval

public void setCheckNewItemInterval(java.lang.String componentName,
                                    int value)

Sets the workstation option value.

Parameters:

componentName - the component for which this option is being set

value - the new option value

getReadOnSelectChangeActivated

public boolean getReadOnSelectChangeActivated(java.lang.String componentName)

Returns the workstation option value.

Parameters:

componentName - the component for which this option is being set

Returns:

option value. Default if not defined: false

setReadOnSelectChangeActivated

public void setReadOnSelectChangeActivated(java.lang.String componentName,
                                           boolean value)

Sets the workstation option value.

Parameters:

componentName - the component for which this option is being set

value - the new option value

getSelectedItemTimerActivated

public boolean getSelectedItemTimerActivated(java.lang.String componentName)

Returns the workstation option value.

Parameters:

componentName - the component for which this option is being set

Returns:

option value. Default if not defined: false

setSelectedItemTimerActivated

public void setSelectedItemTimerActivated(java.lang.String componentName,
                                          boolean value)

Sets the workstation option value.

Parameters:

componentName - the component for which this option is being set

value - the new option value

getSelectedItemTimerInterval

public int getSelectedItemTimerInterval(java.lang.String componentName)

Returns the workstation option value.

Parameters:

componentName - the component for which this option is being set

Returns:

option value. Default if not defined: 45

setSelectedItemTimerInterval

public void setSelectedItemTimerInterval(java.lang.String componentName,
                                         int value)

Sets the workstation option value.

Parameters:

componentName - the component for which this option is being set

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 Encoding 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(Encoding 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: true

setFilePerformEOLConversion

public void setFilePerformEOLConversion(boolean value)

Sets the workstation option value.

Parameters:

value - the new option value

getFileDefaultEOL

public int getFileDefaultEOL()

Returns the workstation option value.

Returns:

option value. Default if not defined: the platform definition of EOL

See Also:

LineReader.EOL_CRLF, LineReader.EOL_CR, LineReader.EOL_LF

setFileDefaultEOL

public void setFileDefaultEOL(int value)

Sets the workstation option value. For backward compatibility with earlier versions of the SDK, stores the mnemonic string "CRLF", "CR" or "LF" in the config file

Parameters:

value - the new option value

See Also:

LineReader.EOL_CRLF, LineReader.EOL_CR, LineReader.EOL_LF

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

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

getMPXEnabled

public boolean getMPXEnabled()

Returns the workstation option value to enable MPX

Returns:

option value. Default if not defined: true

setMPXEnabled

public void setMPXEnabled(boolean value)

Sets the workstation option value to enable MPX

Parameters:

value - the new option value

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 int getWorkspaceRefreshTime()

Returns the workstation option value.

Returns:

option value.

setWorkspaceRefreshTime

public void setWorkspaceRefreshTime(int 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

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

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

Returns:

the specified workstation option

getComponentNames

public java.lang.String[] getComponentNames()

Gets the names of all components for which at least one option has been set.

Returns:

The names of all components for which at least one option has been set.

getOptionNames

public java.lang.String[] getOptionNames(java.lang.String componentName)

Gets the names of all options that have been set for a given component.

Parameters:

componentName - A component name.

Returns:

The names of all options that have been set for the given component.