A B C D E F G H I J K L M O P Q R S T U V W

A

addAdminNotes(String, String, ArrayOfAdminNote) - Method in class com.telelogic.cs.webservices.ChangeService
Allows admins to append notes to the transition log.
adminDelete(String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Permanently deletes a CR from the database.
associateTask(String, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Associates an existing task to a change request.
Attribute - Class in com.telelogic.cs.api
The value of an attribute.
Attribute(String, String) - Constructor for class com.telelogic.cs.api.Attribute
Constructs a new string attribute.
Attribute(String) - Constructor for class com.telelogic.cs.api.Attribute
Creates an empty attribute, that is one without a value.
Attribute(String, Date) - Constructor for class com.telelogic.cs.api.Attribute
Constructs a new date attribute.
Attribute(String, Boolean) - Constructor for class com.telelogic.cs.api.Attribute
Constructs a new boolean attribute.
Attribute.Type - Enum in com.telelogic.cs.api
Constants for the different possible types of attributes.
AttributeDefinition - Class in com.telelogic.cs.api
Exposes properties of an attribute as defined in the lifecycle editor.
AttributeEvent - Class in com.telelogic.cs.api
Sent when an attribute is modified.
AttributeEvent(User, User, String, String, Attribute, Attribute[]) - Constructor for class com.telelogic.cs.api.AttributeEvent
 

B

buildCrQuery(String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Constructs a query string for a specific CR.
buildTaskQuery(String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Constructs a query string for a specific task.

C

ChangeObject - Class in com.telelogic.cs.api
Represents an object at a particular moment in time.
ChangeObject(String, Map<String, Attribute>) - Constructor for class com.telelogic.cs.api.ChangeObject
 
ChangeRequest - Class in com.telelogic.cs.api
Represents a change request at a particular moment in time.
ChangeRequest(String, Map<String, Attribute>) - Constructor for class com.telelogic.cs.api.ChangeRequest
 
ChangeService - Class in com.telelogic.cs.webservices
The IBM Rational Change Web Service
ChangeService() - Constructor for class com.telelogic.cs.webservices.ChangeService
 
ChangeTriggerApi - Class in com.telelogic.cs.api
The API for BSF triggers to programmatically interact with the IBM Rational Change.
ChangeTriggerApi(CommonApi, ProcessService, TransitionService) - Constructor for class com.telelogic.cs.api.ChangeTriggerApi
Warning, this constructor is used by internally IBM Rational Change; do not call from trigger scripts.
collectAttributes(String, CollectibleEvent, String[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Collects and unifies attributes from certain event objects and the live attributes of the CR for that event.
CollectibleEvent - Interface in com.telelogic.cs.api
 
com.telelogic.cs.api - package com.telelogic.cs.api
The classes in the package are available to any in-process trigger scripts, i.e., those executed with bsf.
createAssociatedTask(String, String, Attribute[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Creates a new task and associates it to a change request.
createAssociatedTask(String, String, ArrayOfAttribute) - Method in class com.telelogic.cs.webservices.ChangeService
Creates a new CM task associated with the given change request.
CreateException - Exception in com.telelogic.cs.api
Indicates that a new object--probably a change request or task--could not be created.
CreateException(String, Throwable) - Constructor for exception com.telelogic.cs.api.CreateException
 
CreateException(Throwable) - Constructor for exception com.telelogic.cs.api.CreateException
 
CreateException(String) - Constructor for exception com.telelogic.cs.api.CreateException
 

D

debug(Object) - Method in class com.telelogic.cs.api.ScriptLogger
Print a debug message to the event.log file.
debug(Object, Throwable) - Method in class com.telelogic.cs.api.ScriptLogger
Print a debug message to the event.log file with a stack trace.
deleteAttachment(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Removes an attachment from its associated change request and deletes it.
deleteAttributes(String, String, String[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Deletes attributes from a change request.
deleteQuery(String, QueryType, String) - Method in class com.telelogic.cs.webservices.ChangeService
Deletes a saved CR query by name.
disassociateTask(String, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Disassociates a task from a change request.
downloadAttachment(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Downloads a single attachment from a CR.

E

equals(Object) - Method in class com.telelogic.cs.api.Attribute
 
equals(Object) - Method in class com.telelogic.cs.api.AttributeDefinition
 
equals(Object) - Method in class com.telelogic.cs.api.ChangeRequest
 
equals(Object) - Method in class com.telelogic.cs.api.KeywordString
 
equals(Object) - Method in class com.telelogic.cs.api.Task
 
error(Object) - Method in class com.telelogic.cs.api.ScriptLogger
Print an error message to the event.log file.
error(Object, Throwable) - Method in class com.telelogic.cs.api.ScriptLogger
Print an error message to the event.log file with a stack trace.

F

fail(String) - Method in class com.telelogic.cs.api.TriggerEvent
Indicates that the current trigger has failed.

G

GeneralEvent - Class in com.telelogic.cs.api
Sent during any modification of an attribute, a submission, or transition.
GeneralEvent(User, User, String, String, Attribute[], Attribute[]) - Constructor for class com.telelogic.cs.api.GeneralEvent
 
getAdminUser() - Method in class com.telelogic.cs.api.AttributeEvent
 
getAdminUser() - Method in class com.telelogic.cs.api.GeneralEvent
Gets the User object for the admin user.
getAdminUser() - Method in class com.telelogic.cs.api.RelationEvent
Gets the User object for the admin user.
getAdminUser() - Method in class com.telelogic.cs.api.ScheduledEvent
 
getAdminUser() - Method in class com.telelogic.cs.api.SubscriptionEvent
Gets the User object for the admin user.
getAdminUser() - Method in class com.telelogic.cs.api.SubscriptionRelationEvent
 
getAdminUser() - Method in class com.telelogic.cs.api.TransitionEvent
Gets the User object for the admin user.
getAdminUser() - Method in class com.telelogic.cs.api.TriggerEvent
Gets information about the admin user for the database the trigger fired in.
getAllStateDefs(String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets all state definitions for the current process, that is, the state definitions from each lifecycle.
getAllSubmitDetails(String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets all states that CRs can be submitted to, plus the label of the corresponding submit transition.
getAllSubmitStates(String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets all states that CRs can be submitted to.
getApi() - Method in class com.telelogic.cs.api.TriggerEventContext
Get the IBM Rational Change trigger API.
getArgs() - Method in class com.telelogic.cs.api.OptionParser
Gets all the arguments, i.e., all the strings that weren't options or option values.
getArgs() - Method in class com.telelogic.cs.api.TriggerEventContext
Get the arguments of the Java trigger.
getAssociatedTaskDetails(String, String, String[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the tasks associated with a change request and, in central server mode, details about offline databases and tasks.
getAssociatedTasks(String, String, String[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the tasks associated with a change request, if any.
getAssociatedTasks(String, String, ArrayOfString) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the tasks associated with a given change request.
getAttribute() - Method in class com.telelogic.cs.api.AttributeEvent
Gets a single Attribute that represents the attribute which caused the AttributeTrigger to fire.
getAttribute(String) - Method in class com.telelogic.cs.api.ChangeObject
Gets an attribute for this object at the time it was looked up.
getAttribute(String) - Method in class com.telelogic.cs.api.ChangeRequest
Gets an attribute for this change request at the time it was looked up.
getAttribute(String) - Method in class com.telelogic.cs.api.Task
Gets an attribute for this task at the time it was looked up.
getAttributeDefs(String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets all the attributes defined for the current CR process, including details like the label and type of each attribute.
getAttributeDefs(String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets all the attribute definitions for the current process.
getAttributes() - Method in class com.telelogic.cs.api.AttributeEvent
Same as getAttribute, but wraps the attribute as in array.
getAttributes() - Method in class com.telelogic.cs.api.ChangeObject
Gets all the attributes that were looked up with this object.
getAttributes() - Method in class com.telelogic.cs.api.ChangeRequest
Gets all the attributes that were looked up with this change request.
getAttributes(String, String, String[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets attribute values for a change request.
getAttributes() - Method in interface com.telelogic.cs.api.CollectibleEvent
Gets an array of (Attributes that were modified during the submission, transition or attribute modification.
getAttributes() - Method in class com.telelogic.cs.api.GeneralEvent
Gets an array of (Attributes that were modified during the submission, transition or attribute modification.
getAttributes() - Method in class com.telelogic.cs.api.SubscriptionEvent
Gets an array of (Attributes that were modified during the submission, transition or attribute modification.
getAttributes() - Method in class com.telelogic.cs.api.Task
Gets all the attributes that were looked up with this task.
getAttributes() - Method in class com.telelogic.cs.api.TransitionEvent
Gets an array of (Attributes that were modified during the submission, transition or attribute modification.
getAttributes(String, String, ArrayOfString) - Method in class com.telelogic.cs.webservices.ChangeService
Gets attributes values for a change request.
getBooleanValue() - Method in class com.telelogic.cs.api.Attribute
Gets the boolean value of this attribute if appropriate.
getCanAccessApplet() - Method in class com.telelogic.cs.api.User
Determine if the user can currently access the applet or not.
getContextDatabase() - Method in class com.telelogic.cs.api.User
Gets the context database that the user is currently logged into.
getCrid() - Method in class com.telelogic.cs.api.ChangeRequest
Gets the change request ID, a.k.a., problem number, for this change request.
getCrid() - Method in exception com.telelogic.cs.api.PartialModifyException
The CR that was partially modified.
getCvid() - Method in class com.telelogic.cs.api.ChangeObject
Gets the cvid for this object.
getDatabase() - Method in class com.telelogic.cs.api.User
Gets the database that the user is currently logged into.
getDateValue() - Method in class com.telelogic.cs.api.Attribute
Gets the date value of this attribute is appropriate.
getDbid(String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the database ID (DBID) for the database indicated by the token.
getDcmDelimiter(String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the DCM delimiter for the database indicated by the token.
getDcmDelimiter(String) - Method in class com.telelogic.cs.webservices.ChangeService
Get the DCM delimiter for the current database.
getDcmId(String) - Method in class com.telelogic.cs.webservices.ChangeService
Get the DCM identifier for the current database.
getEvent() - Method in class com.telelogic.cs.api.TriggerEventContext
Get the trigger event object.
getFailedAttributes() - Method in exception com.telelogic.cs.api.PartialModifyException
The attributes that were not modified on the CR.
getFailure() - Method in class com.telelogic.cs.api.TriggerEvent
Gets the failure message is fail was called.
getFormattedLastAccessedDate() - Method in class com.telelogic.cs.api.User
Gets the last accessed date as a formatted time string.
getFormattedTimeoutDate() - Method in class com.telelogic.cs.api.User
Gets the the time when the user will timeout as a formatted string.
getFromObjectId() - Method in class com.telelogic.cs.api.RelationEvent
Gets the id (CR - problem_number / Task - task_number / Object - cvid) of the object the relation is coming from.
getFromObjectId() - Method in class com.telelogic.cs.api.SubscriptionRelationEvent
Gets the id (CR - problem_number / Task - task_number / Object - cvid) of the object the relation is coming from.
getFromState() - Method in class com.telelogic.cs.api.TransitionEvent
Gets the state that the object is coming from (i.e, START_HERE, entered, assigned, etc)
getGroups() - Method in class com.telelogic.cs.api.User
Get the list of groups that the user is currently a member of.
getKeywords() - Method in class com.telelogic.cs.api.KeywordString
Returns all the unique keywords in the underlying string.
getLabel() - Method in class com.telelogic.cs.api.AttributeDefinition
A display name for the attribute.
getLastAccessedDate() - Method in class com.telelogic.cs.api.User
Gets the time the user last had access to the server.
getLifecycles(String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the names of all lifecycles in the CR process.
getListboxDefaultValue(String) - Method in class com.telelogic.cs.webservices.ChangeService
Used to get the default display value for listboxes, which is normally "Any".
getListboxEntries(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the possible values for a given listbox.
getLog() - Method in class com.telelogic.cs.api.TriggerEventContext
Get the ScriptLogger object.
getLoginInfo() - Method in class com.telelogic.cs.webservices.ChangeService
Returns the databases and roles a user can use to log on to Rational Change.
getMessage(String, String...) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets a localized message from the default resource bundle.
getMessageFrom(String, String, String...) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets a localized message from a custom resource bundle.
getName() - Method in class com.telelogic.cs.api.Attribute
Gets the name of this attribute.
getName() - Method in class com.telelogic.cs.api.AttributeDefinition
The name of this attribute definition, e.g., problem_number.
getName() - Method in class com.telelogic.cs.api.RelationEvent
Gets the name of the relation which caused this trigger to fire (i.e: duplicate).
getName() - Method in class com.telelogic.cs.api.SubscriptionRelationEvent
Gets the name of the relation which caused this trigger to fire (i.e: duplicate).
getNextStates(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Determines the next possible states that a CR can be transitioned to by the current user.
getObjectId() - Method in class com.telelogic.cs.api.AttributeEvent
Gets the object id (problem_number) of the object which caused the trigger to fire.
getObjectId() - Method in interface com.telelogic.cs.api.CollectibleEvent
Gets the object id (problem_number) of the object which caused the trigger to fire.
getObjectId() - Method in class com.telelogic.cs.api.GeneralEvent
Gets the object id (problem_number) of the object which caused the trigger to fire.
getObjectId() - Method in class com.telelogic.cs.api.SubscriptionEvent
Gets the object id (problem_number) of the object which caused the trigger to fire.
getObjectId() - Method in class com.telelogic.cs.api.TransitionEvent
Gets the object id (problem_number) of the object which caused the trigger to fire.
getObjectType() - Method in class com.telelogic.cs.api.AttributeEvent
Gets the type of object that this trigger is firing for.
getObjectType() - Method in class com.telelogic.cs.api.GeneralEvent
Gets the type of object that this trigger is firing for.
getObjectType() - Method in class com.telelogic.cs.api.SubscriptionEvent
Gets the type of object that this trigger is firing for.
getObjectType() - Method in class com.telelogic.cs.api.TransitionEvent
Gets the type of object that this trigger is firing for.
getOfflineDatabases() - Method in class com.telelogic.cs.api.TaskDetails
The list of the user's databases that were offline when the associated tasks were looked up.
getOfflineTaskIds() - Method in class com.telelogic.cs.api.TaskDetails
A best guess of the tasks that were not returned, but probably should have been.
getOption(String) - Method in class com.telelogic.cs.api.OptionParser
Gets a specific option by name.
getOptions() - Method in class com.telelogic.cs.api.OptionParser
Gets all the options, i.e., the strings that started with a "-" and their values that followed.
getPrettyRole() - Method in class com.telelogic.cs.api.User
Gets the user's role.
getPrivileges() - Method in class com.telelogic.cs.api.User
Get an immutable list of the user's privileges (CM roles).
getQueryBuilderUrl(String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets a URL to the new query dialog.
getQueryDefs(String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the saved CR queries available to this user.
getReadSecurityValue() - Method in class com.telelogic.cs.api.User
Gets the user's read security value.
getRealName() - Method in class com.telelogic.cs.api.User
Same as getUserDisplayName().
getRelatedFrom(String, String, String, String[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets related change requests where the relationship travels from the given change request to zero or more other change requests.
getRelatedFrom(String, String, String, ArrayOfString) - Method in class com.telelogic.cs.webservices.ChangeService
Gets related change requests where the relationship travels from the given change request to zero or more other change requests.
getRelatedTo(String, String, String, String[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets related change requests where the relationship travels to the given change request from zero or more other change requests.
getRelatedTo(String, String, String, ArrayOfString) - Method in class com.telelogic.cs.webservices.ChangeService
Gets related change requests where the relationship travels to the given change request from zero or more other change requests.
getReportDefs(String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the saved CR reports available to this user.
getReportUrl(String, QueryType, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the URL to run a saved CR report.
getRequestedAttributes() - Method in class com.telelogic.cs.api.AttributeEvent
Gets an array of Attributes for all the attributes requested to be sent to the trigger.
getRequestedAttributes() - Method in interface com.telelogic.cs.api.CollectibleEvent
Gets an array of Attributes for all the attributes requested to be sent to the trigger.
getRequestedAttributes() - Method in class com.telelogic.cs.api.GeneralEvent
Gets an array of Attributes for all the attributes requested to be sent to the trigger.
getRequestedAttributes() - Method in class com.telelogic.cs.api.SubscriptionEvent
Gets an array of Attributes for all the attributes requested to be sent to the trigger.
getRequestedAttributes() - Method in class com.telelogic.cs.api.TransitionEvent
Gets an array of Attributes for all the attributes requested to be sent to the trigger.
getRequiredAttributesForSubmit(String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the attributes that are required to submit a new CR into a given state.
getRequiredAttributesForSubmit(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the attributes that are required to submit a new CR into a given state.
getRequiredAttributesForTransition(String, String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the attributes that are required to transitions a CR from one state to another.
getRequiredAttributesForTransition(String, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the attributes that are required to transitions a CR from one state to another.
getRole() - Method in class com.telelogic.cs.api.User
The user's role.
getServerCharset(String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the name of the character set the server will send textual information in, e.g., "UTF-8".
getServerHostName(String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the host name of the server.
getServerPort(String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the port the web server is running on.
getServerProtocol(String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets the protocol the web server is using.
getShowUrl(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Returns the URL for showing the CR.
getStateDefsForLifecycle(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the state definitions for a specific lifecycle.
getStoppedTransitionMessage() - Method in class com.telelogic.cs.api.TransitionEvent
Gets the message passed to stopTransition.
getStringValue() - Method in class com.telelogic.cs.api.Attribute
Gets the string value of this attribute is appropriate.
getSubmitStatesForLifecycle(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the states that CRs can be submitted to for a particular lifecycle.
getSubmitUrl(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Returns the URL for submitting a CR.
getSubscriberList() - Method in class com.telelogic.cs.api.SubscriptionEvent
Gets an array of all the subscriber email addresses.
getSubscriberList() - Method in class com.telelogic.cs.api.SubscriptionRelationEvent
Gets an array of all the subscriber email addresses.
getSystemValue(String, String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets a system value as defined in pt.cfg.
getTaskAttributes(String, String, String[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets attribute values for a task.
getTaskId() - Method in class com.telelogic.cs.api.Task
Gets the task ID for this task.
getTasks() - Method in class com.telelogic.cs.api.TaskDetails
Gets the found associated tasks.
getTimeoutDate() - Method in class com.telelogic.cs.api.User
Gets the time when the user will become idle.
getToken() - Method in class com.telelogic.cs.api.User
Gets the users token.
getTokenlessShowFormUrl(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets a URL to a show for for the given change request.
getToObjectId() - Method in class com.telelogic.cs.api.RelationEvent
Gets the id (CR - problem_number / Task - task_number / Object - cvid) of the object the relation is going to.
getToObjectId() - Method in class com.telelogic.cs.api.SubscriptionRelationEvent
Gets the id (CR - problem_number / Task - task_number / Object - cvid) of the object the relation is going to.
getToState() - Method in class com.telelogic.cs.api.TransitionEvent
Gets the state that the object is going to (i.e, entered, assigned, etc)
getTransitionLog(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Returns a structured version of the transition log.
getTransitionUrl(String, String, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets a URL to the transition form to the requested state for a CR.
getTriggerType() - Method in class com.telelogic.cs.api.AttributeEvent
 
getTriggerType() - Method in class com.telelogic.cs.api.GeneralEvent
 
getTriggerType() - Method in class com.telelogic.cs.api.RelationEvent
 
getTriggerType() - Method in class com.telelogic.cs.api.ScheduledEvent
 
getTriggerType() - Method in class com.telelogic.cs.api.SubscriptionEvent
 
getTriggerType() - Method in class com.telelogic.cs.api.SubscriptionRelationEvent
 
getTriggerType() - Method in class com.telelogic.cs.api.TransitionEvent
 
getTriggerType() - Method in class com.telelogic.cs.api.TriggerEvent
Gets the type of this trigger, that is the type of action the spawned this trigger.
getTriggerUser() - Method in class com.telelogic.cs.api.AttributeEvent
 
getTriggerUser() - Method in class com.telelogic.cs.api.GeneralEvent
Gets the User object of the user which caused the trigger to fire.
getTriggerUser() - Method in class com.telelogic.cs.api.RelationEvent
Gets the User object of the user which caused the trigger to fire.
getTriggerUser() - Method in class com.telelogic.cs.api.ScheduledEvent
Returns the admin user since scheduled scripts are not initiated by a particular user.
getTriggerUser() - Method in class com.telelogic.cs.api.SubscriptionEvent
Gets the User object of the user which caused the trigger to fire.
getTriggerUser() - Method in class com.telelogic.cs.api.SubscriptionRelationEvent
 
getTriggerUser() - Method in class com.telelogic.cs.api.TransitionEvent
Gets the User object of the user which caused the trigger to fire.
getTriggerUser() - Method in class com.telelogic.cs.api.TriggerEvent
Gets information about this user that performed the action that fired this trigger.
getType() - Method in class com.telelogic.cs.api.Attribute
Gets the type of this attribute.
getType() - Method in class com.telelogic.cs.api.AttributeDefinition
The type of the attribute.
getType() - Method in class com.telelogic.cs.api.RelationEvent
Gets the type of relation the trigger is firing on.
getType() - Method in class com.telelogic.cs.api.SubscriptionRelationEvent
Gets the type of relation the trigger is firing on.
getUserDisplayName() - Method in class com.telelogic.cs.api.User
Get the user's display name as defined by the 'User Name Display' admin setting.
getUserName() - Method in class com.telelogic.cs.api.User
The name of the user.
getUserPreference(String, String, String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Gets a user preference, i.e., a user setable profile value.
getValueListboxEntries(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets the possible values for a given value-listbox.
getWebtype() - Method in class com.telelogic.cs.api.AttributeDefinition
Determines which "control" will be used when displaying this attribute in a web browser.

H

hashCode() - Method in class com.telelogic.cs.api.Attribute
 
hashCode() - Method in class com.telelogic.cs.api.AttributeDefinition
 
hashCode() - Method in class com.telelogic.cs.api.ChangeRequest
 
hashCode() - Method in class com.telelogic.cs.api.KeywordString
 
hashCode() - Method in class com.telelogic.cs.api.Task
 
hasPrivilege(String) - Method in class com.telelogic.cs.api.User
Determines if the user has a given privilege (CM role) or not.

I

IdException - Exception in com.telelogic.cs.api
If a non-existing CR or task ID is looked up.
IdException(String, Throwable) - Constructor for exception com.telelogic.cs.api.IdException
 
IdException(Throwable) - Constructor for exception com.telelogic.cs.api.IdException
 
IdException(String) - Constructor for exception com.telelogic.cs.api.IdException
 
info(Object) - Method in class com.telelogic.cs.api.ScriptLogger
Print an informational message to the event.log file.
info(Object, Throwable) - Method in class com.telelogic.cs.api.ScriptLogger
Print an informational message to the event.log file with a stack trace.
isCentralServer(String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Checks if Change is in central server mode.
isCreate() - Method in class com.telelogic.cs.api.RelationEvent
Is this relation trigger firing on behalf of a create operation or not.
isCreate() - Method in class com.telelogic.cs.api.SubscriptionRelationEvent
Is this relation trigger firing on behalf of a create operation or not.
isCrProcessAdmin() - Method in class com.telelogic.cs.api.User
Determines if the user has the CR Process admin role.
isDcmEnabled(String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Checks if DCM is enabled for the database indicated by the token.
isDcmEnabled(String) - Method in class com.telelogic.cs.webservices.ChangeService
Determine if the current database is DCM-enabled.
isEmpty() - Method in class com.telelogic.cs.api.Attribute
Checks is this attribute has a value or not.
isGroupMember(String) - Method in class com.telelogic.cs.api.User
Determines if the user is in a given group.
isQueriable() - Method in class com.telelogic.cs.api.AttributeDefinition
Indicates if this attribute should be shown in query related dialogs.
isReportable() - Method in class com.telelogic.cs.api.AttributeDefinition
Indicates if this attribute should be shown in report related dialogs.
isTransitionStopped() - Method in class com.telelogic.cs.api.TransitionEvent
Checks if the transition has been stopped by a trigger.

J

JavaTrigger - Interface in com.telelogic.cs.api
JavaTrigger is the interface class for any Java based trigger that will be executed by IBM Rational Change.

K

KeywordString - Class in com.telelogic.cs.api
Finds and replaces keywords in a string with given replacement values.
KeywordString(String) - Constructor for class com.telelogic.cs.api.KeywordString
Constructs a new KeywordString for the given template.

L

listAttachments(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Gets information about each of the attachments associated with a CR.
login(String, String, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Logs on a user and returns a unique token to identify them in future requests.
logMessage(String) - Method in class com.telelogic.cs.api.ScriptLogger
Logs an informational message.
logMessage(Throwable) - Method in class com.telelogic.cs.api.ScriptLogger
Logs a stack trace for an exception.
logout(String) - Method in class com.telelogic.cs.webservices.ChangeService
Logs out a user by releasing their checked out license immediately (without any license linger time).

M

ModifyException - Exception in com.telelogic.cs.api
If a change to CR or task fails.
ModifyException(String, Throwable) - Constructor for exception com.telelogic.cs.api.ModifyException
 
ModifyException(Throwable) - Constructor for exception com.telelogic.cs.api.ModifyException
 
ModifyException(String) - Constructor for exception com.telelogic.cs.api.ModifyException
 

O

OptionParser - Class in com.telelogic.cs.api
A simple options parser which separates command line options from arguments.

P

parse(String[]) - Static method in class com.telelogic.cs.api.OptionParser
Parses a list of strings to find any option/value pairs.
PartialModifyException - Exception in com.telelogic.cs.api
If a CR was partially modified, i.e., some, but not all, of its attributes were modified.
PartialModifyException(String, String, List<String>) - Constructor for exception com.telelogic.cs.api.PartialModifyException
 

Q

query(String, String, String[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Queries for change requests with an ad-hoc query string.
query(String, String, ArrayOfString) - Method in class com.telelogic.cs.webservices.ChangeService
Queries for change requests with an ad-hoc query string.

R

relate(String, String, String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Relates one change request to another through a given relationship name.
relate(String, String, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Relates one change request to another through a given relationship name.
relateNoSecurity(String, String, String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Like relate but disables both ACL and lifecycle security during the transition.
RelationEvent - Class in com.telelogic.cs.api
Sent when a relation is created or deleted.
RelationEvent(User, User, String, String, String, String, boolean) - Constructor for class com.telelogic.cs.api.RelationEvent
 
replaceKeywords(Map<String, String>) - Method in class com.telelogic.cs.api.KeywordString
Replaces keywords with the given replacements and return the resulting string.
run(TriggerEventContext) - Method in interface com.telelogic.cs.api.JavaTrigger
Interface method implemented by Java Triggers.
runQuery(String, QueryType, String, ArrayOfString) - Method in class com.telelogic.cs.webservices.ChangeService
Runs a saved CR query by name.

S

SCCS_ID - Static variable in class com.telelogic.cs.api.ChangeObject
 
ScheduledEvent - Class in com.telelogic.cs.api
Sent at a scheduled time if scheduled, BSF triggers are enabled in pt.cfg.
ScheduledEvent(User) - Constructor for class com.telelogic.cs.api.ScheduledEvent
 
ScriptLogger - Class in com.telelogic.cs.api
Allows scripts to write to the event.log.
ScriptLogger() - Constructor for class com.telelogic.cs.api.ScriptLogger
 
setAttributes(String, String, Attribute[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Modifies a change request by updating its attributes with the given values.
setAttributes(String, String, ArrayOfAttribute) - Method in class com.telelogic.cs.webservices.ChangeService
Modifies a change request by updating its attributes with the given values.
setTaskAttributes(String, String, Attribute[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Modifies a task by updating its attributes with the given values.
setTaskAttributes(String, String, ArrayOfAttribute) - Method in class com.telelogic.cs.webservices.ChangeService
Modifies a task by updating its attributes with the given values.
ssoLogin(String, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Logs on a user using a single sign on (SSO) token instead of a name and password.
stopTransition(String) - Method in class com.telelogic.cs.api.TransitionEvent
Pre-transition triggers can call this to prevent a transition from occurring.
submit(String, String, Attribute[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Submits and creates a new change request.
submit(String, String, ArrayOfAttribute) - Method in class com.telelogic.cs.webservices.ChangeService
Submits and creates a new change request.
SubscriptionEvent - Class in com.telelogic.cs.api
Sent when a CR is modified and users are subscribed to that CR.
SubscriptionEvent(User, User, String, String, List<String>, Attribute[], Attribute[]) - Constructor for class com.telelogic.cs.api.SubscriptionEvent
 
SubscriptionRelationEvent - Class in com.telelogic.cs.api
Sent when a relation to a CR is created and users are subscribed to that CR.
SubscriptionRelationEvent(User, User, String, String, String, String, boolean, List<String>) - Constructor for class com.telelogic.cs.api.SubscriptionRelationEvent
 
syncDatabase(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
In central server mode, waits for the central server to finish syncing all its CRs into a particular database.
SyntaxException - Exception in com.telelogic.cs.api
If a query string contains syntax errors.
SyntaxException(String) - Constructor for exception com.telelogic.cs.api.SyntaxException
 

T

Task - Class in com.telelogic.cs.api
Represents a task at a particular moment in time.
Task(String, Map<String, Attribute>) - Constructor for class com.telelogic.cs.api.Task
 
TaskDetails - Class in com.telelogic.cs.api
Bundles a list of associated tasks with more detailed status and error information.
TokenException - Exception in com.telelogic.cs.api
If a malformed, stale, or otherwise bad token is given.
TokenException(String, Throwable) - Constructor for exception com.telelogic.cs.api.TokenException
 
TokenException(String) - Constructor for exception com.telelogic.cs.api.TokenException
 
toString() - Method in class com.telelogic.cs.api.Attribute
Formats this attribute's value as a string, no matter what type it is.
toString() - Method in class com.telelogic.cs.api.AttributeDefinition
 
toString() - Method in class com.telelogic.cs.api.ChangeObject
 
toString() - Method in class com.telelogic.cs.api.ChangeRequest
 
toString() - Method in exception com.telelogic.cs.api.CreateException
 
toString() - Method in class com.telelogic.cs.api.KeywordString
 
toString() - Method in class com.telelogic.cs.api.Task
 
toString() - Method in class com.telelogic.cs.api.TriggerEvent
 
transition(String, String, String, Attribute[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Transitions a change request to one of its next states.
transition(String, String, String, ArrayOfAttribute) - Method in class com.telelogic.cs.webservices.ChangeService
Transitions a change request to one of its next states.
TransitionEvent - Class in com.telelogic.cs.api
Sent when a change request is submitted or transitioned.
TransitionEvent(User, User, String, String, String, String, Attribute[], Attribute[]) - Constructor for class com.telelogic.cs.api.TransitionEvent
 
transitionTask(String, String, String, Attribute[]) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Transitions a task to a new state.
TriggerEvent - Class in com.telelogic.cs.api
The superclass for all "event" objects that are made available to in-process triggers.
TriggerEvent() - Constructor for class com.telelogic.cs.api.TriggerEvent
 
TriggerEventContext - Class in com.telelogic.cs.api
TriggerEventContext holds the executing Java trigger's args, TiggerEvent, ChangeTriggerApi, and ScriptLogger objects.
TriggerEventContext(String[], TriggerEvent, ChangeTriggerApi, ScriptLogger) - Constructor for class com.telelogic.cs.api.TriggerEventContext
Construct a new TriggerEventContext.
TYPE - Static variable in class com.telelogic.cs.api.ScheduledEvent
 

U

unrelate(String, String, String, String) - Method in class com.telelogic.cs.api.ChangeTriggerApi
Breaks a relationship between two change requests.
unrelate(String, String, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Breaks the relationship between two change requests.
uploadAttachment(String, String, DataHandler, String, String) - Method in class com.telelogic.cs.webservices.ChangeService
Uploads a file and attaches it to a change request.
User - Class in com.telelogic.cs.api
An immutable view of single user.
User() - Constructor for class com.telelogic.cs.api.User
Do not call directly.
User(UserInfo) - Constructor for class com.telelogic.cs.api.User
Constructor to create a User object given a UserInfo object.

V

valueOf(String) - Static method in enum com.telelogic.cs.api.Attribute.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.telelogic.cs.api.Attribute.Type
Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(Object) - Method in class com.telelogic.cs.api.ScriptLogger
Print a warning message to the event.log file.
warn(Object, Throwable) - Method in class com.telelogic.cs.api.ScriptLogger
Print a warning message to the event.log file with a stack trace.

A B C D E F G H I J K L M O P Q R S T U V W

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