Project: stp

com.ibm.rational.wvcm.stp.cc
Interface CcConfigSpec


public interface CcConfigSpec

The configuration specification ("config spec") for a ClearCase view. A view's config spec determines which elements appear in a view, and which version of each element is selected by the view. For snapshot and web views, the config spec also determines which files are loaded in the view.

A ConfigSpec has two sections, one containing element rules and one containing load rules. Methods are provided to manipulate each of these sections.

CcView.getConfigSpec returns a ConfigSpec object. ConfigSpec objects can be passed into CcView.doSetConfigSpec to change the configuration specification of a view.


Method Summary
 String getElementRules()
          Returns the "Element Rules" section (everything except the load rules) of the configuration specification.
 String getLoadRules()
          Returns the load-rules section of a configuration specification.
 String getUcmElementRules()
          Returns the automatically-generated UCM section of the configuration specification.
 void setElementRules(String elementRules)
          Sets the "Element Rules" (everything except the load rules) section of a ConfigSpec object.
 void setForceAutomaticViewUpdateFlag(boolean force)
          Sets the flag in in order to force an automatic view update to begin on load rule changes - If true, force a load to start... if false do not.
 void setLoadRules(String loadRules)
          Sets the load-rules section of a configuration specification.
 

Method Detail

getElementRules

String getElementRules()
Returns the "Element Rules" section (everything except the load rules) of the configuration specification.

Returns:
the element rules as a single newline-separated string Returns empty string if none.

getLoadRules

String getLoadRules()
Returns the load-rules section of a configuration specification.

Returns:
the load-rules, as a single newline-separated string. Returns empty string if none (i.e. if not a snapshot view or a web view).

getUcmElementRules

String getUcmElementRules()
Returns the automatically-generated UCM section of the configuration specification.

Returns:
the UCM-generated element rules. Returns empty string if none (i.e. if not a UCM view.)

setElementRules

void setElementRules(String elementRules)
Sets the "Element Rules" (everything except the load rules) section of a ConfigSpec object. Note that the ConfigSpec object needs to be passed into CcView.doSetConfigSpec in order for the altered config spec to actually be set in a particular view.

Parameters:
elementRules - a newline-separated string representing the new element rules

setForceAutomaticViewUpdateFlag

void setForceAutomaticViewUpdateFlag(boolean force)
Sets the flag in in order to force an automatic view update to begin on load rule changes - If true, force a load to start... if false do not. The default behavior for automatic views is to NOT start an update. This method must be explicitly called by clients to initiate an update on load rule changes.

Parameters:
force -

setLoadRules

void setLoadRules(String loadRules)
Sets the load-rules section of a configuration specification. Note that the ConfigSpec object needs to be passed into CcView.doSetConfigSpec in order for the altered config spec to actually be set in a particular view.

Parameters:
loadRules - a newline-separated string representing the new load rules

Generated Thu 6-Nov-2014 11:02 PM

Copyright © IBM 2014. All rights reserved.