ICCTriggerType interface

Description

The ICCTriggerType interface represents the Rational® ClearCase® trigger type object.

Every trigger is an instance of a kind of trigger type. The meaning associated with a particular trigger type is user-defined.

Inheritance

ICCTriggerType
inherits from ICCVOBObject, which inherits from IDispatch ICCVOBObject interface

Properties and related methods

DebugPrinting and SetDebugPrinting

Gets whether debug printing happens when the trigger fires

Sets whether debug printing happens when the trigger fires

ExemptUsersStringArray and SetExemptUsersStringArray

Gets the users for whom this trigger type does not fire

Sets the users for whom this trigger type does not fire

Group and SetGroup

Gets the group to which this trigger type belongs

Sets the group to which this trigger type belongs

Name (default property) and SetName

Gets the name of this trigger type

Sets the name of this trigger type

Owner and SetOwner

Gets the owner of this trigger type

Sets the owner of this trigger type

Read-only properties

ActionsArray

Gets an array of action and value pairs for this trigger type (that is, a type followed by one or two values)

Firing

Gets the trigger type firing order, which is either before the operation (pre-op) or after the operation (post-op)

InclusionsArray

Gets the inclusion list for this type trigger type

KindOfTrigger

Gets the kind of trigger for this trigger type

Lock

Gets the lock on this trigger type

NumberOfActions

Gets the number of actions for this trigger type

NumberOfExemptUsers

Gets the number of users for which this trigger type does not fire.

NumberOfInclusions

Gets the number of inclusions for this type trigger type

NumberOfOperationKinds

Gets the number of operations kinds which fire this trigger type

NumberOfRestrictions

Gets the number of restrictions for this element trigger type

OperationKindsArray

Gets an array of the kinds of operations which fire this trigger type

RestrictionsArray

Gets the restriction list for this element trigger type

VOB

Gets the VOB that contains this trigger type

Methods

Apply

Applies an instance of this trigger type to an element

ApplyUCM

Applies an instance of this trigger type to a UCM element (ICCActivity, ICCBaseline, ICCComponent, ICCFolder, ICCProject, and ICCStream)

CreateBuilderFromType

Gets a trigger type builder for changing the parameters of this trigger type

CreateLock

Locks this trigger type

RemoveType

Removes this trigger type from the VOB

Examples

Creation

ActionsArray

Gets an array of action and value pairs for this trigger type (that is, a type followed by one or two values)

Category

Read-only property

VB syntax

Property ActionsArray As Variant

Visual C++ syntax

_variant_t GetActionsArray();

Return value

A sparsely filled array having the same number of rows as actions. Each row contains a Variant returned as a CCTriggerActionType value followed by one or two values, depending on the type of action.

Apply

Applies an instance of this trigger type to an element

Category

Method

VB syntax

Sub Apply(pElement As CCElement, [ Comment As String = "" ], [ Force As Boolean = False ], [ Recurse As Boolean = False ], [ DirectoryListsSubset As Variant ])

Visual C++ syntax

HRESULT Apply(
     ICCElement* pElement,
     _bstr_t Comment,
     VARIANT_BOOL Force,
     VARIANT_BOOL Recurse,
     const _variant_t& DirectoryListsSubset = vtMissing);
Parameter
Description
pElement
The element to which the trigger is applied.
Comment
Optional in Visual Basic. A comment to associate with the history record for this Apply operation.
Force
Optional in Visual Basic. True to attach the trigger to the element even if the element does not match the trigger type definition; False to fail if the element type does not match the trigger definition.
Recurse
Optional in Visual Basic. True to process the entire subtree below any directory element encountered; False to process only the directory element itself, or a file.
DirectoryListsSubset
Optional. If the trigger is attached to a directory, DirectoryListsSubset controls the trigger's inclusion on the attached and inheritance lists. Must be a Variant containing one of the valid CCTriggerDirectorySubset values.

Member of: ICCTriggerType interface

ApplyUCM

Applies an instance of this trigger type to a UCM element (ICCActivity, ICCBaseline, ICCComponent, ICCFolder, ICCProject, and ICCStream)

Category

Method

VB syntax

Sub Apply(pElement As CCElement, [ Comment As String = "" ], [ Force As Boolean = False ], [ Recurse As Boolean = False ], [ DirectoryListsSubset As Variant ])

Visual C++ syntax

HRESULT Apply(
     ICCElement* pElement,
     _bstr_t Comment,
     VARIANT_BOOL Force,
     VARIANT_BOOL Recurse,
     const _variant_t& DirectoryListsSubset = vtMissing);
Parameter
Description
pElement
The element to which the trigger is applied.
Comment
Optional in Visual Basic. A comment to associate with the history record for this Apply operation.
Force
Optional in Visual Basic. True to attach the trigger to the element even if the element does not match the trigger type definition; False to fail if the element type does not match the trigger definition.
Recurse
Optional in Visual Basic. True to process the entire subtree below any directory element encountered; False to process only the directory element itself, or a file.
DirectoryListsSubset
Optional. If the trigger is attached to a directory, DirectoryListsSubset controls the trigger's inclusion on the attached and inheritance lists. Must be a Variant containing one of the valid CCTriggerDirectorySubset values.

Member of: ICCTriggerType interface

CreateBuilderFromType

Gets a trigger type builder for changing the parameters of this trigger type

Category

Method

VB syntax

Function CreateBuilderFromType As CCTriggerTypeBuilder

Visual C++ syntax

ICCTriggerTypeBuilderPtr CreateBuilderFromType();

Member of: ICCTriggerType interface

CreateLock

Locks this trigger type

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 trigger type obsolete in addition to locked (like cleartool lock -obsolete); False to lock the trigger type without making it obsolete.
ExemptUsersStringArray
Optional. Variant array of String values that contains the names of users exempted from the lock being created.

See also

Lock

Member of: ICCTriggerType interface

DebugPrinting

Gets whether debug printing happens when the trigger fires

Category

Read-only property

VB syntax

Property DebugPrinting As Boolean

Visual C++ syntax

VARIANT_BOOL GetDebugPrinting();

ExemptUsersStringArray

Gets the users for whom this trigger type does not fire

Category

Read-only property

VB syntax

Property ExemptUsersStringArray As Variant

Visual C++ syntax

_variant_t GetExemptUsersStringArray();

Return value

An array of Variants that contains String values which represent the names of users exempted from the firing of triggers for this trigger type.

Firing

Gets the trigger type firing order, which is either before the operation (pre-op) or after the operation (post-op)

Category

Read-only property

VB syntax

Property Firing As CCTriggerFiring

Visual C++ syntax

CCTriggerFiring GetFiring();

Return value

A CCTriggerFiring value.

Member of: ICCTriggerType interface

Group

Gets the group to which this trigger type belongs

Category

Read-only property

VB syntax

Property Group As String

Visual C++ syntax

_bstr_t GetGroup();

InclusionsArray

Gets the inclusion list for this type trigger type

Category

Read-only property

VB syntax

Property InclusionsArray As Variant

Visual C++ syntax

_variant_t GetInclusionsArray();

Return value

An array of Variants that represents the inclusion list, containing CCTriggerTypeAll values, object pointers, or String values. A CCTriggerTypesAll value is returned for all metadata types of a particular kind (for example, all attribute types), an object pointer for a specific metadata type (for example, a particular CCAttributeType), or a String value for the name of a specific element type (for example, text_file).

KindOfTrigger

Gets the kind of trigger for this trigger type

Category

Read-only property

VB syntax

Property KindOfTrigger As CCKindOfTrigger

Visual C++ syntax

CCKindOfTrigger GetKindOfTrigger();

Return value

A CCKindOfTrigger value.

Member of: ICCTriggerType interface

Lock

Gets the lock on this trigger type

Category

Read-only property

VB syntax

Property Lock As CCLock

Visual C++ syntax

ICCLockPtr GetLock();

Name

Gets the name of this trigger type

Category

Read-only property

VB syntax

Property Name As String

Visual C++ syntax

_bstr_t GetName();

See also

SetName

Member of: ICCTriggerType interface

NumberOfActions

Gets the number of actions for this trigger type

Category

Read-only property

VB syntax

Property NumberOfActions As Long

Visual C++ syntax

long GetNumberOfActions();

NumberOfExemptUsers

Gets the number of users for which this trigger type does not fire.

Category

Read-only property

VB syntax

Property NumberOfExemptUsers As Long

Visual C++ syntax

long GetNumberOfExemptUsers();

NumberOfInclusions

Gets the number of inclusions for this type trigger type

Category

Read-only property

VB syntax

