Project: stp

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

All Superinterfaces:
Baseline, CcResource, CcVobResource, Resource, StpResource, Version

public interface CcBaseline
extends Baseline, CcVobResource

A proxy for a ClearCase UCM baseline.

A UCM baseline represents a snapshot of the changes made to a particular component in the context of a particular UCM stream: it is a version of a UCM component, recording a version of each element selected by the stream's configuration. The baseline also records the list of activities in the stream whose change sets contain versions of the component's elements.

UCM baseline creation differs from the standard WVCM baseline creation model and cannot currently be performed using the CM API. Instead of checking out a UCM component to create a new UCM baseline, the user performs a make baseline operation in the UCM stream. By default this operation automatically creates a new baseline for every component in that stream's configuration that has been modified in that stream since the last make baseline operation.

Every component has an initial (root) baseline, which is analogous to a ClearCase element's /main/0 version in that it is empty, and serves as the root of the baseline graph.

An import baseline contains the set of versions labeled with a particular label, and is typically used to import non-UCM versions into a UCM project.


Nested Class Summary
static interface CcBaseline.AddedActivityEx
           
static class CcBaseline.CompareFlagEx
          Boolean flags for the doCompareReportEx method.
static interface CcBaseline.DeletedActivityEx
           
static class CcBaseline.LabelingStatus
          Labeling status of this baseline.
static interface CcBaseline.PartiallyAddedActivityEx
           
static interface CcBaseline.PartiallyDeletedActivityEx
           
 
Nested classes/interfaces inherited from interface javax.wvcm.Baseline
Baseline.AddedActivity, Baseline.AddedVersion, Baseline.ChangedActivity, Baseline.ChangedVersion, Baseline.CompareFlag, Baseline.CompareReport, Baseline.DeletedActivity, Baseline.DeletedVersion, Baseline.PartiallyAddedActivity, Baseline.PartiallyDeletedActivity
 
Nested classes/interfaces inherited from interface javax.wvcm.Version
Version.Fork
 
Nested classes/interfaces inherited from interface CcVobResource
CcVobResource.ApplyAttributeFlag
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpResource
StpResource.UnsupportedProperty
 
Field Summary
static PropertyNameList.PropertyName<CcComponent> COMPONENT
          The UCM component for which this is a baseline.
static PropertyNameList.PropertyName<Boolean> IS_IMPORT
          Is this baseline an "import" baseline?
static PropertyNameList.PropertyName<Boolean> IS_INITIAL
          Is this baseline the initial baseline for its component?
static PropertyNameList.PropertyName<CcBaseline.LabelingStatus> LABELING_STATUS
          This baseline's labeling status.
static PropertyNameList.PropertyName<String> PROMOTION_LEVEL
          The promotion level of this baseline.
static PropertyNameList.PropertyName<CcStream> STREAM
          The stream in which this baseline was created.
static PropertyNameList.PropertyName<ResourceList<CcBaseline>> SUBBASELINE_LIST
          The list of sub-baselines of this composite baseline.
 
Fields inherited from interface javax.wvcm.Baseline
VERSION_LIST
 
Fields inherited from interface javax.wvcm.Version
ACTIVITY, CHECKIN_FORK, CHECKOUT_FORK, CHECKOUT_LIST, IN_BASELINE_LIST, IN_WORKSPACE_LIST, LABEL_NAME_LIST, PREDECESSOR_LIST, SUCCESSOR_LIST, VERSION_HISTORY, VERSION_NAME
 
Fields inherited from interface CcVobResource
ATTRIBUTE_LIST, CC_MASTER_REPLICA, CURRENT_REPLICA, HAS_LOCAL_MASTERSHIP, HYPERLINK_LIST, LOCK_INFO, PERMISSIONS, VOB
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpResource
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
 
Method Summary
 ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReportEx(CcBaseline baseline, CcBaseline.CompareFlagEx[] flags, Resource context, Feedback feedback)
          Compare two baselines, ClearCase-style.
 ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReportEx(CcStream stream, CcBaseline.CompareFlagEx[] flags, Resource context, Feedback feedback)
           Compare this baseline with the specified stream.
 CcComponent getComponent()
          Get the the COMPONENT property of this baseline.
 boolean getIsImport()
          Get the IS_IMPORT property of this baseline.
 boolean getIsInitial()
          Get the IS_INITIAL property of this baseline.
 CcBaseline.LabelingStatus getLabelingStatus()
          Get the LABELING_STATUS property of this baseline.
 String getPromotionLevel()
          Get the PROMOTION_LEVEL property of this baseline.
 CcStream getStream()
          Get the the STREAM property of this baseline.
 ResourceList<CcBaseline> getSubbaselineList()
          Get the SUBBASELINE_LIST property.
 void setPromotionLevel(String promotionLevel)
          Set the value of this baseline's PROMOTION_LEVEL property.
 
Methods inherited from interface javax.wvcm.Baseline
doCompareReport, doCompareReport, getVersionList
 
Methods inherited from interface javax.wvcm.Version
doAddLabel, doRemoveLabel, doSetLabel, getActivity, getCheckinFork, getCheckoutFork, getCheckoutList, getInBaselineList, getInWorkspaceList, getLabelNameList, getPredecessorList, getSuccessorList, getVersionHistory, getVersionName, setActivity, setCheckinFork, setCheckoutFork, workspaceProvider
 
