|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CcStream
A proxy for a ClearCase UCM stream.
Each UCM stream represents a separate parallel development effort in ClearCase. Code changes made in one UCM stream are not visbile to other streams until the user chooses to share them via the UCM deliver or rebase operations.
A UCM stream has one or more ClearCase views associated with it in which users view and modify their version-controlled resources. The stream determines these views' configuration - the set of components visible in those views and the particular version of each file in each component. This configuration consists of the versions selected by the stream's foundation baseline list, plus the versions in the change sets of the stream's activities.
The stream user creates a UCM activity in the stream for each logical task they are working on. When the user checks in a version-controlled resource, the new version is collected in that activity's change set. The user may create as many activities as they need to complete their tasks.
Each UCM project has a single integration stream to which the project's development streams deliver their changes. UCM supports multi-level stream hierarchies - development streams that have their own substreams and serve as delivery targets for those substreams.
Nested Class Summary |
---|
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<ResourceList<CcActivity>> |
ACTIVITY_LIST
List of all activities in the UCM stream. |
static PropertyNameList.PropertyName<ResourceList<CcBaseline>> |
BASELINE_LIST
This stream's baselines. |
static PropertyNameList.PropertyName<ResourceList<CcComponent>> |
COMPONENT_LIST
The list of components from this stream's complete list of foundation baselines |
static PropertyNameList.PropertyName<CcStream> |
DEFAULT_DELIVER_TARGET
The default target (stream) for this UCM stream's deliver operations. |
static PropertyNameList.PropertyName<CcDeliverOperation> |
DELIVER_OPERATION
|
static PropertyNameList.PropertyName<Boolean> |
DELIVER_POLICY_NO_CHECKOUTS_IN_ACTIVITIES
Is Delivery allowed with checkouts in selected activities |
static PropertyNameList.PropertyName<Boolean> |
DELIVER_POLICY_NO_CHECKOUTS_IN_STREAM
Is Delivery allowed with checkouts in this stream |
static PropertyNameList.PropertyName<ResourceList<CcBaseline>> |
EXPLICIT_BASELINE_LIST
This UCM stream's list of explicit baselines. |
static PropertyNameList.PropertyName<ResourceList<CcBaseline>> |
FOUNDATION_BASELINE_LIST
This UCM stream's foundation baselines. |
static PropertyNameList.PropertyName<Boolean> |
HAS_DELIVERY_IN_PROGRESS
Is this UCM stream in the middle of a delivery? |
static PropertyNameList.PropertyName<Boolean> |
HAS_POSTED_DELIVERY_IN_PROGRESS
Is this locally mastered UCM stream in the middle of a posted delivery to a remotely mastered target? |
static PropertyNameList.PropertyName<Boolean> |
HAS_REBASE_IN_PROGRESS
Is this UCM stream in the middle of a Rebase? |
static PropertyNameList.PropertyName<Boolean> |
IS_INTEGRATION_STREAM
Is this UCM stream an integration stream? |
static PropertyNameList.PropertyName<Boolean> |
IS_READ_ONLY
Is this a read-only UCM stream? |
static PropertyNameList.PropertyName<ResourceList<CcBaseline>> |
LATEST_BASELINE_LIST
This stream's latest baselines. |
static PropertyNameList.PropertyName<ResourceList<StpActivity>> |
MY_ACTIVITY_LIST
The current user's activities in this UCM stream. |
static PropertyNameList.PropertyName<CcProject> |
PARENT_PROJECT
The project to which this UCM stream belongs. |
static PropertyNameList.PropertyName<CcStream> |
PARENT_STREAM
This UCM stream's parent stream. |
static PropertyNameList.PropertyName<ResourceList<CcStream>> |
POSTED_DELIVERY_LIST
A list of streams that have posted deliveries in progress to this stream. |
static PropertyNameList.PropertyName<ResourceList<CcBaseline>> |
RECOMMENDED_BASELINE_LIST
This UCM stream's recommended baselines. |
static PropertyNameList.PropertyName<ResourceList<CcBaseline>> |
RECOMMENDED_BASELINE_LIST_CLOSURE
This UCM stream's full closure of recommended baselines. |
static PropertyNameList.PropertyName<ResourceList<CcStream>> |
SUBSTREAM_LIST
The list of substreams of this UCM stream, i.e., the streams for which this stream is the parent. |
static PropertyNameList.PropertyName<ResourceList<CcView>> |
VIEW_LIST
The views associated with this UCM stream. |
Fields inherited from interface javax.wvcm.Stream |
---|
SOURCE_LIST, TARGET, VERSION_LIST, WORKSPACE |
Fields inherited from interface javax.wvcm.Activity |
---|
ACTIVITY_CHECKOUT_LIST, ACTIVITY_VERSION_LIST, CURRENT_WORKSPACE_LIST, LATEST_VERSION_LIST, TASK_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 | |
---|---|
ResourceList.ResponseIterator<Baseline.CompareReport> |
doCompareReportEx(CcStream stream,
CcBaseline.CompareFlagEx[] flags,
Resource context,
Feedback feedback)
Compare this CcStream with the specified stream. |
CcStream |
doCreateCcStream(Feedback feedback)
Create a new UCM stream at the location specified by this proxy. |
CcStream |
doCreateGeneratedCcStream(Feedback feedback)
Create a new UCM stream, allowing the provider to choose the new stream's name. |
ResourceList<CcActivity> |
getActivityList()
Get the value of this stream's ACTIVITY_LIST property. |
ResourceList<CcBaseline> |
getBaselineList()
Get the value of the this proxy's BASELINE_LIST property. |
ResourceList<CcComponent> |
getComponentList()
Get the value of this stream's COMPONENT_LIST
property. |
CcStream |
getDefaultDeliverTarget()
Get the value of this stream's DEFAULT_DELIVER_TARGET property. |
CcDeliverOperation |
getDeliverOperation()
Get the value of this proxy's DELIVER_OPERATION proxy. |
boolean |
getDeliverPolicyNoCheckoutsInActivities()
Get the value of this stream's DELIVER_POLICY_NO_CHECKOUTS_IN_ACTIVITIES property. |
boolean |
getDeliverPolicyNoCheckoutsInStream()
Get the value of this stream's DELIVER_POLICY_NO_CHECKOUTS_IN_STREAM property. |
ResourceList<CcBaseline> |
getExplicitBaselineList()
Get the value of the this proxy's EXPLICIT_BASELINE_LIST property. |
ResourceList<CcBaseline> |
getFoundationBaselineList()
Get the value of this stream's FOUNDATION_BASELINE_LIST
property. |
boolean |
getHasDeliveryInProgress()
Get the value of this proxy's HAS_DELIVERY_IN_PROGRESS property. |
boolean |
getHasPostedDeliveryInProgress()
Get the value of this proxy's HAS_POSTED_DELIVERY_IN_PROGRESS property. |
boolean |
getHasRebaseInProgress()
Get the value of this proxy's HAS_REBASE_IN_PROGRESS property. |
boolean |
getIsIntegrationStream()
Get the value of this stream's IS_INTEGRATION_STREAM property. |
boolean |
getIsReadOnly()
Get the value of this stream's IS_READ_ONLY property. |
ResourceList<CcBaseline> |
getLatestBaselineList()
Get the value of the this proxy's LATEST_BASELINE_LIST property. |
ResourceList<StpActivity> |
getMyActivityList()
Get the value of this stream's MY_ACTIVITY_LIST property. |
CcProject |
getParentProject()
Get the value of this stream's PARENT_PROJECT property. |
CcStream |
getParentStream()
Get the value of this stream's PARENT_STREAM property. |
ResourceList<CcStream> |
getPostedDeliveryList()
Get the value of this proxy's POSTED_DELIVERY_LIST property. |
ResourceList<CcBaseline> |
getRecommendedBaselineList()
Get the value of the this proxy's RECOMMENDED_BASELINE_LIST property. |
ResourceList<CcBaseline> |
getRecommendedBaselineListClosure()
Get the value of the this proxy's RECOMMENDED_BASELINE_LIST_CLOSURE property. |
ResourceList<CcStream> |
getSubstreamList()
Get the value of this stream's SUBSTREAM_LIST property. |
ResourceList<CcView> |
getViewList()
Get the value of this stream's VIEW_LIST property. |
void |
setDefaultDeliverTarget(CcStream target)
Set the value of this stream's DEFAULT_DELIVER_TARGET property. |
void |
setDeliverPolicyNoCheckoutsInActivities(boolean enablePolicy)
Set the value of this stream's DELIVER_POLICY_NO_CHECKOUTS_IN_ACTIVITIES property. |
void |
setDeliverPolicyNoCheckoutsInStream(boolean enablePolicy)
Set the value of this stream's DELIVER_POLICY_NO_CHECKOUTS_IN_STREAM property. |
void |
setIsIntegrationStream(boolean isInt)
Set the value of this stream's IS_INTEGRATION_STREAM property. |
void |
setIsReadOnly(boolean readOnly)
Set the value of this stream's IS_READ_ONLY property. |
void |
setParentProject(CcProject parent)
Set the value of this stream's PARENT_PROJECT property. |
void |
setParentStream(CcStream parent)
Set the value of this stream's PARENT_STREAM property. |
void |
setRecommendedBaselineList(ResourceList<CcBaseline> recBls)
Set the value of the this proxy's RECOMMENDED_BASELINE_LIST property. |
Methods inherited from interface javax.wvcm.Stream |
---|
doCompareReport, doCompareReport, doUpdate, getSourceList, getTarget, getVersionList, getWorkspace, setTarget |
Methods inherited from interface javax.wvcm.Activity |
---|
doCreateGeneratedResource, doCreateResource, getActivityCheckoutList, getActivityVersionList, getCurrentWorkspaceList, getLatestVersionList, getTaskList, setTaskList, 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, 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 |
Field Detail |
---|
static final PropertyNameList.PropertyName<ResourceList<CcActivity>> ACTIVITY_LIST
List of all activities in the UCM stream.
static final PropertyNameList.PropertyName<ResourceList<CcBaseline>> BASELINE_LIST
This stream's baselines. A context of a CcComponent may be specified when reading this property in which case the list is limited to baselines for the specified CcComponent.
When a stream is baselined, a new baseline is created for each component in the stream's configuration that was changed since the last time the stream was baselined. If a given component has not changed, no baseline is created for that component.
static final PropertyNameList.PropertyName<ResourceList<CcComponent>> COMPONENT_LIST
static final PropertyNameList.PropertyName<CcStream> DEFAULT_DELIVER_TARGET
static final PropertyNameList.PropertyName<CcDeliverOperation> DELIVER_OPERATION
static final PropertyNameList.PropertyName<Boolean> DELIVER_POLICY_NO_CHECKOUTS_IN_ACTIVITIES
static final PropertyNameList.PropertyName<Boolean> DELIVER_POLICY_NO_CHECKOUTS_IN_STREAM
static final PropertyNameList.PropertyName<ResourceList<CcBaseline>> EXPLICIT_BASELINE_LIST
static final PropertyNameList.PropertyName<ResourceList<CcBaseline>> FOUNDATION_BASELINE_LIST
static final PropertyNameList.PropertyName<Boolean> HAS_DELIVERY_IN_PROGRESS
static final PropertyNameList.PropertyName<Boolean> HAS_POSTED_DELIVERY_IN_PROGRESS
static final PropertyNameList.PropertyName<Boolean> HAS_REBASE_IN_PROGRESS
static final PropertyNameList.PropertyName<Boolean> IS_INTEGRATION_STREAM
static final PropertyNameList.PropertyName<Boolean> IS_READ_ONLY
static final PropertyNameList.PropertyName<ResourceList<CcBaseline>> LATEST_BASELINE_LIST
This stream's latest baselines. Specifically, the most recent baseline of each component in this stream's configuration that has been modified in this stream or the foundation baseline for components that have not been modified.
When a stream is baselined, a new baseline is created for each component in the stream's configuration that was changed since the last time the stream was baselined. If a given component has not changed, no baseline is created for that component.
static final PropertyNameList.PropertyName<ResourceList<StpActivity>> MY_ACTIVITY_LIST
The current user's activities in this UCM stream. The exact semantics of this property differ depending on whether the stream is associated with a ClearQuest-enabled UCM project.
If this stream is associated with a ClearQuest-enabled UCM project, the resulting activity list is the result set from the UCMCustomQuery1 query executed in the ClearQuest user database to which the UCM project is bound. In the out-of-the-box ClearQuest UCM schema, this query will return all CQ activities that are:
The UCMCustomQuery1 query can be modified by the customer, and if so will return other results.
On the other hand, if this stream's project is not ClearQuest-enabled, the resulting activity list is simply all UCM activities in the stream that belong to the current user.
In either case, the actual property value is a ResourceList of StpActivity instances.
StpActivity
static final PropertyNameList.PropertyName<CcProject> PARENT_PROJECT
static final PropertyNameList.PropertyName<CcStream> PARENT_STREAM
static final PropertyNameList.PropertyName<ResourceList<CcStream>> POSTED_DELIVERY_LIST
static final PropertyNameList.PropertyName<ResourceList<CcBaseline>> RECOMMENDED_BASELINE_LIST
static final PropertyNameList.PropertyName<ResourceList<CcBaseline>> RECOMMENDED_BASELINE_LIST_CLOSURE
static final PropertyNameList.PropertyName<ResourceList<CcStream>> SUBSTREAM_LIST
static final PropertyNameList.PropertyName<ResourceList<CcView>> VIEW_LIST
Method Detail |
---|
ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReportEx(CcStream stream, CcBaseline.CompareFlagEx[] flags, Resource context, Feedback feedback) throws WvcmException
Compare this CcStream with the specified stream.
Specifically, compute the differences between these two streams in terms of baselines, activities, and/or versions.
stream
- stream to compare againstflags
- specifies the types of differences to include in the
compare report.context
- optional resource (often CcView) providing context for the
generation of certain properties in the returned report.
May be null.feedback
- the properties available in the returned proxies.
WvcmException
for more information
CcStream doCreateCcStream(Feedback feedback) throws WvcmException
Create a new UCM stream at the location specified by this proxy. The location should be an object name selector specifying the stream's name and the repository (project VOB) in which to create it.
To create an integration stream, set the PARENT_PROJECT
property
to the project in which to create the stream, and set the
IS_INTEGRATION_STREAM
property to "true". A given project can
have at most one integration stream.
To create a non-integration stream, set the PARENT_STREAM
property to the integration stream under which to create the stream, and
set the IS_INTEGRATION_STREAM
property to "false".
You may also set the following additional stream properties prior to
calling this method:
FOUNDATION_BASELINE_LIST
DEFAULT_DELIVER_TARGET
IS_READ_ONLY
Resource.COMMENT
WvcmException
CcStream doCreateGeneratedCcStream(Feedback feedback) throws WvcmException
Create a new UCM stream, allowing the provider to choose the new stream'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 stream.
WvcmException
doCreateCcStream(Feedback)
ResourceList<CcActivity> getActivityList() throws WvcmException
ACTIVITY_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcBaseline> getBaselineList() throws WvcmException
BASELINE_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcComponent> getComponentList() throws WvcmException
COMPONENT_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.CcStream getDefaultDeliverTarget() throws WvcmException
DEFAULT_DELIVER_TARGET
property.
null
if there is no default deliver target
defined for this stream
WvcmException
- if this proxy doesn't define a value for this property.CcDeliverOperation getDeliverOperation() throws WvcmException
DELIVER_OPERATION
proxy.
WvcmException
boolean getDeliverPolicyNoCheckoutsInActivities() throws WvcmException
DELIVER_POLICY_NO_CHECKOUTS_IN_ACTIVITIES
property.
WvcmException
- if this proxy doesn't define a value for this property.boolean getDeliverPolicyNoCheckoutsInStream() throws WvcmException
DELIVER_POLICY_NO_CHECKOUTS_IN_STREAM
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcBaseline> getExplicitBaselineList() throws WvcmException
EXPLICIT_BASELINE_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcBaseline> getFoundationBaselineList() throws WvcmException
FOUNDATION_BASELINE_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.boolean getHasDeliveryInProgress() throws WvcmException
HAS_DELIVERY_IN_PROGRESS
property.
WvcmException
- if this proxy doesn't define a value for this property.boolean getHasPostedDeliveryInProgress() throws WvcmException
HAS_POSTED_DELIVERY_IN_PROGRESS
property.
WvcmException
- if this proxy doesn't define a value for this property.boolean getHasRebaseInProgress() throws WvcmException
HAS_REBASE_IN_PROGRESS
property.
WvcmException
- if this proxy doesn't define a value for this property.boolean getIsIntegrationStream() throws WvcmException
IS_INTEGRATION_STREAM
property.
WvcmException
- if this proxy doesn't define a value for this property.boolean getIsReadOnly() throws WvcmException
IS_READ_ONLY
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcBaseline> getLatestBaselineList() throws WvcmException
LATEST_BASELINE_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<StpActivity> getMyActivityList() throws WvcmException
MY_ACTIVITY_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.CcProject getParentProject() throws WvcmException
PARENT_PROJECT
property.
WvcmException
- if this proxy doesn't define a value for this property.CcStream getParentStream() throws WvcmException
PARENT_STREAM
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcStream> getPostedDeliveryList() throws WvcmException
POSTED_DELIVERY_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcBaseline> getRecommendedBaselineList() throws WvcmException
RECOMMENDED_BASELINE_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcBaseline> getRecommendedBaselineListClosure() throws WvcmException
RECOMMENDED_BASELINE_LIST_CLOSURE
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcStream> getSubstreamList() throws WvcmException
SUBSTREAM_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcView> getViewList() throws WvcmException
VIEW_LIST
property.
WvcmException
- if this proxy doesn't define a value for this property.void setDefaultDeliverTarget(CcStream target)
DEFAULT_DELIVER_TARGET
property.
The default deliver target can only be changed on integration streams.
The default deliver target for all non-integration streams is their parent
stream.
target
- this stream's new default deliver target or null
to clear
the deliver targetvoid setDeliverPolicyNoCheckoutsInActivities(boolean enablePolicy)
DELIVER_POLICY_NO_CHECKOUTS_IN_ACTIVITIES
property.
enablePolicy
- true to enable the policy to disallow Deliver with checkouts in selected activities for this streamvoid setDeliverPolicyNoCheckoutsInStream(boolean enablePolicy)
DELIVER_POLICY_NO_CHECKOUTS_IN_STREAM
property.
enablePolicy
- true to enable the policy to disallow Deliver with checkouts in this streamvoid setIsIntegrationStream(boolean isInt)
IS_INTEGRATION_STREAM
property.
This property can only be set at stream creation time.
isInt
- true if this stream is an integration stream, else falsevoid setIsReadOnly(boolean readOnly)
IS_READ_ONLY
property.
This property can only be set at stream creation time.
readOnly
- true if this stream is to be read-only, else falsevoid setParentProject(CcProject parent)
PARENT_PROJECT
property.
This property can only be set at stream creation time.
parent
- stream's parent projectvoid setParentStream(CcStream parent)
PARENT_STREAM
property.
This property can only be set at stream creation time.
parent
- stream's parent streamvoid setRecommendedBaselineList(ResourceList<CcBaseline> recBls)
RECOMMENDED_BASELINE_LIST
property.
recBls
- a list of client proxies for this project's recommended baselines
|
Generated Tue 24-Jan-2012 10:05 AM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |