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.
Gets an array of action and value pairs for this trigger type (that is, a type followed by one or two values)
Gets the trigger type firing order, which is either before the operation (pre-op) or after the operation (post-op)
Gets the number of users for which this trigger type does not fire.
Gets the number of operations kinds which fire this trigger type
Gets the number of restrictions for this element trigger type
Gets an array of the kinds of operations which fire this trigger type
Applies an instance of this trigger type to a UCM element (ICCActivity, ICCBaseline, ICCComponent, ICCFolder, ICCProject, and ICCStream)
Gets a trigger type builder for changing the parameters of this trigger type
Gets an array of action and value pairs for this trigger type (that is, a type followed by one or two values)
Read-only property
Property ActionsArray As Variant
_variant_t GetActionsArray();
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.
Applies an instance of this trigger type to an element
Method
Sub Apply(pElement As CCElement, [ Comment As String = "" ], [ Force As Boolean = False ], [ Recurse As Boolean = False ], [ DirectoryListsSubset As Variant ])
HRESULT Apply( ICCElement* pElement, _bstr_t Comment, VARIANT_BOOL Force, VARIANT_BOOL Recurse, const _variant_t& DirectoryListsSubset = vtMissing);
Member of: ICCTriggerType interface
Applies an instance of this trigger type to a UCM element (ICCActivity, ICCBaseline, ICCComponent, ICCFolder, ICCProject, and ICCStream)
Method
Sub Apply(pElement As CCElement, [ Comment As String = "" ], [ Force As Boolean = False ], [ Recurse As Boolean = False ], [ DirectoryListsSubset As Variant ])
HRESULT Apply( ICCElement* pElement, _bstr_t Comment, VARIANT_BOOL Force, VARIANT_BOOL Recurse, const _variant_t& DirectoryListsSubset = vtMissing);
Member of: ICCTriggerType interface
Gets a trigger type builder for changing the parameters of this trigger type
Method
Function CreateBuilderFromType As CCTriggerTypeBuilder
ICCTriggerTypeBuilderPtr CreateBuilderFromType();
Member of: ICCTriggerType interface
Locks this trigger type
Method
Sub CreateLock([ Comment As String = "" ], [ Obsolete As Boolean = False ], [ ExemptUsersStringArray As Variant ])
HRESULT CreateLock( _bstr_t Comment, VARIANT_BOOL Obsolete, const _variant_t& ExemptUsersStringArray = vtMissing);
Gets whether debug printing happens when the trigger fires
Read-only property
Property DebugPrinting As Boolean
VARIANT_BOOL GetDebugPrinting();
Gets the users for whom this trigger type does not fire
Read-only property
Property ExemptUsersStringArray As Variant
_variant_t GetExemptUsersStringArray();
An array of Variants that contains String values which represent the names of users exempted from the firing of triggers for this trigger type.
Gets the trigger type firing order, which is either before the operation (pre-op) or after the operation (post-op)
Read-only property
Property Firing As CCTriggerFiring
CCTriggerFiring GetFiring();
Gets the group to which this trigger type belongs
Read-only property
Property Group As String
_bstr_t GetGroup();
Gets the inclusion list for this type trigger type
Read-only property
Property InclusionsArray As Variant
_variant_t GetInclusionsArray();
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).
Gets the kind of trigger for this trigger type
Read-only property
Property KindOfTrigger As CCKindOfTrigger
CCKindOfTrigger GetKindOfTrigger();
Gets the lock on this trigger type
Read-only property
Property Lock As CCLock
ICCLockPtr GetLock();
Gets the name of this trigger type
Read-only property
Property Name As String
_bstr_t GetName();
Gets the number of actions for this trigger type
Read-only property
Property NumberOfActions As Long
long GetNumberOfActions();
Gets the number of users for which this trigger type does not fire.
Read-only property
Property NumberOfExemptUsers As Long
long GetNumberOfExemptUsers();
Gets the number of inclusions for this type trigger type
Read-only property
Property NumberOfInclusions As Long
long GetNumberOfInclusions();
Gets the number of restrictions for this element trigger type
Read-only property
Property NumberOfOperationKinds As Long
long GetNumberOfOperationKinds();
Gets the number of restrictions for this element trigger type
Read-only property
Property NumberOfRestrictions As Long
long GetNumberOfRestrictions();
Gets an array of the kinds of operations which fire this trigger type
Read-only property
Property OperationKindsArray As Variant
_variant_t GetOperationKindsArray();
An array of Variants that contains CCTriggerOperationKind values.
Gets the owner of this trigger type
Read-only property
Property Owner As String
_bstr_t GetOwner();
Removes this trigger type from the VOB
Method
Sub RemoveType([ RemoveAllInstances As Boolean = False ], [ IgnorePreopTriggers As Boolean = False ], [ Comment As String = "" ])
HRESULT RemoveType( VARIANT_BOOL RemoveAllInstances, VARIANT_BOOL IgnorePreopTriggers, _bstr_t Comment);
Member of: ICCTriggerType interface
Gets the restriction list for this element trigger type
Read-only property
Property RestrictionsArray As Variant
_variant_t GetRestrictionsArray();
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).
Sets whether debug printing happens when the trigger fires
Method
Sub SetDebugPrinting([ NewDebugPrinting As Boolean ], [ Comment As String = "" ])
HRESULT SetDebugPrinting( VARIANT_BOOL NewDebugPrinting, _bstr_t Comment);
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.
Sets the users for whom this trigger type does not fire
Method
Sub SetExemptUsersStringArray([ ExemptUsersStringArray As Variant ], [ Comment As String = "" ])
HRESULT SetExemptUsersStringArray( const _variant_t& ExemptUsersStringArray, _bstr_t Comment);
Sets the group to which this trigger type belongs
Method
Sub SetGroup(NewGroup As String, [ Comment As String = "" ])
HRESULT SetGroup( _bstr_t NewGroup, _bstr_t Comment);
Sets the name of this trigger type
Method
Sub SetName(NewName As String, [ Comment As String = "" ])
HRESULT SetName( _bstr_t NewName, _bstr_t Comment);
Sets the owner of this trigger type
Method
Sub SetOwner(NewOwner As String, [ Comment As String = "" ])
HRESULT SetOwner( _bstr_t NewOwner, _bstr_t Comment);
Gets the VOB that contains this trigger type
Read-only property
Property VOB As CCVOB