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. Note that it is necessary to set the CONFIG_SPEC property on the desired view proxy and write that proxy's properties in order for this change to take effect.


Method Summary
 String getCSpec()
          Returns the configuration specification minus the auto generated UCM section, if any.
 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 getLoadRulesNoComments()
          Returns the filtered load-rules section (i.e free from comments, if any) of a configuration specification.
 String getUcmElementRules()
          Returns the automatically-generated UCM section of the configuration specification.
 void setCSpec(String cspec)
          Sets the configuration specification after adding the auto generated UCM section, if any.
 void setElementRules(String elementRules)
          Sets the "Element Rules" (everything except the load rules) section of a ConfigSpec object.
 void setForceAutomaticViewUpdateFlag(boolean force)
          If true (default), element rules and load rules are updated in the config spec.
 void setLoadRules(String loadRules)
          Sets the load-rules section of a configuration specification.
 

Method Detail

getCSpec

String getCSpec()
Returns the configuration specification minus the auto generated UCM section, if any.

Returns:
the configuration specification, as a single newline-separated string.

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

getLoadRulesNoComments

String getLoadRulesNoComments()
Returns the filtered load-rules section (i.e free from comments, if any) of a configuration specification.

Returns:
the filtered 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.)

setCSpec

void setCSpec(String cspec)
Sets the configuration specification after adding the auto generated UCM section, if any. Note that it is necessary to set the CONFIG_SPEC property on the desired view proxy and write that proxy's properties in order for this change to take effect.

Parameters:
cspec - a newline-separated string representing the new load configuration specification

setElementRules

void setElementRules(String elementRules)
Sets the "Element Rules" (everything except the load rules) section of a ConfigSpec object. Config specs are manipulated through the property mechanism. For automatic views, setForceAutomaticViewUpdateFlag must be set to true for setElementRules to take effect

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

setForceAutomaticViewUpdateFlag

void setForceAutomaticViewUpdateFlag(boolean force)
If true (default), element rules and load rules are updated in the config spec. If false, only load rules are updated in the config spec.

Parameters:
force -

setLoadRules

void setLoadRules(String loadRules)
Sets the load-rules section of a configuration specification. Config specs are manipulated through the property mechanism.

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

Generated Fri 7-Aug-2015 10:46 PM

Copyright © IBM 2015. All rights reserved.