Project: stp

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

All Superinterfaces:
CcResource, CcVobResource, Folder, Resource, StpResource, VersionHistory
All Known Subinterfaces:
CcDirectoryElement

public interface CcElement
extends VersionHistory, CcVobResource

A proxy for a ClearCase element.

Items under Rational ClearCase source control (version control) are generally referred to as elements. An element can be a design model, C++ source file, Visual Studio project, or a DLL. Elements are typically the objects on which you do work. About versions, elements, and VOBs: each time you revise and check in a file or directory from a view, a new version of that element is created. Files and directories under Rational ClearCase control (and all of their constituent versions) are called elements and are stored in VOBs.

For more information about elements, see the ClearCase "Guide to Developing Software" manual, and the cleartool man page "mkelem".


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.wvcm.Folder
Folder.BindFlag, Folder.RebindFlag
 
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<CcElementType> ELEMENT_TYPE
          Get this element's element type.
static PropertyNameList.PropertyName<String> VIEW_RELATIVE_PATH
           The view-relative path for this element.
 
Fields inherited from interface javax.wvcm.VersionHistory
ROOT_VERSION
 
Fields inherited from interface javax.wvcm.Folder
CHILD_LIST, CHILD_MAP
 
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
 CcElementType getElementType()
          Get the value of this element's ELEMENT_TYPE property.
 String getViewRelativePath()
          Get the value of this element's VIEW_RELATIVE_PATH property.
 
Methods inherited from interface javax.wvcm.VersionHistory
doLatestActivityVersionReport, getRootVersion, workspaceProvider
 
Methods inherited from interface javax.wvcm.Folder
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap
 
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

ELEMENT_TYPE

static final PropertyNameList.PropertyName<CcElementType> ELEMENT_TYPE
Get this element's element type.


VIEW_RELATIVE_PATH

static final PropertyNameList.PropertyName<String> VIEW_RELATIVE_PATH

The view-relative path for this element.

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 element paths.

Method Detail

getElementType

CcElementType getElementType()
                             throws WvcmException
Get the value of this element's ELEMENT_TYPE property.

Returns:
element type for the element
Throws:
WvcmException - if property was not requested

getViewRelativePath

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

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

Generated Thu 23-May-2013 10:32 PM

Copyright © IBM 2013. All rights reserved.