|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CcBaseline
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 class |
CcBaseline.MakeCcBaselinesFlag
Flags for the doMakeCcBaselines method. |
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 |
Nested classes/interfaces inherited from interface javax.wvcm.Resource |
---|
Resource.CopyFlag |
Field Summary | |
---|---|
static PropertyNameList.PropertyName<ResourceList<CcActivity>> |
ACTIVITY_LIST
A write-only property used to specify the activities to be included in a new baseline. |
static PropertyNameList.PropertyName<CcComponent> |
COMPONENT
The UCM component for which this is a baseline. |
static PropertyNameList.PropertyName<ResourceList<CcComponent>> |
COMPONENT_LIST
A write-only property used to specify the components for which baselines are created. |
static PropertyNameList.PropertyName<Boolean> |
IS_COMPOSITE
Is this baseline a composite 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. |
static PropertyNameList.PropertyName<Workspace> |
WORKSPACE
A write-only property which specifies the workspace which will be used to create baselines. |
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 |
Fields inherited from interface javax.wvcm.Resource |
---|
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST |
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. |
ResourceList<CcBaseline> |
doMakeCcBaselines(CcBaseline.MakeCcBaselinesFlag[] flags,
Feedback feedback)
Create a new UCM baseline using the name segment of the client-specified location as the root portion of the baseline name. |
CcComponent |
getComponent()
Get the the COMPONENT property of this baseline. |
boolean |
getIsComposite()
Get the IS_COMPOSITE 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 |
setActivityList(ResourceList<CcActivity> activityList)
Set the value of this proxy's ACTIVITY_LIST property. |
void |
setComponentList(ResourceList<CcComponent> componentList)
Set the value of this proxy's COMPONENT_LIST property. |
void |
setLabelingStatus(CcBaseline.LabelingStatus labelingStatus)
Set the value of this baseline's LABELING_STATUS property. |
void |
setPromotionLevel(String promotionLevel)
Set the value of this baseline's PROMOTION_LEVEL property. |
void |
setStream(CcStream stream)
Set the value of this proxy's STREAM property. |
void |
setWorkspace(Workspace workspace)
Set the value of this proxy's WORKSPACE 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, hasSupportedProperties, 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, setPropertyClean, stpLocation, stpProvider |
Field Detail |
---|
static final PropertyNameList.PropertyName<ResourceList<CcActivity>> ACTIVITY_LIST
static final PropertyNameList.PropertyName<CcComponent> COMPONENT
static final PropertyNameList.PropertyName<ResourceList<CcComponent>> COMPONENT_LIST
static final PropertyNameList.PropertyName<Boolean> IS_COMPOSITE
static final PropertyNameList.PropertyName<Boolean> IS_IMPORT
static final PropertyNameList.PropertyName<Boolean> IS_INITIAL
static final PropertyNameList.PropertyName<CcBaseline.LabelingStatus> LABELING_STATUS
CcBaseline.LabelingStatus.NOT_LABELED
CcBaseline.LabelingStatus.INCREMENTALLY_LABELED
CcBaseline.LabelingStatus.FULLY_LABELED
CcBaseline.LabelingStatus.IS_INITIAL
CcBaseline.LabelingStatus.NO_VERSIONS_TO_LABEL
static final PropertyNameList.PropertyName<String> PROMOTION_LEVEL
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.
static final PropertyNameList.PropertyName<CcStream> STREAM
static final PropertyNameList.PropertyName<ResourceList<CcBaseline>> SUBBASELINE_LIST
static final PropertyNameList.PropertyName<Workspace> WORKSPACE
STREAM
property.
Method Detail |
---|
ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReportEx(CcBaseline baseline, CcBaseline.CompareFlagEx[] flags, Resource context, Feedback feedback) throws WvcmException
Compare two baselines, ClearCase-style.
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.
WvcmException
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.
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.
WvcmException
ResourceList<CcBaseline> doMakeCcBaselines(CcBaseline.MakeCcBaselinesFlag[] flags, Feedback feedback) throws WvcmException
Create a new UCM baseline using the name segment of the client-specified location as the root portion of the baseline name. This interface does not support the use of baseline naming templates.
The STREAM
property should be used to specify the stream
on which the baseline(s) will be created. It is required unless
the WORKSPACE
property is set.
The WORKSPACE
property can be used to specify the workspace which
will be used to create baselines. Baselines are created in the stream
that the workspace is attached to. Setting this overrides setting
of the STREAM
property.
The following two properties are mutually exclusive:
COMPONENT_LIST
property is used to specify the components for
which baselines are created.ACTIVITY_LIST
property is used to specify the activities to be
included in a new baseline.
The LABELING_STATUS
property can be used to specify whether the
baseline(s) should be unlabeled, incrementally labeled or full labeled.
You may also set the following additional baseline properties prior to
calling this method:
Resource.COMMENT
flags
- Resource-specific creation flags.
WvcmException
CcComponent getComponent() throws WvcmException
COMPONENT
property of this baseline.
WvcmException
- if this proxy doesn't define a value for this property.boolean getIsComposite() throws WvcmException
IS_COMPOSITE
property of this baseline.
WvcmException
- if this proxy doesn't define a value for this property.boolean getIsImport() throws WvcmException
IS_IMPORT
property of this baseline.
WvcmException
- if this proxy doesn't define a value for this property.boolean getIsInitial() throws WvcmException
IS_INITIAL
property of this baseline.
WvcmException
- if this proxy doesn't define a value for this property.CcBaseline.LabelingStatus getLabelingStatus() throws WvcmException
LABELING_STATUS
property of this baseline.
CcBaseline.LabelingStatus
enumerator indicating the labeling
status of this baseline.
WvcmException
- if this proxy doesn't define a value for this property.String getPromotionLevel() throws WvcmException
PROMOTION_LEVEL
property of this baseline.
PROMOTION_LEVEL
of this baseline, as a string.
WvcmException
- if this proxy doesn't define a value for this property.CcStream getStream() throws WvcmException
STREAM
property of this baseline.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcBaseline> getSubbaselineList() throws WvcmException
SUBBASELINE_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.void setActivityList(ResourceList<CcActivity> activityList) throws WvcmException
ACTIVITY_LIST
property.
This property can only be set at baseline creation time for use
by the doMakeCcBaselines(MakeCcBaselinesFlag[], Feedback)
method.
activityList
- List of activities to be used for baseline creation.
WvcmException
void setComponentList(ResourceList<CcComponent> componentList) throws WvcmException
COMPONENT_LIST
property.
This property can only be set at baseline creation time for use
by the doMakeCcBaselines(MakeCcBaselinesFlag[], Feedback)
method.
componentList
- List of components to be used for baseline creation.
WvcmException
void setLabelingStatus(CcBaseline.LabelingStatus labelingStatus)
LABELING_STATUS
property.
labelingStatus
- new labeling status for this baseline.
The only valid values are CcBaseline.LabelingStatus.INCREMENTALLY_LABELED
(if
the current labeling status is CcBaseline.LabelingStatus.NOT_LABELED
) or
CcBaseline.LabelingStatus.FULLY_LABELED
(if the current labeling status
is CcBaseline.LabelingStatus.NOT_LABELED
or
CcBaseline.LabelingStatus.INCREMENTALLY_LABELED
).
When used on a composite baseline, the specified change is applied recursively
to its member baselines.
Can also be set at creation time to specify the labeling status of
baselines(s) created via the doMakeCcBaselines(MakeCcBaselinesFlag[], Feedback)
method.void setPromotionLevel(String promotionLevel)
PROMOTION_LEVEL
property.
promotionLevel
- the promotion level of this baseline.void setStream(CcStream stream) throws WvcmException
STREAM
property.
This property can only be set at baseline creation time for use
by the doMakeCcBaselines(MakeCcBaselinesFlag[], Feedback)
method.
stream
- Stream on which the new baseline should be created
WvcmException
void setWorkspace(Workspace workspace) throws WvcmException
WORKSPACE
property.
This property can only be set at baseline creation time for use
by the doMakeCcBaselines(MakeCcBaselinesFlag[], Feedback)
method.
workspace
- Workspace which will be used to create baselines.
WvcmException
|
Generated Tue 14-Jul-2015 08:49 PM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |