Project: stp

com.ibm.rational.wvcm.stp.cq
Interface CqProvider

All Superinterfaces:
Provider, StpProvider

public interface CqProvider
extends StpProvider

An extension of the StpProvider interface with additions specific to ClearQuest databases.


Nested Class Summary
static interface CqProvider.CqProductInfo
          An extension of the StpProvider.StpProductInfo interface specifying the additional information available from a ClearQuest repository.
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpProvider
StpProvider.Domain, StpProvider.NotifyAuthenticatedOption, StpProvider.NotifyBusyOption, StpProvider.StpCallback, StpProvider.StpProductInfo
 
Field Summary
static List<CqContextResource> AUTO
          A distinguished instance of List for use in the various CqContextResource operations that take a delivery order parameter.
static String CQ_ONLY_PROVIDER_CLASS
          The name of a CqProvider class whose instances provide access only to ClearQuest objects via a local installation of ClearQuest.
static List<CqContextResource> DELIVER
          A distinguished instance of List for use in the various CqContextResource operations that take a delivery order parameter.
static List<CqContextResource> DELIVER_ALL
          A distinguished instance of List for use in the various CqContextResource operations that take a delivery order parameter.
static List<CqContextResource> HOLD
          A distinguished instance of List for use in the various CqContextResource operations that take a delivery order parameter.
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpProvider
IS_DISCONNECTED_KEY, IS_DISCONNECTED_VALUE, NOT_DISCONNECTED_VALUE, PROVIDER_CLASS, SERVER_URL_KEY, USER_COUNTRY_KEY, USER_LANGUAGE_KEY, USER_VARIANT_KEY
 
Method Summary
 CqQuery.DisplayField buildDisplayField(CqFieldDefinition... path)
          Constructs a visible DisplayField object for defining Query display fields
 CqQuery.DisplayField buildDisplayField(CqFieldDefinition[] path, boolean isVisible)
          Constructs a new DisplayField object for this Query proxy
 CqQuery.FilterLeaf buildFilterLeaf(CqFieldDefinition[] source, CqQuery.Filter.Operation operation, Object... targets)
          Constructs a new CqQuery.FilterLeaf object to be used in the creation or modification of a query's filtering expression.
 CqQuery.FilterNode buildFilterNode(CqQuery.Filter.Operation operation, CqQuery.Filter... operands)
          Constructs a new CqQuery.FilterNode object for the purpose of creating or modifying the filtering expression of a query.
 CqQuery.FilterNode buildFilterNode(CqQuery.Filter.Operation operation, CqQuery.FilterLeaf... operands)
          Constructs a new CqQuery.FilterNode object for the purpose of creating or modifying the filtering expression of a query.
 CqQuery.FilterNode buildFilterNode(CqQuery.Filter.Operation operation, CqQuery.FilterNode... operands)
          Constructs a new CqQuery.FilterNode object for the purpose of creating or modifying the filtering expression of a query.
 CqAction cqAction(StpLocation location)
          Creates a proxy for a ClearQuest action resource.
 CqAttachment cqAttachment(StpLocation location)
          Creates a proxy for a ClearQuest attachment resource.
 CqAttachmentFolder cqAttachmentFolder(StpLocation location)
          Creates a proxy for a ClearQuest attachment folder resource.
 CqDbSet cqDbSet(StpLocation location)
          Creates a proxy for a ClearQuest database set resource.
 CqDynamicChoiceList cqDynamicChoiceList(StpLocation location)
          Creates a proxy for a ClearQuest dynamic choice list resource.
 CqFieldDefinition cqFieldDefinition(StpLocation location)
          Creates a proxy for a ClearQuest field definition resource.
