|
Project: stp | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CqProvider
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. |
|
|
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 javax.wvcm.Provider |
---|
buildProxy, folder, initArgs, initialize, location, relativeRootLocation, resource, resourceList, rootLocation |
Field Detail |
---|
static final List<CqContextResource> AUTO
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);
static final String CQ_ONLY_PROVIDER_CLASS
static final List<CqContextResource> DELIVER
static final List<CqContextResource> DELIVER_ALL
static final List<CqContextResource> HOLD
Method Detail |
---|
CqQuery.DisplayField buildDisplayField(CqFieldDefinition... path)
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
CqQuery.DisplayField buildDisplayField(CqFieldDefinition[] path, boolean isVisible)
path
- The field path for the display field (see
buildDisplayField(CqFieldDefinition[])
)isVisible
- Whether or not the display field is to be visible
CqQuery.FilterLeaf buildFilterLeaf(CqFieldDefinition[] source, CqQuery.Filter.Operation operation, Object... targets)
CqQuery.FilterLeaf
object to be used in the
creation or modification of a query's filtering expression.
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[])
CqQuery.FilterNode buildFilterNode(CqQuery.Filter.Operation operation, CqQuery.Filter... operands)
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.
CqQuery.FilterNode buildFilterNode(CqQuery.Filter.Operation operation, CqQuery.FilterLeaf... operands)
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.
CqQuery.FilterNode buildFilterNode(CqQuery.Filter.Operation operation, CqQuery.FilterNode... operands)
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.
CqAction cqAction(StpLocation location)
location
- StpLocation for a ClearQuest action.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqAttachment cqAttachment(StpLocation location)
location
- StpLocation for a ClearQuest attachment.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqAttachmentFolder cqAttachmentFolder(StpLocation location)
location
- StpLocation for a ClearQuest attachment folder.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqDbSet cqDbSet(StpLocation location)
location
- StpLocation for a ClearQuest db-set.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqDynamicChoiceList cqDynamicChoiceList(StpLocation location)
location
- StpLocation for a ClearQuest dynamic choice list.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqFieldDefinition cqFieldDefinition(StpLocation location)
location
- StpLocation for a ClearQuest field definition.
WvcmException
- if StpLocation is not a ClearQuest resource
location.<U> CqFieldValue<U> cqFieldValue(PropertyNameList.PropertyName<U> name, CqFieldValue.ValueType type)
name
- The PropertyName for the field.type
- The type of the field.
CqGroup cqGroup(StpLocation location)
location
- StpLocation for a ClearQuest group.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqHook cqHook(StpLocation location)
location
- StpLocation for a ClearQuest hook.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqQuery cqQuery(StpLocation location)
location
- StpLocation for a ClearQuest query.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqQueryFolder cqQueryFolder(StpLocation location)
location
- StpLocation for a ClearQuest query folder.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqQueryFolderItem cqQueryFolderItem(StpLocation location)
location
- StpLocation for a ClearQuest query folder item.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqRecord cqRecord(StpLocation location)
location
- StpLocation for a ClearQuest record.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqRecordType cqRecordType(StpLocation location)
location
- StpLocation for a ClearQuest record-type.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqReplica cqReplica(StpLocation location)
location
- StpLocation for a ClearQuest replica.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqReport cqReport(StpLocation location)
location
- StpLocation for a ClearQuest report.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqReportFormat cqReportFormat(StpLocation location)
location
- StpLocation for a ClearQuest report format.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqUser cqUser(StpLocation location)
location
- StpLocation for a ClearQuest user.
WvcmException
- if StpLocation is not a ClearQuest resource
location.CqUserDb cqUserDb(StpLocation location)
location
- StpLocation for a ClearQuest user database.
WvcmException
- if StpLocation is not a ClearQuest resource
location.ResourceList<CqDbSet> doGetDbSetList(Feedback feedback) throws WvcmException
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.
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 Tue 22-May-2012 12:04 PM | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |