Project: stp

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

All Superinterfaces:
CcResource, CcVobResource, Resource, StpResource

public interface CcProject
extends CcVobResource

A proxy for a ClearCase UCM project.

A UCM project contains the configuration information needed to manage a significant development effort, such as a product release. A project contains one main shared integration stream and typically multiple per-user development streams.

A UCM project may be ClearQuest-enabled by linking it to a particular ClearQuest database. In ClearQuest-enabled projects, all UCM activities are associated with ClearQuest entities in the ClearQuest database. ClearQuest provides richer activity management functionality than is available from ClearCase alone.

For more project information, see the ClearCase "Guide to Developing Software with UCM" manual, and the cleartool man page "mkproject".


Nested Class Summary
static class CcProject.ClearQuestEnabledState
          A UCM project is "ClearQuest-enabled" if it is bound to a ClearQuest user database and participates in the ClearQuest/UCM integration.
 
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<String> BASELINE_NAMING_TEMPLATE
          Defines the baseline name template for a project.
static PropertyNameList.PropertyName<CcProject.ClearQuestEnabledState> CLEARQUEST_ENABLED_STATE
          Is this a ClearQuest-enabled UCM project?
static PropertyNameList.PropertyName<CqUserDb> CLEARQUEST_USER_DB
          The ClearQuest user database this CQ-enabled UCM project is associated with.
static PropertyNameList.PropertyName<CcStream> INTEGRATION_STREAM
          This UCM project's integration stream.
static PropertyNameList.PropertyName<Boolean> IS_SINGLE_STREAM
          Is this a single-stream UCM project?
static PropertyNameList.PropertyName<ResourceList<CcComponent>> MODIFIABLE_COMPONENT_LIST
          The list of UCM components that can be modified in the UCM stream(s) associated with this UCM project.
static PropertyNameList.PropertyName<ResourceList<CcStream>> POSTED_DELIVERY_LIST
          A list of all streams in this UCM project that have posted deliveries in progress.
static PropertyNameList.PropertyName<CcProjectFolder> PROJECT_FOLDER
          The UCM folder in which this UCM project resides
static PropertyNameList.PropertyName<ResourceList<CcStream>> STREAM_LIST
          The list of streams in this UCM project.
static PropertyNameList.PropertyName<ResourceList<CqRecordType>> UCM_ENABLED_CQ_RECORD_TYPE_LIST
          The list of UCM enabled CQ record types in this UCM project.
 
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
 CcProject doCreateCcProject(Feedback feedback)
          Create a new UCM project at the location specified by this proxy.
 String getBaselineNamingTemplate()
          Get the value of this proxy's BASELINE_NAMING_TEMPLATE property.
 CcProject.ClearQuestEnabledState getClearQuestEnabledState()
          Get the value of this proxy's CLEARQUEST_ENABLED_STATE property.
 CqUserDb getClearQuestUserDb()
          Get the value of this proxy's CLEARQUEST_USER_DB property.
 CcStream getIntegrationStream()
          Get the value of this proxy's INTEGRATION_STREAM property.
 boolean getIsSingleStream()
          Get the value of this proxy's IS_SINGLE_STREAM property.
 ResourceList<CcComponent> getModifiableComponentList()
          Get the value of this proxy's MODIFIABLE_COMPONENT_LIST property.
 ResourceList<CcStream> getPostedDeliveryList()
          Get the value of this proxy's POSTED_DELIVERY_LIST property.
 CcProjectFolder getProjectFolder()
          Get the value of this proxy's PROJECT_FOLDER property.
 ResourceList<CcStream> getStreamList()
          Get the value of this proxy's STREAM_LIST property.
 ResourceList<CqRecordType> getUcmEnabledCqRecordTypeList()
          Get the value of this proxy's UCM_ENABLED_CQ_RECORD_TYPE_LIST property.
 void setBaselineNamingTemplate(String bl_template)
          Set the template to be used when naming a newly created baseline.
 void setIsSingleStream(boolean isSingleStream)
          Set whether the project is single stream or not.
 void setProjectFolder(CcProjectFolder folder)
          Set the parent folder for this project
 
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
 
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

BASELINE_NAMING_TEMPLATE

static final PropertyNameList.PropertyName<String> BASELINE_NAMING_TEMPLATE
Defines the baseline name template for a project. The property specifies the tokens to be used in the baseline name and it can include any of the following tokens separated by commas: When the baseline is created, UCM replaces commas with underscores in the baseline name.


CLEARQUEST_ENABLED_STATE

static final PropertyNameList.PropertyName<CcProject.ClearQuestEnabledState> CLEARQUEST_ENABLED_STATE
Is this a ClearQuest-enabled UCM project?


CLEARQUEST_USER_DB

static final PropertyNameList.PropertyName<CqUserDb> CLEARQUEST_USER_DB
The ClearQuest user database this CQ-enabled UCM project is associated with.


