Package com.telelogic.cs.api

The classes in the package are available to any in-process trigger scripts, i.e., those executed with bsf.

See:
          Description

Interface Summary
CollectibleEvent  
JavaTrigger JavaTrigger is the interface class for any Java based trigger that will be executed by IBM Rational Change.
 

Class Summary
Attribute The value of an attribute.
AttributeDefinition Exposes properties of an attribute as defined in the lifecycle editor.
AttributeEvent Sent when an attribute is modified.
ChangeObject Represents an object at a particular moment in time.
ChangeRequest Represents a change request at a particular moment in time.
ChangeTriggerApi The API for BSF triggers to programmatically interact with the IBM Rational Change.
GeneralEvent Sent during any modification of an attribute, a submission, or transition.
KeywordString Finds and replaces keywords in a string with given replacement values.
OptionParser A simple options parser which separates command line options from arguments.
RelationEvent Sent when a relation is created or deleted.
ScheduledEvent Sent at a scheduled time if scheduled, BSF triggers are enabled in pt.cfg.
ScriptLogger Allows scripts to write to the event.log.
SubscriptionEvent Sent when a CR is modified and users are subscribed to that CR.
SubscriptionRelationEvent Sent when a relation to a CR is created and users are subscribed to that CR.
Task Represents a task at a particular moment in time.
TaskDetails Bundles a list of associated tasks with more detailed status and error information.
TransitionEvent Sent when a change request is submitted or transitioned.
TriggerEvent The superclass for all "event" objects that are made available to in-process triggers.
TriggerEventContext TriggerEventContext holds the executing Java trigger's args, TiggerEvent, ChangeTriggerApi, and ScriptLogger objects.
User An immutable view of single user.
 

Enum Summary
Attribute.Type Constants for the different possible types of attributes.
 

Exception Summary
CreateException Indicates that a new object--probably a change request or task--could not be created.
IdException If a non-existing CR or task ID is looked up.
ModifyException If a change to CR or task fails.
PartialModifyException If a CR was partially modified, i.e., some, but not all, of its attributes were modified.
SyntaxException If a query string contains syntax errors.
TokenException If a malformed, stale, or otherwise bad token is given.
 

Package com.telelogic.cs.api Description

The classes in the package are available to any in-process trigger scripts, i.e., those executed with bsf. Most interaction is done through ChangeTriggerApi.

When a trigger script is invoked it can access several variables with bsf.lookupBean('variable name'), where possible variables are:



© Copyright IBM Corporation 2000, 2009
US Government Users Restricted Rights--Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Notices