Methods inherited from interface CcVobResource
doApplyAttribute, doRemoveAttribute, doRequestForMastership, getAttributeList, getCurrentReplica, getHasLocalMastership, getHyperlinkList, getLockInfo, getMasterReplica, getPermissions, getVob, setLockInfo, setPermissions
 
Methods inherited from interface CcResource
ccProvider, doResolve, isResolved
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCreatorGroupName, getCreatorLoginName, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, stpLocation, stpProvider
 

Field Detail

COMPONENT

static final PropertyNameList.PropertyName<CcComponent> COMPONENT
The UCM component for which this is a baseline.


IS_IMPORT

static final PropertyNameList.PropertyName<Boolean> IS_IMPORT
Is this baseline an "import" baseline?


IS_INITIAL

static final PropertyNameList.PropertyName<Boolean> IS_INITIAL
Is this baseline the initial baseline for its component?


LABELING_STATUS

static final PropertyNameList.PropertyName<CcBaseline.LabelingStatus> LABELING_STATUS
This baseline's labeling status. One of:
CcBaseline.LabelingStatus.NOT_LABELED
CcBaseline.LabelingStatus.INCREMENTALLY_LABELED
CcBaseline.LabelingStatus.FULLY_LABELED
CcBaseline.LabelingStatus.IS_INITIAL
CcBaseline.LabelingStatus.NO_VERSIONS_TO_LABEL


PROMOTION_LEVEL

static final PropertyNameList.PropertyName<String> PROMOTION_LEVEL
The promotion level of this baseline.

Each project VOB includes an ordered set of promotion levels that can be assigned to baselines to indicate the quality or degree of completeness of the activities and versions represented by the baseline.


STREAM

static final PropertyNameList.PropertyName<CcStream> STREAM
The stream in which this baseline was created. Will be null for "import" and "initial" baselines because they are not created in a stream context.


SUBBASELINE_LIST

static final PropertyNameList.PropertyName<ResourceList<CcBaseline>> SUBBASELINE_LIST
The list of sub-baselines of this composite baseline. As a configuration gets large, it is often useful to break it up into a set of smaller configurations that form the logical components of that configuration. The sub-baseline list of a baseline of a configuration captures the set of baselines of the component sub-configurations.

Method Detail

doCompareReportEx

ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReportEx(CcBaseline baseline,
                                                                        CcBaseline.CompareFlagEx[] flags,
                                                                        Resource context,
                                                                        Feedback feedback)
                                                                        throws WvcmException

Compare two baselines, ClearCase-style.

Parameters:
baseline - the baseline being compared to this CcBaseline.
flags - specifies the types of differences to include in the compare report.
context - optional resource (often CcView) providing context for the generation of certain properties in the returned report. May be null.
feedback - the properties available in the returned proxies.
Returns:
a ResponseIterator of CompareReport objects, that enumerate the differences between the versions selected by this CcBaseline and the baseline argument.
Throws:
WvcmException

doCompareReportEx

ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReportEx(CcStream stream,
                                                                        CcBaseline.CompareFlagEx[] flags,
                                                                        Resource context,
                                                                        Feedback feedback)
                                                                        throws WvcmException

Compare this baseline with the specified stream.

All baselines in the stream are used in the comparison as well as any changes in the stream that are not yet captured in a baseline.

Parameters:
stream - the stream being compared to this CcBaseline.
flags - specifies the types of differences to include in the compare report.
context - optional resource (often CcView) providing context for the generation of certain properties in the returned report. May be null.
feedback - the properties available in the returned proxies.
Returns:
a ResponseIterator of CompareReport objects that enumerate the differences between the versions selected by this CcBaseline and the stream argument.
Throws:
WvcmException

getComponent

CcComponent getComponent()
                         throws WvcmException
Get the the COMPONENT property of this baseline.

Returns:
a client proxy for the UCM component that this baseline is in. Will never be null.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsImport

boolean getIsImport()
                    throws WvcmException
Get the IS_IMPORT property of this baseline.

Returns:
true if this is an import baseline, else false
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsInitial

boolean getIsInitial()
                     throws WvcmException
Get the IS_INITIAL property of this baseline.

Returns:
true if this is the initial baseline for its component, else false
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getLabelingStatus

CcBaseline.LabelingStatus getLabelingStatus()
                                            throws WvcmException
Get the LABELING_STATUS property of this baseline.

Returns:
A CcBaseline.LabelingStatus enumerator indicating the labeling status of this baseline.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getPromotionLevel

String getPromotionLevel()
                         throws WvcmException
Get the PROMOTION_LEVEL property of this baseline.

Returns:
the PROMOTION_LEVEL of this baseline, as a string.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getStream

CcStream getStream()
                   throws WvcmException
Get the the STREAM property of this baseline.

Returns:
a client proxy for the UCM stream in which this baseline was created. Will be null if this is an import or initial baseline.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getSubbaselineList

ResourceList<CcBaseline> getSubbaselineList()
                                            throws WvcmException
Get the SUBBASELINE_LIST property.

Returns:
list of CcBaseline proxies for this baseline
Throws:
WvcmException - if this proxy doesn't define a value for this property.

setPromotionLevel

void setPromotionLevel(String promotionLevel)
Set the value of this baseline's PROMOTION_LEVEL property.

Parameters:
promotionLevel - the promotion level of this baseline.

Generated Sat 15-Jan-2011 04:14 AM

Copyright © IBM 2011. All rights reserved.