Project: stp

Package com.ibm.rational.wvcm.stp.cq

Extensions to the Workspace Versioning and Configuration Management (WVCM) API providing access to ClearQuest repositories.

See:
          Description

Interface Summary
CqAction An object that represents a method to be applied to an CqRecord.
CqAttachment A proxy for an attachment resource.
CqAttachmentFolder A folder that contains the attachments associated with an attachment field of a record and, hence, the value of such a record field.
CqContextResource A CqContextResource is a ClearQuest user database resource that may be temporarily held in a change context while it is being modified and before those modifications are committed to the database.
CqDb An interface for accessing administrative information regarding a login to a ClearQuest database; common to both db-sets and user databases.
CqDbSet A collection of user database resources.
CqDynamicChoiceList A proxy for a ClearQuest dynamic choice list
CqFieldDefinition A client proxy for a field definition metadata object.
CqFieldValue<T> The representation for the value of a record field as an extended StpProperty object.
CqGroup Interface for ClearQuest group resources.
CqHistoryFieldValue An extension of the CqFieldValue StpProperty interface representing the value of a ClearQuest record history field.
CqHit Information about one record matching by a full-text search query.
CqHitSet The interface to the results of a CqUserDb.doFullTextSearch invocation.
CqHook A schema-defined script to be executed during the application of an Action to an actionable resource.
CqProvider An extension of the StpProvider interface with additions specific to ClearQuest databases.
CqProvider.CqProductInfo An extension of the StpProvider.StpProductInfo interface specifying the additional information available from a ClearQuest repository.
CqQuery A proxy interface for ClearQuest query and chart resources.
CqQuery.ChartOptions An extension of the CommonOptions interface specifying an additional set of parameters applying only to the generation of charts.
CqQuery.CommonOptions An interface specifying a set of optional parameters that may be passed to CqQuery.doExecute, CqQuery.doMakeChart, CqRecordType.doQuery, or CqReport.doMakeReport to control the execution of queries and the generation of charts and reports.
CqQuery.DisplayField The description of a column of the result set generated by a query.
CqQuery.FileOptions An interface through which a client may, optionally, specify values for various attributes that control the behavior of executing a query to a stream.
CqQuery.Filter A query filter expression or a subexpression thereof.
CqQuery.FilterLeaf A field/value comparison within a query filter expression; the leaf of a query filter expression.
CqQuery.FilterNode The conjunction or disjunction of subexpressions within a query filter expression.
CqQuery.ListOptions An extension of the CommonOptions interface specifying an additional set of parameters applying only to the generation of query result sets.
CqQueryFolder A proxy for a query folder.
CqQueryFolderItem A specification for an item in a query folder, which may be a query, chart, report, report format, or a nested query folder.
CqRecord A CqRecord resource proxy provides access to a record in a database, possibly through its change context.
CqRecordType A proxy for the specification of a record type in a database.
CqReplica A proxy interface for a ClearQuest replica.
CqReport A proxy interface for a ClearQuest report definition.
CqReportFormat An interface specification for the proxy for a ClearQuest report format resource.
CqResource Properties and methods common to all ClearQuest resources
CqResultSet An interface specifying the structure returned by CqQuery.doExecute and CqRecordType.doQuery to represent the results of executing a ClearQuest query.
CqRowData The interface for a row of a result set generated by the execution of a query.
CqUser The proxy interface for information stored in a DbSet for a single user.
CqUserDb A proxy for a ClearQuest user database In addition to representing the physical database, a CqUserDb object also represents the on-going ClearQuest session between the user and that database.
CqUserDb.SearchFilter A collection of SearchKey/target-value pairs that collectively define the filter for selecting objects for inclusion in a full-text search.
CqUserDb.SearchKey<T> The interface for an API object that may be used to define a filter for a full-text search of the database.
CqUserDbMember The properties supported by all members of a ClearQuest User Database.
CqUserInfo Read-only information about the currently logged-in user of a user database
 

Class Summary
CqQuery.ChartOptionsClass Instances of this class provide the default values for each attribute specified by the ChartOptions interface, which is the same behavior exhibited when using null for a ChartOptions object.
CqQuery.FileOptionsClass Instances of this class provide the default values for each attribute specified by the FileOptions interface, which is the same behavior exhibited when using null for a FileOptions parameter.
CqQuery.ListOptionsClass Instances of this class provide the default values for each attribute specified by the ListOptions interface, which is the same behavior exhibited when using null for a ListOptions object.
CqQueryFolder.GroupAccessRightsName A PropertyName class for requesting the applied or effective access rights for a specific group on this folder and, optionally, its nested folders
CqQueryFolder.UserAccessRightsName A PropertyName class for requesting the applied or effective access rights for a specific user on this folder and, optionally, its nested folders
CqRecord.FieldName<T> A subclass of PropertyName used for naming the record resource properties that are schema-defined fields of a ClearQuest record.
CqUserDb.NamedValueName An extension of the standard PropertyName that may be used by clients to access named values on the ClearQuest server as CM API properties of this database.
 

Enum Summary
CqAction.Type The type of an action, which places certain restrictions on its use.
CqDbSet.AuthenticationAlgorithm AuthenticationAlgorithm constants specify which authentication search strategy is selected when a Rational ClearQuest user logs on.
CqFieldDefinition.Requiredness An enumeration of the possible restrictions on assigning a value to a field.
CqFieldValue.ValidationStatus An enumeration indicating the validity of a field value.
CqFieldValue.ValueStatus An enumeration indicating whether or not a field has a value.
CqFieldValue.ValueType An enumeration of the possible types of values that can be stored in a record field.
CqQuery.ChartOptions.ImageFormat The possible chart image formats
CqQuery.DisplayField.Aggregation Supported display field aggregate functions.
CqQuery.DisplayField.FieldType The value types for result set rows
CqQuery.DisplayField.Function The functions that can be applied to a DisplayField of type DATE_TIME
CqQuery.DisplayField.SortType Supported DisplayField sort options
CqQuery.Filter.Operation An enumeration of the logical operations and comparisons that can be used to combine the operands of a Filter subexpression.
CqQuery.FilterLeaf.TargetType A code indicating how the target of the comparison is being specified.
CqQuery.QueryType An enumeration of the possible types of queries.
CqQueryFolderItem.OverwriteMode An enumeration of the values for specifying what doCopy and/or doMove should do when a resource already exists at the targeted destination.
CqRecord.Class An enumeration of the possible types of records; state-based or stateless.
CqUser.AuthenticationMode An enumeration of the authentication modes available to a user
CqUserDb.DateLimit A DateLimit SearchKey limits the search to just those objects whose creation or modification time are in a target range.
CqUserDb.FindMode Enumerates the options for restricting the finding of records based on their record class.
CqUserDb.SearchLevel Specifies a simple search string
CqUserDb.VendorType An enumeration of the types of vendors of supported databases
CqUserDb.WordMode WordMode SearchKeys limit the search results to just those objects that contain the targeted words associated with the WordMode key in the filter.
 

Package com.ibm.rational.wvcm.stp.cq Description

Extensions to the Workspace Versioning and Configuration Management (WVCM) API providing access to ClearQuest repositories.


Generated Tue 10-Jun-2014 09:00 AM

Copyright © IBM 2014. All rights reserved.