com.starteam
Class Application.ResolveOptions

java.lang.Object
  extended by com.starteam.Application.ResolveOptions
Enclosing class:
Application

public static final class Application.ResolveOptions
extends java.lang.Object

Options that control the behavior of an Application's resolve operations.

See Also:
Application.resolveServer(String,int,String,String), Application.resolveProject(Server,int), Application.resolveProject(Server,String), Application.resolveView(Project,int), Application.resolveView(Project,String)

Method Summary
 boolean isAutoLogonEnabled()
          Determines whether or not autologon is enabled in Application.resolveServer().
 boolean isAutoRefreshProjectsEnabled()
          Determines whether or not auto-refresh is enabled for projects.
 boolean isAutoRefreshViewsEnabled()
          Determines whether or not auto-refresh is enabled for views.
 void setAutoLogonEnabled(boolean isEnabled)
          Enables or disabled autologon in Application.resolveServer().
 void setAutoRefreshAllEnabled(boolean isEnabled)
          Enables or disabled auto-refresh for all supported resource types.
 void setAutoRefreshProjectsEnabled(boolean isEnabled)
          Enables or disabled auto-refresh for projects.
 void setAutoRefreshViewsEnabled(boolean isEnabled)
          Enables or disabled auto-refresh for views.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isAutoLogonEnabled

public final boolean isAutoLogonEnabled()
Determines whether or not autologon is enabled in Application.resolveServer().

If autologon is enabled, and resolveServer() cannot find a matching server in the application's server collection, then an attempt is made to create a new server instance that is logged in via Server.autoLogOn().

Autologon is disabled by default.

Returns:
true if autologon is enabled, and false otherwise.
See Also:
Application.resolveServer(String,int,String,String)

setAutoLogonEnabled

public final void setAutoLogonEnabled(boolean isEnabled)
Enables or disabled autologon in Application.resolveServer().

If autologon is enabled, and resolveServer() cannot find a matching server in the application's server collection, then an attempt is made to create a new server instance that is logged in via Server.autoLogOn().

Autologon is disabled by default.

Parameters:
isEnabled - true to enable autologon, or false to disable it.

setAutoRefreshAllEnabled

public final void setAutoRefreshAllEnabled(boolean isEnabled)
Enables or disabled auto-refresh for all supported resource types.

If a requested resource is not found in the appropriate collection, and auto-refresh is enabled for that resource, then the collection is automatically refreshed to match the latest resources in the repository, and the search is repeated.

Auto-refresh is disabled by default.

Parameters:
isEnabled - true to enable auto-refresh, or false to disable it.

isAutoRefreshProjectsEnabled

public final boolean isAutoRefreshProjectsEnabled()
Determines whether or not auto-refresh is enabled for projects.

If a requested project is not found in a server's project collection, and auto-refresh is enabled for projects, then the collection is automatically refreshed to match the latest projects in the repository, and the search is repeated.

Auto-refresh is disabled by default.

Returns:
true if auto-refresh is enabled for projects, and false otherwise.
See Also:
Application.resolveProject(Server,int), Application.resolveProject(Server,String)

setAutoRefreshProjectsEnabled

public final void setAutoRefreshProjectsEnabled(boolean isEnabled)
Enables or disabled auto-refresh for projects.

If a requested project is not found in a server's project collection, and auto-refresh is enabled for projects, then the collection is automatically refreshed to match the latest projects in the repository, and the search is repeated.

Auto-refresh is disabled by default.

Parameters:
isEnabled - true to enable auto-refresh, or false to disable it.

isAutoRefreshViewsEnabled

public final boolean isAutoRefreshViewsEnabled()
Determines whether or not auto-refresh is enabled for views.

If a requested view is not found in a project's view collection, and auto-refresh is enabled for views, then the collection is automatically refreshed to match the latest views in the repository, and the search is repeated.

Auto-refresh is disabled by default.

Returns:
true if auto-refresh is enabled for views, and false otherwise.
See Also:
Application.resolveView(Project,int), Application.resolveView(Project,String), Application.resolveView(Project,int), Application.resolveView(Project,String)

setAutoRefreshViewsEnabled

public final void setAutoRefreshViewsEnabled(boolean isEnabled)
Enables or disabled auto-refresh for views.

If a requested view is not found in a project's view collection, and auto-refresh is enabled for views, then the collection is automatically refreshed to match the latest views in the repository, and the search is repeated.

Auto-refresh is disabled by default.

Parameters:
isEnabled - true to enable auto-refresh, or false to disable it.


StarTeam SDK 14.0, Build 21
Copyright © 2003-2012 Borland Software Corporation. All rights reserved.