<U> CqFieldValue<U>
cqFieldValue(PropertyNameList.PropertyName<U> name, CqFieldValue.ValueType type)
          Create a new CqFieldValue structure for a field of a given name and type.
 CqGroup cqGroup(StpLocation location)
          Creates a proxy for a ClearQuest group resource.
 CqHook cqHook(StpLocation location)
          Creates a proxy for a ClearQuest hook resource.
 CqQuery cqQuery(StpLocation location)
          Creates a proxy for a ClearQuest query resource.
 CqQueryFolder cqQueryFolder(StpLocation location)
          Creates a proxy for a ClearQuest query folder resource.
 CqQueryFolderItem cqQueryFolderItem(StpLocation location)
          Creates a proxy for a resource in a ClearQuest query folder.
 CqRecord cqRecord(StpLocation location)
          Creates a proxy for a ClearQuest record resource.
 CqRecordType cqRecordType(StpLocation location)
          Creates a proxy for a ClearQuest record-type resource.
 CqReplica cqReplica(StpLocation location)
          Creates a proxy for a ClearQuest replica resource.
 CqReport cqReport(StpLocation location)
          Creates a proxy for a ClearQuest report resource.
 CqReportFormat cqReportFormat(StpLocation location)
          Creates a proxy for a ClearQuest report format resource.
 CqUser cqUser(StpLocation location)
          Creates a proxy for a ClearQuest user resource.
 CqUserDb cqUserDb(StpLocation location)
          Creates a proxy for a ClearQuest user database resource.
 ResourceList<CqDbSet> doGetDbSetList(Feedback feedback)
          Returns a list of database sets accessible from this provider.
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpProvider
buildAccessControlEntry, buildProxy, buildProxy, callback, ccProvider, cqProvider, decodeSegment, encodeSegment, filePathLocation, filePathLocation, getAuthentication, getDefaultDomain, getDefaultRepository, getDefaultRepository, getHttpProxyHost, getHttpProxyPort, getInstantiationErrors, getIsDisconnected, getPropertyValueClass, getServerUrl, getUserLocale, getUserTimeZone, isSupported, pathLocation, proxyType, raise, raise, raise, setAuthentication, setDefaultDomain, setDefaultRepository, setDefaultRepository, setHttpProxy, setIsDisconnected, setServerUrl, setUserLocale, setUserTimeZone, stableSelector, stpLocation, stpLocation, stpProductInfo, stpProvider, stpRepository, terminate, userFriendlySelector
 
Methods inherited from interface javax.wvcm.Provider
buildProxy, folder, initArgs, initialize, location, relativeRootLocation, resource, resourceList, rootLocation
 

Field Detail

AUTO

static final List<CqContextResource> AUTO
A distinguished instance of List for use in the various CqContextResource operations that take a delivery order parameter. It indicates that resources modified by the operation are to be delivered in an unspecified order. But the delivery is to be attempted only if the change context did not contain the resource targeted by the operation. If the change context already contained the targeted resource when the operation started, no delivery is attempted. Thus AUTO behaves like DELIVER_ALL or HOLD depending on the content of the change context at the start of the operation.

Where an interface defines a second method that adds only a delivery order List parameter to the first, the first method's behavior is defined as if the second method had been passed this special instance. For example, under this convention, CqContextResource.doWriteProperties(Feedback) is defined as

 return doWriteProperties(feedback, CqProvider.AUTO);
 


CQ_ONLY_PROVIDER_CLASS

static final String CQ_ONLY_PROVIDER_CLASS
The name of a CqProvider class whose instances provide access only to ClearQuest objects via a local installation of ClearQuest. Pass this name to ProviderFactory.createProvider to obtain an object that implements this interface.

See Also:
Constant Field Values

DELIVER

static final List<CqContextResource> DELIVER
A distinguished instance of List for use in the various CqContextResource operations that take a delivery order parameter. It indicates that any resource targeted by the current operation is to be delivered at the successful termination of the operation.


DELIVER_ALL

static final List<CqContextResource> DELIVER_ALL
A distinguished instance of List for use in the various CqContextResource operations that take a delivery order parameter. It indicates that all modified resources in the change context are to be delivered in an unspecified order.


HOLD

static final List<CqContextResource> HOLD
A distinguished instance of List for use in the various CqContextResource operations that take a delivery order parameter. It indicates that modified resources in the change context are not to be delivered, but are to be held in the change context until the next explicit delivery request.

Method Detail

buildDisplayField

CqQuery.DisplayField buildDisplayField(CqFieldDefinition... path)
Constructs a visible DisplayField object for defining Query display fields

Parameters:
path - A CqFieldDefinition[] specifying the field path for the display field. The first entry of the array must be a CqFieldDefinition for a field of the query's primary record type. Entry N is allowed only if entry N-1 is a field of type CqFieldValue.ValueType.RESOURCE or CqFieldValue.ValueType.RESOURCE_LIST and entry N is a field of the record type named by the CqFieldDefinition.REFERENCED_RECORD_TYPE
Returns:
A DisplayField object for specifying a column of the result set of a query.

