- 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[], boolean) - 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.PackageEvent
-
- 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.
- getAttachmentLink(String, String) - Method in class com.telelogic.cs.webservices.ChangeService
-
Get the link for downloading an Attachment.
- 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
-
- 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 (
Attribute
s that were modified during the submission, transition or attribute
modification.
- getAttributes() - Method in class com.telelogic.cs.api.GeneralEvent
-
Gets an array of (
Attribute
s that were modified during the submission, transition or attribute
modification.
- getAttributes() - Method in class com.telelogic.cs.api.SubscriptionEvent
-
Gets an array of (
Attribute
s 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 (
Attribute
s 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.
- getErrorLog() - Method in class com.telelogic.cs.api.PackageEvent
-
Package installation and uninstallation normally doesn't write to the
normal event.log.
- 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.
- getInfoLog() - Method in class com.telelogic.cs.api.PackageEvent
-
Package installation and uninstallation normally doesn't write to the
normal event.log.
- 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
-
- 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.
- getReleationCreationStoppedMessage() - Method in class com.telelogic.cs.api.RelationEvent
-
Get the relation creation stop message
- getReleationDeletionStoppedMessage() - Method in class com.telelogic.cs.api.RelationEvent
-
Get the relation deletion stop message
- 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
Attribute
s for all the attributes requested to be sent to the trigger.
- getRequestedAttributes() - Method in interface com.telelogic.cs.api.CollectibleEvent
-
Gets an array of
Attribute
s for all the attributes requested to be sent to the trigger.
- getRequestedAttributes() - Method in class com.telelogic.cs.api.GeneralEvent
-
Gets an array of
Attribute
s for all the attributes requested to be sent to the trigger.
- getRequestedAttributes() - Method in class com.telelogic.cs.api.SubscriptionEvent
-
Gets an array of
Attribute
s for all the attributes requested to be sent to the trigger.
- getRequestedAttributes() - Method in class com.telelogic.cs.api.TransitionEvent
-
Gets an array of
Attribute
s 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.
- getStatusLog() - Method in class com.telelogic.cs.api.PackageEvent
-
Package installation and uninstallation normally doesn't write to the
normal event.log.
- 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.PackageEvent
-
- 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.PackageEvent
-
- 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.