Project: stp

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

All Superinterfaces:
CcResource, CcVobResource, Resource, StpResource, Version
All Known Subinterfaces:
CcDirectoryVersion

public interface CcVersion
extends Version, CcVobResource

A proxy for a version of a ClearCase element.

Each time a new revision of a version-controlled file or directory is checked in, a new version of that element is created. Versions are created, in sequence, on the branch of an element selected by the view's config spec.

For more information about version, see the ClearCase "Guide to Developing Software" manual.

See Also:
CcBranch, CcElement, CcConfigSpec, CcBranchType

Nested Class Summary
 
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<CcBranch> BRANCH
          This version's branch.
static PropertyNameList.PropertyName<CcElement> ELEMENT
          This version's element.
static PropertyNameList.PropertyName<ResourceList<CcVersion>> MERGE_CONTRIBUTOR_LIST
           The list of versions that were merged to create this version.
static PropertyNameList.PropertyName<CcVersion> PREDECESSOR
           The immediate predecessor of this version on this version's branch, or if this is the first version on the branch, the version from which the branch emanates.
static PropertyNameList.PropertyName<String> VIEW_RELATIVE_PATH
           The view-relative path for this version, possibly including the version extension.
 
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
 Version doAddLabel(String label, CcView view, Feedback feedback)
          Add the specified label to the version.
 CcVersion doCreateMergeArrow(CcVersion toVersion, Feedback feedback)
          Create a Merge hyperlink pointing from this version to the specified destination version.
 Version doRemoveLabel(String label, CcView view, Feedback feedback)
          Remove the specified label from the version.
 Version doSetLabel(String label, CcView view, Feedback feedback)
          Set the specified label on the version.
 CcBranch getBranch()
          Get the value of this version's BRANCH property.
 CcElement getElement()
          Get the value of this version's ELEMENT property.
 ResourceList<CcVersion> getMergeContributorList()
          Get the value of this version's MERGE_CONTRIBUTOR_LIST property.
 CcVersion getPredecessor()
          Get the value of this version's PREDECESSOR property.
 String getViewRelativePath()
          Get the value of this version's VIEW_RELATIVE_PATH property.
 
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, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, stpLocation, stpProvider
 

Field Detail

BRANCH

static final PropertyNameList.PropertyName<CcBranch> BRANCH
This version's branch.

See Also:
javax.wvcm.Version#VERSION_BRANCH

ELEMENT

static final PropertyNameList.PropertyName<CcElement> ELEMENT
This version's element.

See Also:
Version.VERSION_HISTORY

MERGE_CONTRIBUTOR_LIST

static final PropertyNameList.PropertyName<ResourceList<CcVersion>> MERGE_CONTRIBUTOR_LIST

The list of versions that were merged to create this version. This will be empty if this version was not created by a merge operation.


PREDECESSOR

static final PropertyNameList.PropertyName<CcVersion> PREDECESSOR

The immediate predecessor of this version on this version's branch, or if this is the first version on the branch, the version from which the branch emanates. Will be null if this version is the /main/0 version of its element.


VIEW_RELATIVE_PATH

static final PropertyNameList.PropertyName<String> VIEW_RELATIVE_PATH

The view-relative path for this version, possibly including the version extension.

NOTE: This property is only available if it is retrieved using a method with a view context, such as Resource.doReadProperties(CcView, PropertyRequest). ClearCase needs a view context to resolve version paths.

Method Detail

doAddLabel

Version doAddLabel(String label,
                   CcView view,
                   Feedback feedback)
                   throws WvcmException
Add the specified label to the version.

Parameters:
label - Label to be applied
view - View context
Throws:
WvcmException
See Also:
Version.doAddLabel(java.lang.String, javax.wvcm.Feedback)

doCreateMergeArrow

CcVersion doCreateMergeArrow(CcVersion toVersion,
                             Feedback feedback)
                             throws WvcmException
Create a Merge hyperlink pointing from this version to the specified destination version.

Parameters:
toVersion - Destination version for the hyperlink
Returns:
A new proxy for this version, whose properties are specified by feedback.
Throws:
WvcmException

doRemoveLabel

Version doRemoveLabel(String label,
                      CcView view,
                      Feedback feedback)
                      throws WvcmException
Remove the specified label from the version.

Parameters:
label - Label to be removed
view - View context
Throws:
WvcmException
See Also:
Version.doRemoveLabel(java.lang.String, javax.wvcm.Feedback)

doSetLabel

Version doSetLabel(String label,
                   CcView view,
                   Feedback feedback)
                   throws WvcmException
Set the specified label on the version.

Parameters:
label - Label to be applied
view - View context
Throws:
WvcmException
See Also:
Version.doSetLabel(java.lang.String, javax.wvcm.Feedback)

getBranch

CcBranch getBranch()
                   throws WvcmException
Get the value of this version's BRANCH property.

Returns:
a proxy for this version's branch
Throws:
WvcmException - if property was not requested

getElement

CcElement getElement()
                     throws WvcmException
Get the value of this version's ELEMENT property.

Returns:
a proxy for this version's element
Throws:
WvcmException - if property was not requested

getMergeContributorList

ResourceList<CcVersion> getMergeContributorList()
                                                throws WvcmException
Get the value of this version's MERGE_CONTRIBUTOR_LIST property.

Returns:
a list of the CcVersion proxies which represent merge contributors for this version.
Throws:
WvcmException - if property was not requested.

getPredecessor

CcVersion getPredecessor()
                         throws WvcmException
Get the value of this version's PREDECESSOR property.

Returns:
a CcVersion proxy for this version's predecessor.
Throws:
WvcmException - if property was not requested.

getViewRelativePath

String getViewRelativePath()
                           throws WvcmException
Get the value of this version's VIEW_RELATIVE_PATH property.

Returns:
view-relative path
Throws:
WvcmException - if property was not requested, or if the view context was not provided

Generated Wed 16-Apr-2014 05:20 PM

Copyright © IBM 2014. All rights reserved.