Project: stp

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

All Superinterfaces:
CcResource, CcVobResource, Component, Folder, Resource, StpResource, VersionHistory

public interface CcComponent
extends Component, CcVobResource

A proxy for a ClearCase UCM component.

A UCM component defines the set of files that will be captured in a baseline of that component. A baseline is a version of a component, and records a version of each element selected by the stream's configuration.

A rootless component has no root directory element. Rootless components are typically used to aggregate other components. Baselines of rootless components contain other baselines, rather than file versions.

NOTE: Not all WVCM properties and operations are supported in this release of CM API. For a list of properties currently supported by a particular resource type, use doGetPropertyNameList() on an instance of that type:

     PropertyRequest supportedProps = myResource.doGetPropertyNameList();
 


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.wvcm.Folder
Folder.BindFlag, Folder.RebindFlag
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
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<Boolean> HAS_ROOT_DIRECTORY_ELEMENT
          Does this component have a root directory element?
static PropertyNameList.PropertyName<CcBaseline> INITIAL_BASELINE
          This component's initial baseline.
static PropertyNameList.PropertyName<CcElement> ROOT_DIRECTORY_ELEMENT
          This component's root directory element - the directory element in the VOB that defines the scope of files that are captured in this component's baselines.
 
Fields inherited from interface javax.wvcm.VersionHistory
ROOT_VERSION
 
Fields inherited from interface javax.wvcm.Folder
CHILD_LIST, CHILD_MAP
 
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
 
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
 CcComponent doCreateCcComponent(Feedback feedback)
          Create a new UCM component at the location identified by this proxy.
 boolean getHasRootDirectoryElement()
          Get the HAS_ROOT_DIRECTORY_ELEMENT property of this component.
 CcBaseline getInitialBaseline()
          Get the the INITIAL_BASELINE property of this component.
 CcElement getRootDirectoryElement()
          Get the ROOT_DIRECTORY_ELEMENT property of this component.
 void setRootDirectoryElement(CcElement root)
          Set the value of this component's ROOT_DIRECTORY_ELEMENT 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 javax.wvcm.Resource
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getDisplayName, getIsExecutable, getLastModified, getParentList, getPathnameLocation, getProperty, getProviderList, getWorkspaceFolderList, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setIsExecutable, setProperty, setProperty, updatedPropertyNameList
 
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
 
Methods inherited from interface javax.wvcm.Resource
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getDisplayName, getIsExecutable, getLastModified, getParentList, getPathnameLocation, getProperty, getProviderList, getWorkspaceFolderList, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setIsExecutable, setProperty, setProperty, updatedPropertyNameList
 

Field Detail

HAS_ROOT_DIRECTORY_ELEMENT

static final PropertyNameList.PropertyName<Boolean> HAS_ROOT_DIRECTORY_ELEMENT
Does this component have a root directory element? Or is it "rootless"?


INITIAL_BASELINE

static final PropertyNameList.PropertyName<CcBaseline> INITIAL_BASELINE
This component's initial baseline. A component's initial baseline contains exactly one version - the /main/0 version of the component's root directory element.


ROOT_DIRECTORY_ELEMENT

static final PropertyNameList.PropertyName<CcElement> ROOT_DIRECTORY_ELEMENT
This component's root directory element - the directory element in the VOB that defines the scope of files that are captured in this component's baselines.

Method Detail

doCreateCcComponent

CcComponent doCreateCcComponent(Feedback feedback)
                                throws WvcmException

Create a new UCM component at the location identified by this proxy. The location should be an object name selector specifying the component's name and the repository (project VOB) in which to create it.

Set the ROOT_DIRECTORY_ELEMENT property to specify the new component's root. If no root directory element is set, a rootless component is created.

This method fails if the root directory element is not a legal choice for a component root.

Throws:
WvcmException

getHasRootDirectoryElement

boolean getHasRootDirectoryElement()
                                   throws WvcmException
Get the HAS_ROOT_DIRECTORY_ELEMENT property of this component.

Returns:
true if this component has a root directory element; false if this is a rootless component.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getInitialBaseline

CcBaseline getInitialBaseline()
                              throws WvcmException
Get the the INITIAL_BASELINE property of this component.

Returns:
A proxy for this component's initial baseline
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getRootDirectoryElement

CcElement getRootDirectoryElement()
                                  throws WvcmException
Get the ROOT_DIRECTORY_ELEMENT property of this component.

Returns:
A proxy for this component's root directory element, or null if this is a rootless component.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

setRootDirectoryElement

void setRootDirectoryElement(CcElement root)
Set the value of this component's ROOT_DIRECTORY_ELEMENT property. This property can only be set at component creation time.

Parameters:
root - A proxy for this component's root directory element

Generated Tue 19-Apr-2011 10:16 PM

Copyright © IBM 2011. All rights reserved.