INTEGRATION_STREAM

static final PropertyNameList.PropertyName<CcStream> INTEGRATION_STREAM
This UCM project's integration stream.


IS_SINGLE_STREAM

static final PropertyNameList.PropertyName<Boolean> IS_SINGLE_STREAM
Is this a single-stream UCM project?


MODIFIABLE_COMPONENT_LIST

static final PropertyNameList.PropertyName<ResourceList<CcComponent>> MODIFIABLE_COMPONENT_LIST
The list of UCM components that can be modified in the UCM stream(s) associated with this UCM project.


POSTED_DELIVERY_LIST

static final PropertyNameList.PropertyName<ResourceList<CcStream>> POSTED_DELIVERY_LIST
A list of all streams in this UCM project that have posted deliveries in progress. A delivery is posted if the source stream is mastered at a different replica than the target stream at the time of the delivery.


PROJECT_FOLDER

static final PropertyNameList.PropertyName<CcProjectFolder> PROJECT_FOLDER
The UCM folder in which this UCM project resides


STREAM_LIST

static final PropertyNameList.PropertyName<ResourceList<CcStream>> STREAM_LIST
The list of streams in this UCM project.


UCM_ENABLED_CQ_RECORD_TYPE_LIST

static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> UCM_ENABLED_CQ_RECORD_TYPE_LIST
The list of UCM enabled CQ record types in this UCM project.

Method Detail

doCreateCcProject

CcProject doCreateCcProject(Feedback feedback)
                            throws WvcmException
Create a new UCM project at the location specified by this proxy. The location should be an object name selector specifying the project's name and the repository (project VOB) in which to create it.

Throws:
WvcmException

getBaselineNamingTemplate

String getBaselineNamingTemplate()
                                 throws WvcmException
Get the value of this proxy's BASELINE_NAMING_TEMPLATE property.

Returns:
a string containing this projects baseline naming template
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getClearQuestEnabledState

CcProject.ClearQuestEnabledState getClearQuestEnabledState()
                                                           throws WvcmException
Get the value of this proxy's CLEARQUEST_ENABLED_STATE property.

Returns:
ENABLED, NOT_ENABLED, or SUSPENDED depending on this project's state.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getClearQuestUserDb

CqUserDb getClearQuestUserDb()
                             throws WvcmException
Get the value of this proxy's CLEARQUEST_USER_DB property.

Returns:
a proxy for the CqUserDb associated with this CQ-enabled UCM project, or null if project is not CQ-enabled
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIntegrationStream

CcStream getIntegrationStream()
                              throws WvcmException
Get the value of this proxy's INTEGRATION_STREAM property.

Returns:
a client proxy for this project's integration stream, or null if project doesn't have an integration stream
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsSingleStream

boolean getIsSingleStream()
                          throws WvcmException
Get the value of this proxy's IS_SINGLE_STREAM property.

Returns:
true if this is a single-stream UCM project, else false.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getModifiableComponentList

ResourceList<CcComponent> getModifiableComponentList()
                                                     throws WvcmException
Get the value of this proxy's MODIFIABLE_COMPONENT_LIST property.

Returns:
list of modifiable components as ResourceList of UcmComponent instances.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getPostedDeliveryList

ResourceList<CcStream> getPostedDeliveryList()
                                             throws WvcmException
Get the value of this proxy's POSTED_DELIVERY_LIST property.

Returns:
A list containing this project's posted deliveries.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getProjectFolder

CcProjectFolder getProjectFolder()
                                 throws WvcmException
Get the value of this proxy's PROJECT_FOLDER property.

Returns:
A client proxy for the UCM folder that contains this UCM project.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getStreamList

ResourceList<CcStream> getStreamList()
                                     throws WvcmException
Get the value of this proxy's STREAM_LIST property.

Returns:
list of project's streams as a ResourceList of UcmStream instances.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getUcmEnabledCqRecordTypeList

ResourceList<CqRecordType> getUcmEnabledCqRecordTypeList()
                                                         throws WvcmException
Get the value of this proxy's UCM_ENABLED_CQ_RECORD_TYPE_LIST property.

Returns:
list of project's ucm enabled cq record types as a ResourceList of CqRecordType instances.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

setBaselineNamingTemplate

void setBaselineNamingTemplate(String bl_template)
Set the template to be used when naming a newly created baseline. Specifying an empty string for a template will result in the default template being set (currently "basename").

Parameters:
bl_template - A string containing the desired naming template

setIsSingleStream

void setIsSingleStream(boolean isSingleStream)
Set whether the project is single stream or not. This property can only be set at project creation time.

Parameters:
isSingleStream - true if the project should be single stream, false otherwise.

setProjectFolder

void setProjectFolder(CcProjectFolder folder)
Set the parent folder for this project

Parameters:
folder - client proxy for the parent project folder.

Generated Thu 2-Aug-2012 03:10 AM

Copyright © IBM 2012. All rights reserved.