Project: stp

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

All Superinterfaces:
Activity, CcResource, CcVobResource, Resource, StpActivity, StpResource

public interface CcActivity
extends Activity, StpActivity, CcVobResource

A proxy for a ClearCase UCM activity.

UCM activities collect the logically-related changes (versions) made in a given UCM stream, and are the basic unit of change flow between streams. When a developer begins working on a new task within a particular UCM stream, he typically creates a new UCM activity for that task. At checkout time, each new version is added to the activity's change set.

If the UCM project in which the user working is ClearQuest-enabled, all UCM activities in that project are managed by the ClearQuest Integration . Rather than creating a new UCM activity directly, the user selects or creates the ClearQuest record he wants to work on and performs a WorkOn operation. ClearQuest creates a corresponding UCM activity and binds it to the ClearQuest record.

See the "Developing Software with ClearCase" manual for more information about working with UCM activities.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpActivity
StpActivity.CqUcmIntegrationState
 
Nested classes/interfaces inherited from interface CcVobResource
CcVobResource.ApplyAttributeFlag
 
Field Summary
static PropertyNameList.PropertyName<Boolean> HAS_CHECKOUTS
          Returns true if there are checkouts under this activity.
static PropertyNameList.PropertyName<Boolean> IS_INTEGRATION_ACTIVITY
          Return true if the activity is an "integration activity", that is one created by UCM during a deliver or rebase operation.
static PropertyNameList.PropertyName<ResourceList<Version>> LATEST_VERSION_LIST
          The latest version for each element in a change set.
static PropertyNameList.PropertyName<CcView> NAME_RESOLVER_VIEW
          A view for resolving names of versions in the activity's change set.
static PropertyNameList.PropertyName<CcStream> STREAM
          The UCM stream in which this activity resides.
 
Fields inherited from interface javax.wvcm.Activity
ACTIVITY_CHECKOUT_LIST, ACTIVITY_VERSION_LIST, CURRENT_WORKSPACE_LIST, TASK_LIST
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpActivity
BOUND_CC_ACTIVITY, BOUND_CQ_RECORD, CQ_UCM_INTEGRATION_STATE, HEADLINE, ID_SELECTOR
 
Fields inherited from interface CcVobResource
ATTRIBUTE_LIST, CC_MASTER_REPLICA, CURRENT_REPLICA, HAS_LOCAL_MASTERSHIP, HYPERLINK_LIST, LOCK_INFO, PERMISSIONS, VOB
 
Method Summary
 CcActivity doCreateCcActivity(Feedback feedback)
          Create a new UCM activity at the location identified by this proxy.
 CcActivity doCreateGeneratedCcActivity(Feedback feedback)
          Create a new UCM activity, allowing the provider to choose the new activity's name.
 boolean getHasCheckouts()
          Get the value of this proxy's HAS_CHECKOUTS proerty.
 boolean getIsIntegrationActivity()
          Get the value of this proxy's IS_INTEGRATION_ACTIVITY property.
 ResourceList<Version> getLatestVersionList()
          Get the value of this proxy's LATEST_VERSION_LIST property.
 CcView getNameResolverView()
          Get the value of this proxy's NAME_RESOLVER_VIEW property.
 CcStream getStream()
          Get the value of this proxy's STREAM property.
 void setStream(CcStream stream)
          Set the value of this activity's STREAM property.
 
Methods inherited from interface javax.wvcm.Activity
doCreateGeneratedResource, doCreateResource, getActivityCheckoutList, getActivityVersionList, getCurrentWorkspaceList, getTaskList, setTaskList, workspaceProvider
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpActivity
getBoundCcActivity, getBoundCqRecord, getCqUcmIntegrationState, getHeadline, getIdSelector, setHeadline
 
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
 

Field Detail

HAS_CHECKOUTS

static final PropertyNameList.PropertyName<Boolean> HAS_CHECKOUTS
Returns true if there are checkouts under this activity.


IS_INTEGRATION_ACTIVITY

static final PropertyNameList.PropertyName<Boolean> IS_INTEGRATION_ACTIVITY
Return true if the activity is an "integration activity", that is one created by UCM during a deliver or rebase operation.


LATEST_VERSION_LIST

static final PropertyNameList.PropertyName<ResourceList<Version>> LATEST_VERSION_LIST
The latest version for each element in a change set.


NAME_RESOLVER_VIEW

static final PropertyNameList.PropertyName<CcView> NAME_RESOLVER_VIEW
A view for resolving names of versions in the activity's change set.


STREAM

static final PropertyNameList.PropertyName<CcStream> STREAM
The UCM stream in which this activity resides.

Method Detail

doCreateCcActivity

CcActivity doCreateCcActivity(Feedback feedback)
                              throws WvcmException

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

Set the STREAM property to specify the new activity's stream (required). The stream's repository must match the repository specified in this activity's location.

Set the StpActivity.HEADLINE property to specify the new activity's headline (optional).

Set the Resource.COMMENT property to specify a creation comment for the new activity (optional).

This method fails if the stream is ClearQuest-enabled. In a CQ-enabled stream, activities can only be created indirectly by working on a CQ entity in the context of a view associated with that stream.

Throws:
WvcmException

doCreateGeneratedCcActivity

CcActivity doCreateGeneratedCcActivity(Feedback feedback)
                                       throws WvcmException

Create a new UCM activity, allowing the provider to choose the new activity's name. The provider may use the client-specified location if it is valid, but can select a different location if the location is not valid or already identifies an activity.

Throws:
WvcmException
See Also:
doCreateCcActivity(Feedback)

getHasCheckouts

boolean getHasCheckouts()
                        throws WvcmException
Get the value of this proxy's HAS_CHECKOUTS proerty.

Returns:
true if there are checkouts under the activity represented by this proxy, false otherwise.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsIntegrationActivity

boolean getIsIntegrationActivity()
                                 throws WvcmException
Get the value of this proxy's IS_INTEGRATION_ACTIVITY property.

Returns:
true if this proxy represents an integration activity, false otherwise
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getLatestVersionList

ResourceList<Version> getLatestVersionList()
                                           throws WvcmException
Get the value of this proxy's LATEST_VERSION_LIST property.

Specified by:
getLatestVersionList in interface Activity
Returns:
The latest version of each element in a change set.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getNameResolverView

CcView getNameResolverView()
                           throws WvcmException
Get the value of this proxy's NAME_RESOLVER_VIEW property.

Returns:
A view on the activity's stream.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getStream

CcStream getStream()
                   throws WvcmException
Get the value of this proxy's STREAM property.

Returns:
this activity's stream
Throws:
WvcmException - if this proxy doesn't define a value for this property.

setStream

void setStream(CcStream stream)
Set the value of this activity's STREAM property. This property can only be set at activity creation time.

Parameters:
stream - proxy for the stream in which the new activity will reside

Generated Fri 5-Nov-2010 03:50 AM

Copyright © IBM 2010. All rights reserved.