Property NumberOfInclusions As Long

Visual C++ syntax

long GetNumberOfInclusions();

NumberOfOperationKinds

Gets the number of restrictions for this element trigger type

Category

Read-only property

VB syntax

Property NumberOfOperationKinds As Long

Visual C++ syntax

long GetNumberOfOperationKinds();

NumberOfRestrictions

Gets the number of restrictions for this element trigger type

Category

Read-only property

VB syntax

Property NumberOfRestrictions As Long

Visual C++ syntax

long GetNumberOfRestrictions();

OperationKindsArray

Gets an array of the kinds of operations which fire this trigger type

Category

Read-only property

VB syntax

Property OperationKindsArray As Variant

Visual C++ syntax

_variant_t GetOperationKindsArray();

Return value

An array of Variants that contains CCTriggerOperationKind values.

Owner

Gets the owner of this trigger type

Category

Read-only property

VB syntax

Property Owner As String

Visual C++ syntax

_bstr_t GetOwner();

RemoveType

Removes this trigger type from the VOB

Category

Method

VB syntax

Sub RemoveType([ RemoveAllInstances As Boolean = False ], [ IgnorePreopTriggers As Boolean = False ], [ Comment As String = "" ])

Visual C++ syntax

HRESULT RemoveType(
     VARIANT_BOOL RemoveAllInstances,
     VARIANT_BOOL IgnorePreopTriggers,
     _bstr_t Comment);
Parameter
Description
RemoveAllInstances
Optional in Visual Basic. True to remove the trigger type and all instances of the type; False to remove the trigger type only if there are no instances of the type.
IgnorePreopTriggers
Optional in Visual Basic. True to remove the trigger type even if the pre-operation trigger would prevent the trigger from being removed; False to fail if the pre-operation trigger prevents trigger type removal.
Comment
Optional in Visual Basic. A comment to associate with the history record for this RemoveType operation.

Member of: ICCTriggerType interface

RestrictionsArray

Gets the restriction list for this element trigger type

Category

Read-only property

VB syntax

Property RestrictionsArray As Variant

Visual C++ syntax

_variant_t GetRestrictionsArray();

Return value

An array of Variants that represents the restriction list and contains object pointers or String values. An object pointer is returned for a specific metadata type (for example, a particular CCAttributeType), or a String value for the name of a specific element type (for example, text_file).

SetDebugPrinting

Sets whether debug printing happens when the trigger fires

Category

Method

VB syntax

Sub SetDebugPrinting([ NewDebugPrinting As Boolean ], [ Comment As String = "" ])

Visual C++ syntax

HRESULT SetDebugPrinting(
     VARIANT_BOOL NewDebugPrinting,
     _bstr_t Comment);
Parameter
Description
NewDebugPrinting
Optional in Visual Basic. True to enable debug printing whenever the trigger fires; False to have trigger fire silently.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetDebugPrinting operation.

Remarks

SetDebugPrinting is for debugging purposes only. The debug output goes to stdout. To see the output, you must test the trigger from the command line. When you finish debugging, disable debug printing to avoid confusing those invoking the trigger.

SetExemptUsersStringArray

Sets the users for whom this trigger type does not fire

Category

Method

VB syntax

Sub SetExemptUsersStringArray([ ExemptUsersStringArray As Variant ], [ Comment As String = "" ])

Visual C++ syntax

HRESULT SetExemptUsersStringArray(
     const _variant_t& ExemptUsersStringArray,
     _bstr_t Comment);
Parameter
Description
ExemptUsersStringArray
Optional in Visual Basic. Variant array of String values that contains the names of users exempted from the firing of triggers for this trigger type.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetExemptUsersStringArray operation.

SetGroup

Sets the group to which this trigger type 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 trigger type will belong.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetGroup operation.

See also

Group

Member of: ICCTriggerType interface

SetName

Sets the name of this trigger type

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
The new name for this trigger type.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetName operation.

See also

Name

Member of: ICCTriggerType interface

SetOwner

Sets the owner of this trigger type

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 which ownership of the trigger type is being transferred.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetOwner operation.

See also

Owner

Member of: ICCTriggerType interface

VOB

Gets the VOB that contains this trigger type

Category

Read-only property

VB syntax

Property VOB As CCVOB

Visual C++ syntax

ICCVOBPtr GetVOB();

Member of: ICCTriggerType interface


Feedback