buildDisplayField

CqQuery.DisplayField buildDisplayField(CqFieldDefinition[] path,
                                       boolean isVisible)
Constructs a new DisplayField object for this Query proxy

Parameters:
path - The field path for the display field (see buildDisplayField(CqFieldDefinition[]))
isVisible - Whether or not the display field is to be visible
Returns:
A DisplayField object for specifying a column of the result set of a query initialized to the given path a visibility.

buildFilterLeaf

CqQuery.FilterLeaf buildFilterLeaf(CqFieldDefinition[] source,
                                   CqQuery.Filter.Operation operation,
                                   Object... targets)
Constructs a new CqQuery.FilterLeaf object to be used in the creation or modification of a query's filtering expression.

Parameters:
operation - The comparison Operation code for this filter node. Must not be null.
source - The field path representing the left operand of the operation. See CqQuery.FilterLeaf.getSource() documentation for more discussion of field paths. Must not be null.
targets - An array of righthand side target types/values suitable as an argument to CqQuery.FilterLeaf.setTargets(Object[])
Returns:
A CqQuery.FilterLeaf object specifying the comparison of a field value against a target value

buildFilterNode

CqQuery.FilterNode buildFilterNode(CqQuery.Filter.Operation operation,
                                   CqQuery.Filter... operands)
Constructs a new CqQuery.FilterNode object for the purpose of creating or modifying the filtering expression of a query.

Parameters:
operation - Either CqQuery.Filter.Operation.CONJUNCTION or CqQuery.Filter.Operation.DISJUNCTION. Must not be null.
operands - The filter subexpressions to be combined to form a new filter expression. Must not be null.
Returns:
A CqQuery.FilterNode object for specifying the logical combination of filtering subexpressions

buildFilterNode

CqQuery.FilterNode buildFilterNode(CqQuery.Filter.Operation operation,
                                   CqQuery.FilterLeaf... operands)
Constructs a new CqQuery.FilterNode object for the purpose of creating or modifying the filtering expression of a query.

Parameters:
operation - Either CqQuery.Filter.Operation.CONJUNCTION or CqQuery.Filter.Operation.DISJUNCTION. Must not be null.
operands - The filter subexpressions to be combined to form a new filter expression. Must not be null.
Returns:
A CqQuery.FilterNode object for specifying the logical combination of filtering subexpressions

buildFilterNode

CqQuery.FilterNode buildFilterNode(CqQuery.Filter.Operation operation,
                                   CqQuery.FilterNode... operands)
Constructs a new CqQuery.FilterNode object for the purpose of creating or modifying the filtering expression of a query.

Parameters:
operation - Either CqQuery.Filter.Operation.CONJUNCTION or CqQuery.Filter.Operation.DISJUNCTION. Must not be null.
operands - The filter subexpressions to be combined to form a new filter expression. Must not be null.
Returns:
A CqQuery.FilterNode object for specifying the logical combination of filtering subexpressions

cqAction

CqAction cqAction(StpLocation location)
Creates a proxy for a ClearQuest action resource.

Parameters:
location - StpLocation for a ClearQuest action.
Returns:
The new CqAction proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqAttachment

CqAttachment cqAttachment(StpLocation location)
Creates a proxy for a ClearQuest attachment resource.

Parameters:
location - StpLocation for a ClearQuest attachment.
Returns:
The new CqAttachment proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqAttachmentFolder

CqAttachmentFolder cqAttachmentFolder(StpLocation location)
Creates a proxy for a ClearQuest attachment folder resource.

Parameters:
location - StpLocation for a ClearQuest attachment folder.
Returns:
The new CqAttachmentFolder proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqDbSet

CqDbSet cqDbSet(StpLocation location)
Creates a proxy for a ClearQuest database set resource.

Parameters:
location - StpLocation for a ClearQuest db-set.
Returns:
The new CqDbSet proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqDynamicChoiceList

CqDynamicChoiceList cqDynamicChoiceList(StpLocation location)
Creates a proxy for a ClearQuest dynamic choice list resource.

Parameters:
location - StpLocation for a ClearQuest dynamic choice list.
Returns:
The new CqDynamicChoiceList proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqFieldDefinition

