ICCActivity interface
Description
The ICCActivity interface represents the DevOps Code ClearCase® activity object.
Inheritance

Properties and related methods
- Group and SetGroup
Gets the group to which the activity belongs
Sets the group to which the activity belongs
- Headline and SetHeadline
Gets the headline of this activity
Sets the headline of this activity
- Master and SetMaster
Gets the name of the master replica for this activity
Sets the master replica for this activity
- Name (default property) and SetName
Gets the name of this activity
Sets the name of this activity
- Owner and SetOwner
Gets the owner of this activity
Sets the owner of this activity
Read-only properties
- ChangeSet
Gets the versions in the change set of this activity
- ClearQuestRecordAMState
Gets the am_statetype field from the Rational® ClearQuest® record for this CRM-enabled activity
- ClearQuestRecordID
Gets the ID of the Rational ClearQuest record for this CRM-enabled activity
- ClearQuestRecordType
Gets the type of the Rational ClearQuest record for this CRM-enabled activity
- Contributors
Gets all the contributors of a rebase or deliver integration activity
- CurrentView
Gets the view for which the activity is currently set
- HasChangeSet
Gets whether or not this activity has a (non-empty) change set
- HasCheckouts
Gets whether or not there are checkouts in the change set of this activity
- IsSetInView
Gets whether or not the activity is currently set for a view
- Lock
Gets the lock on this activity
- NameResolverView
Gets a best-guess view for resolving the names of versions in a change set
- Stream
Gets the containing stream of this activity
- VOB
Gets the VOB that contains this activity
Methods
- CreateLock
Locks this activity
Examples
Creation
ChangeSet
Gets the versions in the change set of this activity
Category
Read-only property
VB syntax
Property ChangeSet(pNameResolverView As CCView, [ FailIfErrors As Boolean = True ]) As CCVersions
Visual C++ syntax
ICCVersionsPtr GetChangeSet( ICCView* pNameResolverView, VARIANT_BOOL FailIfErrors);
- Parameter
- Description
- pNameResolverView
- Name of a view to use to resolve the names of versions in the change set.
- FailIfErrors
- Optional in Visual Basic. True to fail the collection initialization if errors occur; False to continue even in the presence of errors.
Remarks
If FailIfErrors is set to True, any messages about unavailable versions encountered during collection initialization will be returned through the normal COM error mechanism. If set to False, the collection will be initialized, but will not include those versions for which there were errors. The error messages can be retrieved by calling ICCVersions::InitErrors.
Member of: ICCActivity interface
ClearQuestRecordAMState
Gets the am_statetype field from the Rational ClearQuest record for this CRM-enabled activity
Category
Read-only property
VB syntax
Property ClearQuestRecordAMState As String
ClearQuestRecordID
Gets the ID of the Rational ClearQuest record for this CRM-enabled activity
Category
Read-only property
VB syntax
Property ClearQuestRecordID As String
ClearQuestRecordType
Gets the type of the Rational ClearQuest record for this CRM-enabled activity
Category
Read-only property
VB syntax
Property ClearQuestRecordType As String
Visual C++ syntax
_bstr_t GetClearQuestRecordType();
Contributors
Gets all the contributors of a rebase or deliver integration activity
For non-integration activity, it returns null.
Category
Read-only property
VB syntax
Property Contributors As CCActivites
CreateLock
Locks this activity
Category
Method
VB syntax
Sub CreateLock([ Comment As String = "" ], [ Obsolete As Boolean = False ], [ ExemptUsersStringArray As Variant ])
Visual C++ syntax
HRESULT CreateLock( _bstr_t Comment, VARIANT_BOOL Obsolete, const _variant_t& ExemptUsersStringArray = vtMissing);
- Parameter
- Description
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this CreateLock operation.
- Obsolete
- Optional in Visual Basic. True to make the locked activity obsolete in addition to locked (like cleartool lock -obsolete); False to lock the activity without making it obsolete.
- ExemptUsersStringArray
- Optional. Variant array of String values containing the names of users exempted from the lock being created.
Member of: ICCActivity interface
CurrentView
Gets the view for which the activity is currently set
Web views associated with the activity are not counted. In other words, only the UCM snapshot or dynamic view is returned.
Category
Read-only property
VB syntax
Property CurrentView As CCView
Group
Gets the group to which the activity belongs
Category
Read-only property
VB syntax
Property Group As String
Visual C++ syntax
_bstr_t GetGroup();
HasChangeSet
Gets whether or not this activity has a (non-empty) change set
Category
Read-only property
VB syntax
Property HasChangeSet As Boolean
HasCheckouts
Gets whether or not there are checkouts in the change set of this activity
Category
Read-only property
VB syntax
Property HasCheckouts As Boolean
Headline
Gets the headline of this activity
Category
Read-only property
VB syntax
Property Headline As String
IsSetInView
Gets whether or not the activity is currently set for a view
Category
Read-only property
VB syntax
Property IsSetInView As Boolean
Lock
Master
Gets the name of the master replica for this activity
Category
Read-only Property
VB syntax
Property Master As String
Visual C++ syntax
_bstr_t GetMaster();
Name
Gets the name of this activity
Category
Read-only property
VB syntax
Property Name As String
NameResolverView
Gets a best-guess view for resolving the names of versions in a change set
Category
Read-only property
VB syntax
Property NameResolverView As CCView
Owner
Gets the owner of this activity
Category
Read-only property
VB syntax
Property Owner As String
Visual C++ syntax
_bstr_t GetOwner();
Remarks
This is the owner of the activity in the project VOB and does not imply anything about the assignment of the activity. The Owner is important during permissions and lock checks.
SetGroup
Sets the group to which the activity belongs
Category
Method
VB syntax
Sub SetGroup(NewGroup As String, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetGroup( _bstr_t NewGroup, _bstr_t Comment);
- Parameter
- Description
- NewGroup
- Name of the new group to which the activity will belong.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetGroup operation.
SetHeadline
Sets the headline of this activity
Category
Method
VB syntax
Sub SetHeadline(NewHeadline As String, [ Comment As String = ""] )
Visual C++ syntax
HRESULT SetHeadline( _bstr_t NewHeadline, _bstr_t Comment);
- Parameter
- Description
- NewHeadline
- New headline for this activity.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetHeadline operation.
SetMaster
Sets the master replica for this activity
Category
Method
VB syntax
Sub SetMaster(Replica As String, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetMaster( _bstr_t Replica, _bstr_t Comment);
- Parameter
- Description
- Replica
- Name of the replica to which mastership of the activity is being transferred.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetMaster operation.
SetName
Sets the name of this activity
Category
Method
VB syntax
Sub SetName(NewName As String, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetName( _bstr_t NewName, _bstr_t Comment);
- Parameter
- Description
- NewName
- New name of the activity.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetName operation.
SetOwner
Sets the owner of this activity
Category
Method
VB syntax
Sub SetOwner(NewOwner As String, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetOwner( _bstr_t NewOwner, _bstr_t Comment);
- Parameter
- Description
- NewOwner
- Name of the owner to whom ownership of the activity is being transferred.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetOwner operation.
Remarks
This is the owner of the activity in the project VOB and does not imply anything about the assignment of the activity. The Owner is important during permissions and lock checks.
Stream
Gets the containing stream of this activity
Category
Read-only property
VB syntax
Property Stream As CCStream
Visual C++ syntax
ICCStreamPtr GetStream();