ICCStream interface

Description

The ICCStream interface represents the Rational® ClearCase® UCM stream object.

Inheritance

ICCStream inherits
from ICCUCMObject, which inherits from ICCVOBObject, which inherits from IDispatch. ICCVOBObject interface ICCUCMObject interface

Read-only properties

Activities

Gets the activities in this stream

Baselines

Gets the baselines created in this stream for a particular component

ConfigSpec

Gets the config spec of the stream

DefaultDeliverTarget

Gets the name of the stream to which the stream delivers as the default target

DevStreams

Gets the child streams of an integration stream or a development stream

FoundationBaseline

Gets the foundation baseline in this stream for the specified component

FoundationBaselines

Gets the foundation baselines in this stream for all components

getUCMPolicies

Gets the collection of policies on the stream

getUCMPolicy

Gets the value of the specified policy on the stream

HasActivities

Gets whether or not there are any activities associated with this stream

IsIntegrationSteam

Gets whether or not this stream is the integration stream for the project

LatestBaseline

Gets the latest baseline in this stream for the specified component

LatestBaselines

Gets the latest baselines in this stream for all components

Project

Gets the containing project for this stream

RecBaselines

Gets the recommended baselines of an integration stream or a parent development stream

Views

Gets the set of views associated with this stream

Methods

CreateActivity

Creates an activity in this stream

putUCMPolicies

Writes to the PVOB the collection of policy values for this stream

putUCMPolicy

Writes to the PVOB the policy value for this stream

Examples

Creation

Activities

Gets the activities in this stream

Category

Read-only property

VB syntax

Property Activities As CCActivities

Visual C++ syntax

ICCActivitesPtr GetActivities();

Member of: ICCStream interface

Baselines

Gets the baselines created in this stream for a particular component

Category

Read-only property

VB syntax

Property Baselines (Component As CCComponent) As CCBaselines

Visual C++ syntax

ICCBaselinesPtr GetBaselines(ICCComponent* Component);
Parameter
Description
Component
Component for which to get the baselines created in this stream.

Member of: ICCStream interface

ConfigSpec

Gets the config spec of the stream

Category

Read-only property

VB syntax

Property ConfigSpec As String

Visual C++ syntax

_bstr_tGetConfigSpec();

Member of: ICCStream interface

CreateActivity

Creates an activity in this stream

Category

Method

VB syntax

Function CreateActivity([ Headline As String = "" ], [ Comment As String = "" ], [ Name As String = "" ]) As CCActivity

Visual C++ syntax

ICCActivityPtr CreateActivity(
     _bstr_t Headline,
     _bstr_t Comment       _bstr_t Name);
Parameter
Description
Headline
Optional in Visual Basic. Specifies a description of the activity. For CRM-enabled projects, if Headline is not specified, it is set to the headline that is generated by Rational ClearQuest® for the activity in the Rational ClearQuest user database.
Comment
Optional in Visual Basic. A comment to associate with the history record for this CreateActivity operation.
Name
Optional in Visual Basic. The name of the activity to create. For CRM-enabled projects, Name is automatically set to the record-ID that is generated by Rational ClearQuest for the activity in the Rational ClearQuest user database.

Remarks

CAL does not automatically set the activity when you invoke CreateActivity.

If CreateActivity is invoked in a CRM-enabled stream and a Rational ClearQuest login session has not already been established when this method is called, a prompt for a Rational ClearQuest login is displayed. Additionally, for CRM-enabled projects, CreateActivity does not behave like cleartool mkactivity.

DefaultDeliverTarget

Gets the name of the stream to which the stream delivers as the default target

Category

Read-only property

VB syntax

Property DefaultDeliverTarget As CCStream

Visual C++ syntax

ICCStreamPtr GetDefaultDeliverTarget();

Member of: ICCStream interface

DevStreams

Gets the child streams of an integration stream or a development stream

Category

Read-only property

VB syntax

Property DevStreams() As CCStreams

Visual C++ syntax

ICCStreamsPtr GetDevStreams();

Member of: ICCStream interface

FoundationBaseline

Gets the foundation baseline in this stream for the specified component

Category

Read-only property

VB syntax

Property FoundationBaseline(Component As CCComponent) As CCBaseline

Visual C++ syntax

ICCBaselinePtr GetFoundationBaseline(ICCComponent* Component);
Parameter
Description
Component
Component for which to get the foundation baseline in this stream.

Member of: ICCStream interface

FoundationBaselines

Gets the foundation baselines in this stream for all components

Category

Read-only property

VB syntax

Property FoundationBaselines As CCBaselines

Visual C++ syntax

ICCBaselinesPtr GetFoundationBaselines();

Member of: ICCStream interface

getUCMPolicies

Gets the collection of policies on the stream

Category

Read-only property

VB syntax

Property getUCMPolicies As CCPolicies

Visual C++ syntax

ICCPoliciesPtr GetUCMPolicies();

Member of: ICCStream interface

getUCMPolicy

Gets the value of the specified policy on the stream

Category

Read-only property

VB syntax

Property getUCMPolicy As CCPolicy

Visual C++ syntax

ICCPolicyPtr GetUCMPolicy();

Member of: ICCStream interface

HasActivities

Gets whether or not there are any activities associated with this stream

Category

Read-only property

VB syntax

Property HasActivities As Boolean

Visual C++ syntax

VARIANT_BOOL GetHasActivities();

Member of: ICCStream interface

IsIntegrationSteam

Gets whether or not this stream is the integration stream for the project

Category

Read-only property

VB syntax

Property IsIntegrationStream As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsIntegrationStream();

Member of: ICCStream interface

LatestBaseline

Gets the latest baseline in this stream for the specified component

Category

Read-only property

VB syntax

Property LatestBaseline(Component As CCComponent) As CCBaseline

Visual C++ syntax

ICCBaselinePtr GetLatestBaseline(ICCComponent* Component);
Parameter
Description
Component
Component for which to get the latest baseline in this stream.

Member of: ICCStream interface

LatestBaselines

Gets the latest baselines in this stream for all components

Category

Read-only property

VB syntax

Property LatestBaselines As CCBaselines

Visual C++ syntax

ICCBaselinesPtr GetLatestBaselines();

Member of: ICCStream interface

Project

Gets the containing project for this stream

Category

Read-only property

VB syntax

Property Project As CCProject

Visual C++ syntax

ICCProjectPtr GetProject();

Member of: ICCStream interface

putUCMPolicies

Writes to the PVOB the collection of policy values for this stream

Category

Method

VB syntax

Function putUCMPolicies As CCPolicies

Visual C++ syntax

ICCPoliciesPtr putUCMpolicies(
     _bstr_t Policies);

See also

Member of: ICCStream interface

putUCMPolicy

Writes to the PVOB the policy value for this stream

Category

Method

VB syntax

Function putUCMPolicy As CCPolicy

Visual C++ syntax

ICCPolicyPtr putUCMpolicy(
     _bstr_t Policy);

RecBaselines

Gets the recommended baselines of an integration stream or a parent development stream

Category

Read-only property

VB syntax

Property RecBaselines() As CCBaselines

Visual C++ syntax

ICCBaselinesPtr GetRecBaselines();

Member of: ICCStream interface

Views

Gets the set of views associated with this stream

Category

Read-only property

VB syntax

Property Views([ Owner As String = "" ]) As CCViews

Visual C++ syntax

ICCViewsPtr GetViews(_bstr_t Owner);
Parameter
Description
Owner
Optional in Visual Basic. Owner may be specified to return only those views owned by the specified user.

Remarks

Views returns only those views tagged in the current region.

Member of: ICCStream interface


Feedback