CqFieldDefinition cqFieldDefinition(StpLocation location)
Creates a proxy for a ClearQuest field definition resource.

Parameters:
location - StpLocation for a ClearQuest field definition.
Returns:
The new CqFieldDefinition proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqFieldValue

<U> CqFieldValue<U> cqFieldValue(PropertyNameList.PropertyName<U> name,
                                 CqFieldValue.ValueType type)
Create a new CqFieldValue structure for a field of a given name and type.

Parameters:
name - The PropertyName for the field.
type - The type of the field.
Returns:
A CqFieldValue structure.

cqGroup

CqGroup cqGroup(StpLocation location)
Creates a proxy for a ClearQuest group resource.

Parameters:
location - StpLocation for a ClearQuest group.
Returns:
The new CgGroup proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqHook

CqHook cqHook(StpLocation location)
Creates a proxy for a ClearQuest hook resource.

Parameters:
location - StpLocation for a ClearQuest hook.
Returns:
The new CgHook proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqQuery

CqQuery cqQuery(StpLocation location)
Creates a proxy for a ClearQuest query resource.

Parameters:
location - StpLocation for a ClearQuest query.
Returns:
The new Query proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqQueryFolder

CqQueryFolder cqQueryFolder(StpLocation location)
Creates a proxy for a ClearQuest query folder resource.

Parameters:
location - StpLocation for a ClearQuest query folder.
Returns:
The new CqQueryFolder proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqQueryFolderItem

CqQueryFolderItem cqQueryFolderItem(StpLocation location)
Creates a proxy for a resource in a ClearQuest query folder.

Parameters:
location - StpLocation for a ClearQuest query folder item.
Returns:
The new CqQueryFolderItem proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqRecord

CqRecord cqRecord(StpLocation location)
Creates a proxy for a ClearQuest record resource.

Parameters:
location - StpLocation for a ClearQuest record.
Returns:
The new CqRecord proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqRecordType

CqRecordType cqRecordType(StpLocation location)
Creates a proxy for a ClearQuest record-type resource.

Parameters:
location - StpLocation for a ClearQuest record-type.
Returns:
The new CqRecordType proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqReplica

CqReplica cqReplica(StpLocation location)
Creates a proxy for a ClearQuest replica resource.

Parameters:
location - StpLocation for a ClearQuest replica.
Returns:
The new CqReplica proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqReport

CqReport cqReport(StpLocation location)
Creates a proxy for a ClearQuest report resource.

Parameters:
location - StpLocation for a ClearQuest report.
Returns:
The new CqReport proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqReportFormat

CqReportFormat cqReportFormat(StpLocation location)
Creates a proxy for a ClearQuest report format resource.

Parameters:
location - StpLocation for a ClearQuest report format.
Returns:
The new CqReportFormat proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqUser

CqUser cqUser(StpLocation location)
Creates a proxy for a ClearQuest user resource.

Parameters:
location - StpLocation for a ClearQuest user.
Returns:
The new CqUser proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

cqUserDb

CqUserDb cqUserDb(StpLocation location)
Creates a proxy for a ClearQuest user database resource.

Parameters:
location - StpLocation for a ClearQuest user database.
Returns:
The new CqUserDb proxy.
Throws:
WvcmException - if StpLocation is not a ClearQuest resource location.

doGetDbSetList

ResourceList<CqDbSet> doGetDbSetList(Feedback feedback)
                                     throws WvcmException
Returns a list of database sets accessible from this provider.

Parameters:
feedback - The CqDbSet properties to be included on each returned CqDbSet proxy. If not null, an attempt will be made to log into each database set (using credentials provided by the provider's Callback for the database set). If login to a database set is not successful, the resource error field of the corresponding CqDbSet proxy will be non-null and contain the exception thrown by the provider's Callback object.

To construct a list of accessible user databases, request the CqDbSet.ACCESSIBLE_DATABASES property from each database set.

Returns:
A list of CqDbSet proxies for the potentially accessible database sets.
Throws:
WvcmException - If an error other than a failed login are detected. If login to a master database is required (because properties have been requested) and the login fails, a proxy for the database set is included in the result list, but the value of CqDbSet.getResourceError() will be non-null and that proxy will contain none of the requested properties.

Generated Fri 5-Nov-2010 03:50 AM

Copyright © IBM 2010. All rights reserved.