You can supply a variety of parameters to Rational® ClearCase® to specify how a trigger type operates. The ICCTriggerTypeBuilder interface allows client code to set one or more of these parameters and then use the Create method to create a new trigger type or the Replace method to replace an existing trigger type.
Gets and sets whether debug printing happens when the trigger fires
Gets and sets the users for whom this trigger type does not fire
Gets and sets the trigger type firing order, which is either before (pre-op) or after (post-op) the operation
Gets an array of action and value pairs for this trigger type (that is, a type that is followed by one or two values)
Gets the number of users for whom 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 kinds of operations which fire this trigger type
Adds an exec string action that runs on Linux or the UNIX system
Adds an item to the type inclusion list for this type trigger type
Removes the item from the type inclusion list for this type trigger type
Removes the item from the type restriction list for this element trigger type
Redefines the trigger type that is represented by this trigger type builder
Adds the item to the type restriction list for this element trigger type
Gets an array of action and value pairs for this trigger type (that is, a type that is followed by one or two values)
Read-only property
Property ActionsArray As Variant
_variant_t GetActionsArray();
An array of Variants that contains CCTriggerActionType values. Use the array index to specify the action for RemoveAction to remove.
Adds an exec string action
Method
Sub AddExecAction(Action As String)
HRESULT AddExecAction(_bstr_t Action);
Adds an exec string action that runs on Linux or the UNIX system
Method
Sub AddExecUNIXAction(Action As String)
HRESULT AddExecUNIXAction(_bstr_t Action);
Adds an exec string action that runs on the Windows system
Method
Sub AddExecWinAction(Action As String)
HRESULT AddExecWinAction(_bstr_t Action);
Adds a make attribute action
Method
Sub AddMkattrAction(pAttributeType As CCAttributeType, Value As Variant)
HRESULT AddMkattrAction( ICCAttributeType* pAttributeType, const _variant_t& Value);
Adds a make hyperlink 'from' action
Method
Sub AddMkhlinkFromAction(pHyperlinkType As CCHyperlinkType, FromPath As String)
HRESULT AddMkhlinkFromAction( ICCHyperlinkType* pHyperlinkType, _bstr_t FromPath);
Adds a make hyperlink 'to' action
Method
Sub AddMkhlinkToAction(pHyperlinkType As CCHyperlinkType, ToPath As String)
HRESULT AddMkhlinkToAction( ICCHyperlinkType* pHyperlinkType, _bstr_t ToPath);
Adds a make label action
Method
Sub AddMklabelAction(pLabelType As CCLabelType)
HRESULT AddMklabelAction(ICCLabelType* pLabelType);
Creates the new trigger type
Method
Function Create([ Comment As String ="" ]) As CCTriggerType
ICCTriggerTypePtr Create(_bstr_t Comment);
Before the trigger type builder can be used to create a trigger type, it must have one or more operations, one or more actions, and Name must be set. In addition, type triggers must have one or more restrictions.
Gets and sets whether debug printing happens when the trigger fires
Read-write property
Property DebugPrinting As Boolean
VARIANT_BOOL GetDebugPrinting(); void PutDebugPrinting(VARIANT_BOOL NewDebugPrinting);
DebugPrinting 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
Member of: ICCTriggerTypeBuilder interface
Gets and sets the users for whom this trigger type does not fire
Read-write property
Property ExemptUsersStringArray As Variant
_variant_t GetExemptUsersStringArray(); void PutExemptUsersStringArray(const _variant_t& NewExemptUsersStringArray);
An array of Variants that contains String values represents the names of users exempted from the firing of triggers for this trigger type.
Adds a kind of operation that fires this trigger type
Method
Sub FireOn(OperationKind As CCTriggerOperationKind)
HRESULT FireOn(CCTriggerOperationKind OperationKind);
Gets and sets the trigger type firing order, which is either before (pre-op) or after (post-op) the operation
Read-write property
Property Firing As CCTriggerFiring
CCTriggerFiring GetFiring(); void PutFiring(CCTriggerFiring NewFiring);
A CCTriggerFiring value specifies when the trigger will fire.
Member of: ICCTriggerTypeBuilder interface
Adds an item to the type inclusion list for this type trigger type
Method
Sub IncludeOn(InclusionType As Variant)
HRESULT IncludeOn(const _variant_t& InclusionType);
Member of: ICCTriggerTypeBuilder interface
Gets the inclusion list for this type trigger type
Read-only property
Property InclusionsArray As Variant
_variant_t GetInclusionArray();
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 and sets the kind of trigger for this trigger type
Read-write property
Property KindOfTrigger As CCKindOfTrigger
CCKindOfTrigger GetKindOfTrigger(); void PutKindOfTrigger(CCKindOfTrigger NewKind);
A CCKindOfTrigger value specifies the kind of trigger.
Member of: ICCTriggerTypeBuilder interface
Gets and sets the name of this trigger type
Read-write property
Property Name As String
_bstr_t GetName(); void PutName(_bstr_t NewName);
You cannot use the ICCTriggerTypeBuilder interface to rename a trigger. Once you set the Name of a trigger type builder, you can only use that builder to create a new trigger type, and not to replace an existing one.
Member of: ICCTriggerTypeBuilder interface
Gets the number of actions for this trigger type
Read-only property
Property NumberOfActions As Long
long GetNumberOfActions();
Gets the number of users for whom 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 operations kinds which fire this 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 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.
Member of: ICCTriggerTypeBuilder interface
Removes the numbered action from trigger firing actions
Method
Sub RemoveAction(Index As Long)
HRESULT RemoveAction(long Index);
Removes the item from the type inclusion list for this type trigger type
Method
Sub RemoveInclusion(InclusionType As Variant)
HRESULT RemoveInclusion(const _variant_t& InclusionType);
Sets the trigger type not to fire on this kind of operation
Method
Sub RemoveOperationKind(OperationKind As CCTriggerOperationKind)
HRESULT RemoveOperationKind(CCTriggerOperationKind OperationKind);
Member of: ICCTriggerTypeBuilder interface
Removes the item from the type restriction list for this element trigger type
Method
Sub RemoveRestriction(RestrictionType As Variant)
HRESULT RemoveRestriction(const _variant_t& RestrictionType);
Member of: ICCTriggerTypeBuilder interface
Redefines the trigger type that is represented by this trigger type builder
Method
Function Replace([ Comment As String = "" ]) As CCTriggerType
ICCTriggerTypePtr Replace(_bstr_t Comment);
The trigger type must exist before it can be replaced.
You cannot rename a trigger using the ICCTriggerTypeBuilder interface. Once you set the Name of a trigger type builder, you can only use that builder to create a new trigger type, and not to replace an existing one.
Adds the item to the type restriction list for this element trigger type
Method
Sub RestrictBy(RestrictionType As Variant)
HRESULT RestrictBy(const _variant_t& RestrictionType);
Member of: ICCTriggerTypeBuilder 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, containing 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").
Member of: ICCTriggerTypeBuilder interface
Gets the VOB that contains this trigger type
Read-only property
Property VOB As CCVOB