are defined in the CqProvider
interface as short-cuts for specifying the resources to be delivered. See the
documentation for CqProvider.HOLD
, CqProvider.AUTO
,
CqProvider.DELIVER
, and CqProvider.DELIVER_ALL
for more
information.
The properties that describe the state of the database's change context are
CONTEXT_IS_EMPTY
, MODIFIED_RESOURCES_LIST
, and
MORIBUND_RESOURCES_LIST
.
In addition to the operations that modify a CqContextResource, the following
methods are defined by CqUserDb to aid in the management of the database's
change context: doClearContext(Feedback)
,
doDeliver(Feedback, List)
, and doRevert(Feedback, List)
.
The user-friendly specification for the location of a user database has the
form
cq.userdb:<db-set>/<user-db>
- See Also:
CqContextResource
Nested Class Summary |
static class |
CqUserDb.DateLimit
A DateLimit SearchKey limits the search to just those objects whose
creation or modification time are in a target range. |
static class |
CqUserDb.FindMode
Enumerates the options for restricting the finding of records based on
their record class. |
static class |
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. |
static interface |
CqUserDb.SearchFilter
A collection of SearchKey/target-value pairs that collectively define the
filter for selecting objects for inclusion in a full-text search. |
static interface |
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. |
static class |
CqUserDb.SearchLevel
Specifies a simple search string |
static class |
CqUserDb.VendorType
An enumeration of the types of vendors of supported databases |
static class |
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. |
Method Summary |
CqUserDb.SearchFilter |
buildSearchFilter(String simpleString)
Constructs a SearchFilter instance with an initial simple specification
string. |
CqUserDb |
doClearContext(Feedback feedback)
Removes all modified and moribund resources from the change context of
this database; thereby reverting those resources to their previous,
unmodified or undeleted state. |
CqUserDb |
doDeliver(Feedback feedback,
List<CqContextResource> deliveryOrder)
Selectively delivers (commits) modified resources to the database and/or
destroys moribund resources from the database and removes them from the
change context. |
CqRecord |
doFindRecord(long dbid,
CqUserDb.FindMode mode,
Feedback feedback,
Location... possibleRecordTypes)
Searches the database for records having a given dbid. |
CqRecord |
doFindRecord(String displayName,
CqUserDb.FindMode mode,
Feedback feedback,
Location... possibleRecordTypes)
Searches the database for records having a given display name. |
ResourceList<CqResource> |
doFindSiteExtendedNames(StpLocation name,
Feedback feedback)
Returns a list of all the resources in the database whose names differ
from a given name only in their site extensions. |
CqHitSet |
doFullTextSearch(CqUserDb.SearchFilter searchFilter,
long... setParams)
Searches the indexed content of the database for objects that match a
given filter. |
CqUserDb |
doRevert(Feedback feedback,
List<CqContextResource> revertOrder)
Selectively reverts modified or moribund resources in this database's
change context to their previous, unmodified/undeleted state. |
CqUserDb |
doUpgradeUsersAndGroups(Feedback feedback)
Upgrades this database's user and group information to match that of its
db-set. |
CqQueryFolderItem |
doValidateLocation(CqQueryFolderItem item,
Feedback feedback)
Verifies that a CqQueryFolderItem of a given type can be created at a
given location. |
ResourceList<CqQuery> |
getAllCharts()
Returns the value of the ALL_CHARTS property as
defined by this proxy. |
StpProperty.List<StpProperty<String>> |
getAllNamedValues()
Returns the value of the ALL_NAMED_VALUES
property as defined by this proxy. |
ResourceList<CqQuery> |
getAllQueries()
Returns the value of the ALL_QUERIES property as
defined by this proxy. |
ResourceList<CqReport> |
getAllReports()
Returns the value of the ALL_REPORTS property as
defined by this proxy. |
long |
getCheckTimeoutInterval()
Returns the value of the CHECK_TIME
OUT_INTERVAL property as defined by this proxy. |
String |
getConnectOptions()
Returns the value of the CONNECT_OPTIONS
property as defined by this proxy. |
boolean |
getContextIsEmpty()
Returns the value of the CONTEXT_IS_EMPTY
property as defined by this proxy. |
String |
getDatabaseName()
Returns the value of the DATABASE_NAME property as
defined by this proxy. |
CqDbSet |
getDbSet()
Returns the value of the DB_SET property as defined by
this proxy. |
CqRecordType |
getDefaultRecordType()
Returns the value of the DEFAULT_RECORD_TYPE
property as defined by this proxy. |
ResourceList<CqDynamicChoiceList> |
getDynamicChoiceLists()
Returns the value of the DYNAMIC_CHOICE_LISTS property as
defined by this proxy. |
long |
getFeatureLevel()
Returns the value of the FEATURE_LEVEL property as
defined by this proxy. |
ResourceList<CqRecordType> |
getIndexedRecordTypes()
Returns the value of the
INDEXED_RECORD_TYPES property as defined by
this proxy. |
boolean |
getIsChartingEnabled()
Returns the value of the IS_CHARTING_ENABLED
property as defined by this proxy. |
boolean |
getIsFullTextSearchEnabled()
Returns the value of the
IS_FULL_TEXT_SEARCH_ENABLED property
as defined by this proxy. |
boolean |
getIsMultisiteActivated()
Returns the value of the
IS_MULTISITE_ACTIVATED property as
defined by this proxy. |
boolean |
getIsReportingEnabled()
Returns the value of the
IS_REPORTING_ENABLED property as defined by
this proxy. |
boolean |
getIsRequisiteProEnabled()
Returns the value of the
IS_REQUISITE_PRO_ENABLED property as
defined by this proxy. |
boolean |
getIsRestrictedUser()
Returns the value of the IS_RESTRICTED_USER
property as defined by this proxy. |
boolean |
getIsTestDatabase()
Returns the value of the IS_TEST_DATABASE
property as defined by this proxy. |
long |
getMaxCompatibleFeatureLevel()
Returns the value of the
MAX_COMPATIBLE_FEATURE_LEVEL
property as defined by this proxy. |
long |
getMinCompatibleFeatureLevel()
Returns the value of the
MIN_COMPATIBLE_FEATURE_LEVEL
property as defined by this proxy. |
ResourceList<CqContextResource> |
getModifiedResourcesList()
Returns the value of the
MODIFIED_RESOURCES_LIST property as
defined by this proxy. |
ResourceList<CqContextResource> |
getMoribundResourcesList()
Returns the value of the
MORIBUND_RESOURCES_LIST property as
defined by this proxy. |
String |
getName()
Returns the value of the NAME property as defined by this
proxy. |
String |
getNamedValue(String name)
Retrieves the value of a previously requested property named by an
instance of NamedValueName having the same parameters as this method. |
ResourceList<CqRecordType> |
getOslclinksEnabledRecordTypes()
Returns the value of the
INDEXED_RECORD_TYPES property as
defined by this proxy. |
ResourceList<CqQuery> |
getPersonalCharts()
Returns the value of the PERSONAL_CHARTS
property as defined by this proxy. |
CqQueryFolder |
getPersonalFolder()
Returns the value of the PERSONAL_FOLDER
property as defined by this proxy. |
ResourceList<CqQuery> |
getPersonalQueries()
Returns the value of the PERSONAL_QUERIES
property as defined by this proxy. |
ResourceList<CqReport> |
getPersonalReports()
Returns the value of the PERSONAL_REPORTS
property as defined by this proxy. |
ResourceList<CqQuery> |
getPublicCharts()
Returns the value of the PUBLIC_CHARTS property as
defined by this proxy. |
CqQueryFolder |
getPublicFolder()
Returns the value of the PUBLIC_FOLDER property as
defined by this proxy. |
ResourceList<CqQuery> |
getPublicQueries()
Returns the value of the PUBLIC_QUERIES property
as defined by this proxy. |
ResourceList<CqReport> |
getPublicReports()
Returns the value of the PUBLIC_REPORTS property
as defined by this proxy. |
ResourceList<CqQueryFolderItem> |
getQueryFolderItems()
Returns the value of the QUERY_FOLDER_ITEMS
property as defined by this proxy. |
ResourceList<CqRecordType> |
getRecordTypeSet()
Returns the value of the RECORD_TYPE_SET
property as defined by this proxy. |
ResourceList<CqReportFormat> |
getReportFormats()
Returns the value of the REPORT_FORMATS property
as defined by this proxy. |
long |
getSchemaRev()
Returns the value of the SCHEMA_REV property as
defined by this proxy. |
String |
getServer()
Returns the value of the SERVER property as defined by
this proxy. |
ResourceList<CqGroup> |
getSubscribedGroups()
Returns the value of the SUBSCRIBED_GROUPS
property as defined by this proxy. |
ResourceList<CqUser> |
getSubscribedUsers()
Returns the value of the SUBSCRIBED_USERS
property as defined by this proxy. |
long |
getTimeoutInterval()
Returns the value of the TIMEOUT_INTERVAL
property as defined by this proxy. |
CqUserInfo |
getUserInfo()
Returns the value of the USER_INFO property as defined
by this proxy. |
CqUserDb.VendorType |
getVendor()
Returns the value of the VENDOR property as defined by
this proxy. |
void |
setAllNamedValues(StpProperty.List<StpProperty<String>> allNameValues)
Defines a new value for the ALL_NAMED_VALUES
property of this proxy. |
void |
setNamedValue(String name,
String value)
A defines a new value for a NamedValue property of a given name. |
Methods inherited from interface CqResource |
cqProvider, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getCreatorGroupName, getCreatorLoginName, getIsExecutable, getLastModified, getProviderList, getWorkspaceFolderList, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setIsExecutable |
ALL_CHARTS
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> ALL_CHARTS
- All chart queries defined in this database and accessible to the current
user.
ALL_NAMED_VALUES
static final PropertyNameList.PropertyName<StpProperty.List<StpProperty<String>>> ALL_NAMED_VALUES
- A list of all the name/value properties defined for this database
session. This is a pseudo property, similar in concept to
Resource.ALL_CUSTOM_PROPERTIES
. When it appears in a
PropertyRequest, the server replies by populating the result proxy with
all named values defined for the database session. The value associated
with a given name can then be retrieved from the proxy using a
NamedValueName for the name. All of the returned named value properties
can be retrieved as an StpProperty.List using the getAllNameValues method
of this resource.
ALL_QUERIES
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> ALL_QUERIES
- All queries (no charts or reports) defined in this database and
accessible to the current user.
ALL_REPORTS
static final PropertyNameList.PropertyName<ResourceList<CqReport>> ALL_REPORTS
- All report queries defined in this database and accessible to the current
user.
CHECK_TIMEOUT_INTERVAL
static final PropertyNameList.PropertyName<Long> CHECK_TIMEOUT_INTERVAL
- The interval at which to check for user timeouts.
ClearQuest uses this property to determine how often it should check the
status of user connections. When the specified interval lapses,
ClearQuest checks each user connection for activity. If no activity has
been detected recently, ClearQuest checks the TimeoutInterval property to
see if the user's connection has timed out.
CONNECT_OPTIONS
static final PropertyNameList.PropertyName<String> CONNECT_OPTIONS
- The connection options for the physical database.
CONTEXT_IS_EMPTY
static final PropertyNameList.PropertyName<Boolean> CONTEXT_IS_EMPTY
- Answers whether or not there are modified or moribund resources still in
the change context associated with this user database.
DATABASE_NAME
static final PropertyNameList.PropertyName<String> DATABASE_NAME
- The name by which the database vendor installation knows this user
database.
DB_SET
static final PropertyNameList.PropertyName<CqDbSet> DB_SET
- The database set that contains this user database
DEFAULT_RECORD_TYPE
static final PropertyNameList.PropertyName<CqRecordType> DEFAULT_RECORD_TYPE
- The CqRecordType that the schema suggests should be used by default when
creating records and when finding records by id.
DYNAMIC_CHOICE_LISTS
static final PropertyNameList.PropertyName<ResourceList<CqDynamicChoiceList>> DYNAMIC_CHOICE_LISTS
- A list of the dynamic choice lists that are defined in this database
FEATURE_LEVEL
static final PropertyNameList.PropertyName<Long> FEATURE_LEVEL
- Implements CQSession.GetSessionFeatureLevel
INDEXED_RECORD_TYPES
static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> INDEXED_RECORD_TYPES
- A list of the record types that are being indexed for full-text searches.
IS_CHARTING_ENABLED
static final PropertyNameList.PropertyName<Boolean> IS_CHARTING_ENABLED
- Answers whether or not this database, using the CqProvider of this proxy,
provides support for the generation of charts via CqQuery.doMakeChart().
IS_FULL_TEXT_SEARCH_ENABLED
static final PropertyNameList.PropertyName<Boolean> IS_FULL_TEXT_SEARCH_ENABLED
- Answers whether or not full-text search has been enabled for this user
database.
IS_MULTISITE_ACTIVATED
static final PropertyNameList.PropertyName<Boolean> IS_MULTISITE_ACTIVATED
- Answers whether or not the database has been activated for multisite
operations (even if the database is the only existing replica).
IS_REPORTING_ENABLED
static final PropertyNameList.PropertyName<Boolean> IS_REPORTING_ENABLED
- Answers whether or not this database, using the CqProvider of this proxy,
provides support for reports, including access to CqReport and
CqReportFormat resources and the generation of reports via
CqReport.doMakeReport().
IS_REQUISITE_PRO_ENABLED
static final PropertyNameList.PropertyName<Boolean> IS_REQUISITE_PRO_ENABLED
- Answers whether or not the package supporting the integration of
ClearQuest and ReqiuisitePro has been enabled for this user database
IS_RESTRICTED_USER
static final PropertyNameList.PropertyName<Boolean> IS_RESTRICTED_USER
- Answers whether or not the current user has logged in as a restricted
user
IS_TEST_DATABASE
static final PropertyNameList.PropertyName<Boolean> IS_TEST_DATABASE
- Answers whether or not this is a test database
MAX_COMPATIBLE_FEATURE_LEVEL
static final PropertyNameList.PropertyName<Long> MAX_COMPATIBLE_FEATURE_LEVEL
- The highest feature level supported by the server.
MIN_COMPATIBLE_FEATURE_LEVEL
static final PropertyNameList.PropertyName<Long> MIN_COMPATIBLE_FEATURE_LEVEL
- The lowest feature level supported by the server
MODIFIED_RESOURCES_LIST
static final PropertyNameList.PropertyName<ResourceList<CqContextResource>> MODIFIED_RESOURCES_LIST
- A list of the modified resources currently in the database's change
context. The changes made to these resources will not be seen until the
changes are delivered.
MORIBUND_RESOURCES_LIST
static final PropertyNameList.PropertyName<ResourceList<CqContextResource>> MORIBUND_RESOURCES_LIST
- A list of the context resources whose deletion has been initiated but not
yet committed. The deletion will not be visible until these resources are
delivered to the database. The deletion of a moribund resource can be
canceled using the doRevert() method.
NAME
static final PropertyNameList.PropertyName<String> NAME
- The logical database name. The name to use in an StpLocation to identify
this database; same as DISPLAY_NAME.
OSLCLINKS_ENBALED_RECORD_TYPES
static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> OSLCLINKS_ENBALED_RECORD_TYPES
- A list of the record types that are OSLCLinks package enabled.
PERSONAL_CHARTS
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> PERSONAL_CHARTS
- All chart queries owned by the current user.
PERSONAL_FOLDER
static final PropertyNameList.PropertyName<CqQueryFolder> PERSONAL_FOLDER
- The query folder containing all queries in this database privately owned
by the current user.
PERSONAL_QUERIES
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> PERSONAL_QUERIES
- The queries (no charts or reports) owned by the current user
PERSONAL_REPORTS
static final PropertyNameList.PropertyName<ResourceList<CqReport>> PERSONAL_REPORTS
- All report queries owned by the current user.
PUBLIC_CHARTS
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> PUBLIC_CHARTS
- The chart queries defined in this database
PUBLIC_FOLDER
static final PropertyNameList.PropertyName<CqQueryFolder> PUBLIC_FOLDER
- The query folder containing all public queries in this database
PUBLIC_QUERIES
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> PUBLIC_QUERIES
- The queries (no charts or reports) defined in the public folder of this
database
PUBLIC_REPORTS
static final PropertyNameList.PropertyName<ResourceList<CqReport>> PUBLIC_REPORTS
- All reports defined in this database that are accessible to the current
user
QUERY_FOLDER_ITEMS
static final PropertyNameList.PropertyName<ResourceList<CqQueryFolderItem>> QUERY_FOLDER_ITEMS
- The first-level query folder items in this user database. At this level
are just two query folders containing, respectively, the public and
personal query folder items.
RECORD_TYPE_SET
static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> RECORD_TYPE_SET
- A list of the record types defined by this user database.
REPORT_FORMATS
static final PropertyNameList.PropertyName<ResourceList<CqReportFormat>> REPORT_FORMATS
- A list of all report formats defined in this database and accessible to
the current user.
SCHEMA_REV
static final PropertyNameList.PropertyName<Long> SCHEMA_REV
- The schema revision currently in use by the database.
This is a read-only property; it can be viewed but not set.
To change the schema revision of an existing database, you must upgrade
the database by calling the Upgrade method. If you are creating a new
database, you can set its initial schema revision using the
SetInitialSchemaRev method.
SERVER
static final PropertyNameList.PropertyName<String> SERVER
- The name of the server on which this database resides.
SUBSCRIBED_GROUPS
static final PropertyNameList.PropertyName<ResourceList<CqGroup>> SUBSCRIBED_GROUPS
- The groups explicitly subscribed to this database. It does not include
the groups implicitly subscribed to this database because their
CqGroup.IS_SUBSCRIBED_TO_ALL_DATABASES
property is true.
SUBSCRIBED_USERS
static final PropertyNameList.PropertyName<ResourceList<CqUser>> SUBSCRIBED_USERS
- The users explicitly subscribed to this database. It does not include the
users implicitly subscribed to this database because their
CqUser.IS_SUBSCRIBED_TO_ALL_DATABASES
property is true.
TIMEOUT_INTERVAL
static final PropertyNameList.PropertyName<Long> TIMEOUT_INTERVAL
- The login timeout interval.
ClearQuest periodically checks user connections and disconnects users who
have been idle for too long. If a user has been idle for a period of time
greater than the value in this property, ClearQuest disconnects the
user's session at the next tick of the CHECK_TIMEOUT_INTERVAL.
USER_INFO
static final PropertyNameList.PropertyName<CqUserInfo> USER_INFO
- Returns a CqUserInfo structure containing read-only information about the
user currently logged into this database.
VENDOR
static final PropertyNameList.PropertyName<CqUserDb.VendorType> VENDOR
- the vendor type of the database
buildSearchFilter
CqUserDb.SearchFilter buildSearchFilter(String simpleString)
- Constructs a SearchFilter instance with an initial simple specification
string.
- Parameters:
simpleString
- A search specification using the simple specification
syntax. If null, an empty SearchFilter will be
returned.
- Returns:
- A SearchFilter instance defining the simple search specification
derived from the simpleString argument.
doClearContext
CqUserDb doClearContext(Feedback feedback)
throws WvcmException
- Removes all modified and moribund resources from the change context of
this database; thereby reverting those resources to their previous,
unmodified or undeleted state.
- Parameters:
feedback
- A Feedback object requesting properties of this database
and/or properties of the reverted resources to be returned
from the server after successful completion of the operation.
- Throws:
WvcmException
- If the resources cannot be reverted.
doDeliver
CqUserDb doDeliver(Feedback feedback,
List<CqContextResource> deliveryOrder)
throws WvcmException
- Selectively delivers (commits) modified resources to the database and/or
destroys moribund resources from the database and removes them from the
change context.
NOTE: A ClearQuest query created and delivered in one CqProvider instance
may not appear in another already-existing CqProvider instance. To make
them available, create a new CqProvider instance after the
delivery is complete.
Known places in the implementation that will have this problem include:
Creation or deletion of a ClearQuest query (modification is OK).
Creation or deletion of a ClearQuest CqQueryFolder.
Modification of a ClearQuest CqDynamicChoiceList (creation is not
supported anyway).
- Parameters:
feedback
- A request for specific properties from the resources that
were directly or indirectly impacted by this operation, which,
in this case would be the modified resources that were
delivered by this operation. May be null; in which
case this information will not be requested from the server.deliveryOrder
- The modified and moribund resources currently in
this change context that are to be delivered or deleted. They
will be delivered or deleted in the order specified by the
proxies in the given list. To deliver/delete all
modified/moribund resources in an arbitrary order, use
CqProvider.DELIVER_ALL
. Must not be null nor
any of the other special delivery order constants AUTO, HOLD,
or DELIVER.
- Throws:
WvcmException
- if any preconditions are not satisfied or if other
errors are detected while writing the records to the
database.
doFindRecord
CqRecord doFindRecord(long dbid,
CqUserDb.FindMode mode,
Feedback feedback,
Location... possibleRecordTypes)
throws WvcmException
- Searches the database for records having a given dbid.
- Parameters:
dbid
- The dbid of the record to be found.mode
- A FindMode enumerator identifying the type of record to
search for.possibleRecordTypes
- An array of locations containing a
CqRecordType location for each type of record to be considered
in the search. May not contain record type family names. May
be null or empty to force consideration of all record
types.
The record type array is used to control the search for the
record identified by the displayName argument. This list of
record types is iterated and processed in the order given
until a record is found. If any of the record type locations
provided in this argument is invalid (such as referring to a
record type family), an exception is thrown that identifies
the invalid location. If a null or empty array value is
provided, all record types defined in the schema are searched,
with the search order being from the most frequently found
record type searched first to the least found record type
being searched last.
feedback
- A Feedback object in which may be requested search
progress reports and additional properties to be included in
the result proxy. May be null if no additional
feedback is needed.
- Returns:
- A CqRecord proxy representing a record of one of the requested
types or type categories whose dbid name matches the given
dbid argument; null if no such record can be
found. If a record is found, the returned proxy will be populated
with the properties requested by the feedback parameter.
- Throws:
WvcmException
- If the search as specified could not be completed;
for example, if the database or the specified record types
are not accessible. If all record types can be searched as
specified, failure to find a matching record does not
cause an exception but results in a null result.- See Also:
doFindRecord(long, com.ibm.rational.wvcm.stp.cq.CqUserDb.FindMode,
Feedback, Location[])
doFindRecord
CqRecord doFindRecord(String displayName,
CqUserDb.FindMode mode,
Feedback feedback,
Location... possibleRecordTypes)
throws WvcmException
- Searches the database for records having a given display name.
- Parameters:
displayName
- A String containing the display name of the record to
be found.possibleRecordTypes
- An array of locations containing a
CqRecordType location for each type of record to be considered
in the search. May not contain record type family names. May
be null or empty to force consideration of all record
types.
The record type array is used to control the search for the
record identified by the displayName argument. This list of
record types is iterated and processed in the order given
until a record is found. If any of the record type locations
provided in this argument is invalid (such as referring to a
record type family), an exception is thrown that identifies
the invalid location. If a null or empty array value is
provided, all record types defined in the schema are searched,
with the search order being from the most frequently found
record type searched first to the least found record type
being searched last.
mode
- A FindMode enumerator identifying the type of record to
search for.feedback
- A Feedback object in which may be requested search
progress reports and additional properties to be included in
the result proxy. May be null if no additional
feedback is needed.
- Returns:
- A CqRecord proxy representing a record of one of the requested
types or type categories whose display name matches the given
displayName argument; null if no such record can be
found. If a record is found, the returned proxy will be populated
with the properties requested by the feedback parameter.
- Throws:
WvcmException
- If the search as specified could not be completed;
for example, if the database or the specified record types
are not accessible. If all record types can be searched as
specified, failure to find a matching record does not
cause an exception but results in a null result.
doFindSiteExtendedNames
ResourceList<CqResource> doFindSiteExtendedNames(StpLocation name,
Feedback feedback)
throws WvcmException
- Returns a list of all the resources in the database whose names differ
from a given name only in their site extensions. Currently, only query
folder items and records of a stateless record type could possibly need
site extensions to disambiguate them, so applying this method to any
other resource is simply a waste of time and is likely to raise an
exception.
Applying this method to a stateless record type location has a special
meaning. In that case all instances of that record type that
require site extension are returned.
- Parameters:
name
- A (potentially ambiguous) user-friendly location
specification for a ClearQuest record, record type, or query
folder item, whose repo field, if present, must name this
database.feedback
- A Feedback object in which may be requested search
progress reports and additional properties to be included in
the result proxies. May be null if no additional
feedback is needed.
- Returns:
- A ResourceList containing a proxy for each resource in the
database whose site-extended name differs from the given name
only in the site extensions used. Will never be null or
empty.
- Throws:
WvcmException
- If the database is not accessible, if the given
name identifies a resource other than a record or query
folder item in this database, or if the given name cannot be
extended in any way to name any resource.
doFullTextSearch
CqHitSet doFullTextSearch(CqUserDb.SearchFilter searchFilter,
long... setParams)
throws WvcmException
- Searches the indexed content of the database for objects that match a
given filter. Information about each selected object is returned as a
packet of data called a hit. The matching process assigns a score
to the hit between 1 and 100, with 100 designating a near-perfect match.
The hits are ranked according to this score and are returned in order
highest rank to lowest.
When this method returns, the highest ranking hits will be available
immediately for inspection on the client. An argument to this method
controls the size of this first set of hits. If there were more hits
found than could be returned immediately, the remaining hits can be
requested using the CqHitSet.doGetMore() method.
- Parameters:
searchFilter
- A SearchFilter specifying which objects of the
database are to be selected for inclusion in the result set.setParams
- 0, 1, or 2 long values specifying how the hits are to be
returned from the server to the client.
- setParams[0]: The maximum number of hits the client will
accept from the server in the immediate response to this
request. Based on the total number of hits found and the load
on the server, however, the actual number of hits returned may
be less than this number. If this value is zero (or omitted)
the number of hits returned will be determined solely by the
server. In which case, the client should be prepared to accept
all hits found by the search.
- setParams[1]: The index of the first hit to be returned
to the client, where 1 is the index of the first hit found by
the search. If this value is zero (or omitted) the first hit
found will be the first hit returned.
- Returns:
- An iterator over the hits found in the search.
- Throws:
WvcmException
- See Also:
CqHitSet.doGetMore(long)
doRevert
CqUserDb doRevert(Feedback feedback,
List<CqContextResource> revertOrder)
throws WvcmException
- Selectively reverts modified or moribund resources in this database's
change context to their previous, unmodified/undeleted state. To revert
all resources in the change context, in an arbitrary order, use
doClearContext(Feedback)
. This operation is semantically
equivalent to invoking doRevert() on each resource in the given list, but
will be more efficient because there is only one round-trip to the server
required.
Note that doRevert removes all changes to the resource from the change
context. It is not an undo operation, but a revert. If multiple changes
have been made to a resource (since the last time it was delivered) they
will all be discarded by doRevert.
- Parameters:
feedback
- A request for specific properties from the resources that
were directly or indirectly impacted by this operation, which,
in this case would be the modified/moribund resources that
were reverted by this operation. May be null; in which
case this information will not be requested from the server.revertOrder
- The modified/moribund resources currently in this
change context to be reverted to their original state. They
will be reverted/undeleted in the order specified by the
proxies in this argument. Must not be null nor any of
the special delivery order constants AUTO, HOLD, DELIVER, or
DELIVER_ALL.
- Throws:
WvcmException
- if any preconditions are not satisfied or if other
errors are detected while writing the records to the
database.
doUpgradeUsersAndGroups
CqUserDb doUpgradeUsersAndGroups(Feedback feedback)
throws WvcmException
- Upgrades this database's user and group information to match that of its
db-set. This method copies the changes from the db-set to the user
database. You should call this function to upgrade a database after
making changes to the users and groups of the db-set.
- Parameters:
feedback
- Specifies optional feedback to the caller.
- Returns:
- A proxy for this user database (after the upgrade is complete),
whose properties are specified by feedback.
- Throws:
WvcmException
doValidateLocation
CqQueryFolderItem doValidateLocation(CqQueryFolderItem item,
Feedback feedback)
throws WvcmException
- Verifies that a CqQueryFolderItem of a given type can be created at a
given location. The operation checks that the characters used in the
location are valid for the target database and that no resource currently
exists at the specified location.
- Parameters:
item
- A proxy for the item whose location is to be tested.feedback
- A Feedback object that specifies the properties to be
included in the result proxy (if a resource exists at the
specified location). If the argument is null, the properties
defined by the result proxy are unspecified.
- Returns:
- If the location is valid and there is no resource currently at
the specified location, the result is null. If the
location is valid, but a resource already exists at that
location, a proxy for that resource is returned, populated with
any properties requested by the feedback argument.
- Throws:
WvcmException
- if the location is not valid on the target
database.
getAllCharts
ResourceList<CqQuery> getAllCharts()
throws WvcmException
- Returns the value of the
ALL_CHARTS
property as
defined by this proxy.
- Returns:
- A ResourceList of CqQuery proxies containing all of the chart
queries accessible to the current user.
- Throws:
WvcmException
- if this proxy does not define a value for the
ALL_CHARTS
property.
getAllNamedValues
StpProperty.List<StpProperty<String>> getAllNamedValues()
throws WvcmException
- Returns the value of the
ALL_NAMED_VALUES
property as defined by this proxy.
- Returns:
- A List of StpProperty<String> objects, each representing a
named value defined for this database session.
- Throws:
WvcmException
- if this proxy does not define a value for the
ALL_NAMED_VALUES
property.
getAllQueries
ResourceList<CqQuery> getAllQueries()
throws WvcmException
- Returns the value of the
ALL_QUERIES
property as
defined by this proxy.
- Returns:
- A ResourceList of CqQuery proxies containing all the queries of
type CqQuery.QueryType.LIST defined in this user database.
- Throws:
WvcmException
- if this proxy does not define a value for the
ALL_QUERIES
property.
getAllReports
ResourceList<CqReport> getAllReports()
throws WvcmException
- Returns the value of the
ALL_REPORTS
property as
defined by this proxy.
- Returns:
- A ResourceList containing a CqQuery proxy for each public report
query and each report query owned by the current user.
- Throws:
WvcmException
- if this proxy does not define a value for the
ALL_REPORTS
property.
getCheckTimeoutInterval
long getCheckTimeoutInterval()
throws WvcmException
- Returns the value of the
CHECK_TIME
OUT_INTERVAL
property as defined by this proxy.
- Returns:
- A long value representing the CHECK_TIMEOUT_INTERVAL in
milliseconds
- Throws:
WvcmException
- if this proxy does not define a value for the
CHECK_TIMEOUT_INTERVAL
property.
getConnectOptions
String getConnectOptions()
throws WvcmException
- Returns the value of the
CONNECT_OPTIONS
property as defined by this proxy.
- Returns:
- A String containing the vendors connection options.
- Throws:
WvcmException
- if this proxy does not define a value for the
CONNECT_OPTIONS
property.
getContextIsEmpty
boolean getContextIsEmpty()
throws WvcmException
- Returns the value of the
CONTEXT_IS_EMPTY
property as defined by this proxy.
- Returns:
- true if the change context has undelivered resources;
false if there are no modified or moribund resources in
the change context.
- Throws:
WvcmException
- if this proxy does not define a value for the
CONTEXT_IS_EMPTY
property.
getDatabaseName
String getDatabaseName()
throws WvcmException
- Returns the value of the
DATABASE_NAME
property as
defined by this proxy.
- Returns:
- A String containing the name by which the database vendor
installation knows this user database.
- Throws:
WvcmException
- if this proxy does not define a value for the
DATABASE_NAME
property.
getDbSet
CqDbSet getDbSet()
throws WvcmException
- Returns the value of the
DB_SET
property as defined by
this proxy.
- Returns:
- A CqDbSet proxy representing the database set that contains this
user database.
- Throws:
WvcmException
- if this proxy does not define a value for the
DB_SET
property.
getDefaultRecordType
CqRecordType getDefaultRecordType()
throws WvcmException
- Returns the value of the
DEFAULT_RECORD_TYPE
property as defined by this proxy.
- Returns:
- A CqRecordType proxy for the default record type defined for this
user database.
- Throws:
WvcmException
- if this proxy does not define a value for the
DEFAULT_RECORD_TYPE
property.
getDynamicChoiceLists
ResourceList<CqDynamicChoiceList> getDynamicChoiceLists()
throws WvcmException
- Returns the value of the
DYNAMIC_CHOICE_LISTS
property as
defined by this proxy.
- Returns:
- A ResourceList containing a CqDynamicChoiceList proxy for each
dynamic choice list defined in this database. Will never be
null, but may be empty.
- Throws:
WvcmException
- if this proxy does not define a value for the
DYNAMIC_CHOICE_LISTS
property.
getFeatureLevel
long getFeatureLevel()
throws WvcmException
- Returns the value of the
FEATURE_LEVEL
property as
defined by this proxy.
- Returns:
- The value. Will never be null.
- Throws:
WvcmException
- if this proxy does not define a value for the
FEATURE_LEVEL
property.
getIndexedRecordTypes
ResourceList<CqRecordType> getIndexedRecordTypes()
throws WvcmException
- Returns the value of the
INDEXED_RECORD_TYPES
property as defined by
this proxy.
- Returns:
- A ResourceList containing a CqRecordType proxy for any record
type that is being indexed for use in full-text searches.
- Throws:
WvcmException
- if this proxy does not define a value for the
INDEXED_RECORD_TYPES
property.
getIsChartingEnabled
boolean getIsChartingEnabled()
throws WvcmException
- Returns the value of the
IS_CHARTING_ENABLED
property as defined by this proxy.
- Returns:
- true if charting is supported by this database through
this proxy's CqProvider; false otherwise.
- Throws:
WvcmException
- if this proxy does not define a value for the
IS_CHARTING_ENABLED
property.
getIsFullTextSearchEnabled
boolean getIsFullTextSearchEnabled()
throws WvcmException
- Returns the value of the
IS_FULL_TEXT_SEARCH_ENABLED
property
as defined by this proxy.
- Returns:
- true if full-text search has been enabled on this
database; false otherwise.
- Throws:
WvcmException
- if this proxy does not define a value for the
IS_FULL_TEXT_SEARCH_ENABLED
property.
getIsMultisiteActivated
boolean getIsMultisiteActivated()
throws WvcmException
- Returns the value of the
IS_MULTISITE_ACTIVATED
property as
defined by this proxy.
- Returns:
- true if the database has been activated for multisite
operations, even if the database is the only existing replica;
false if not activated.
- Throws:
WvcmException
- if this proxy does not define a value for the
IS_MULTISITE_ACTIVATED
property.
getIsReportingEnabled
boolean getIsReportingEnabled()
throws WvcmException
- Returns the value of the
IS_REPORTING_ENABLED
property as defined by
this proxy.
- Returns:
- true if CqReport and CqReportFormat resources are
supported by this database through this proxy's CqProvider;
false otherwise.
- Throws:
WvcmException
- if this proxy does not define a value for the
IS_REPORTING_ENABLED
property.
getIsRequisiteProEnabled
boolean getIsRequisiteProEnabled()
throws WvcmException
- Returns the value of the
IS_REQUISITE_PRO_ENABLED
property as
defined by this proxy.
- Returns:
- true if the RequisitePro package has been enabled on this
database; false otherwise.
- Throws:
WvcmException
- if this proxy does not define a value for the
IS_REQUISITE_PRO_ENABLED
property.
getIsRestrictedUser
boolean getIsRestrictedUser()
throws WvcmException
- Returns the value of the
IS_RESTRICTED_USER
property as defined by this proxy.
- Returns:
- true if the current user logged in as a restricted user;
false otherwise;.
- Throws:
WvcmException
- if this proxy does not define a value for the
IS_RESTRICTED_USER
property.
getIsTestDatabase
boolean getIsTestDatabase()
throws WvcmException
- Returns the value of the
IS_TEST_DATABASE
property as defined by this proxy.
- Returns:
- true if this user database has been designated a test
database; false otherwise.
- Throws:
WvcmException
- if this proxy does not define a value for the
IS_TEST_DATABASE
property.
getMaxCompatibleFeatureLevel
long getMaxCompatibleFeatureLevel()
throws WvcmException
- Returns the value of the
MAX_COMPATIBLE_FEATURE_LEVEL
property as defined by this proxy.
- Returns:
- A long value designating the highest feature level supported by
the server.
- Throws:
WvcmException
- if this proxy does not define a value for the
MAX_COMPATIBLE_FEATURE_LEVEL
property.
getMinCompatibleFeatureLevel
long getMinCompatibleFeatureLevel()
throws WvcmException
- Returns the value of the
MIN_COMPATIBLE_FEATURE_LEVEL
property as defined by this proxy.
- Returns:
- A long value designating the lowest feature level supported by
the server.
- Throws:
WvcmException
- if this proxy does not define a value for the
MIN_COMPATIBLE_FEATURE_LEVEL
property.
getModifiedResourcesList
ResourceList<CqContextResource> getModifiedResourcesList()
throws WvcmException
- Returns the value of the
MODIFIED_RESOURCES_LIST
property as
defined by this proxy.
- Returns:
- A list of the context resources of the database that have been
modified but not yet committed to the database.
- Throws:
WvcmException
- if this proxy does not define a value for the
MODIFIED_RESOURCES_LIST
property.
getMoribundResourcesList
ResourceList<CqContextResource> getMoribundResourcesList()
throws WvcmException
- Returns the value of the
MORIBUND_RESOURCES_LIST
property as
defined by this proxy.
- Returns:
- A list of the context resources of the database whose deletion
has been initiated but not yet committed to the database
- Throws:
WvcmException
- if this proxy does not define a value for the
MORIBUND_RESOURCES_LIST
property.
getName
String getName()
throws WvcmException
- Returns the value of the
NAME
property as defined by this
proxy.
- Returns:
- A String containing the logical name of this database.
- Throws:
WvcmException
- if this proxy does not define a value for the
NAME
property.
getNamedValue
String getNamedValue(String name)
throws WvcmException
- Retrieves the value of a previously requested property named by an
instance of NamedValueName having the same parameters as this method.
This is just shorthand for
getProperty(new NamedValueName(name))
- Parameters:
name
- The name for which a value was requested.
- Returns:
- A String containing the value of the NameValue property
- Throws:
WvcmException
- If the NameValue for the given name was not
requested or otherwise not available.
getOslclinksEnabledRecordTypes
ResourceList<CqRecordType> getOslclinksEnabledRecordTypes()
throws WvcmException
- Returns the value of the
INDEXED_RECORD_TYPES
property as
defined by this proxy.
- Returns:
- A ResourceList containing a CqRecordType proxy for any record
type that is OSLCLinks package enabled
- Throws:
WvcmException
- if this proxy does not define a value for the
OSLCLINKS_ENABLED_RECORD_TYPES
property.
getPersonalCharts
ResourceList<CqQuery> getPersonalCharts()
throws WvcmException
- Returns the value of the
PERSONAL_CHARTS
property as defined by this proxy.
- Returns:
- A ResourceList containing a CqQuery proxy for each chart query
owned by the current user.
- Throws:
WvcmException
- if this proxy does not define a value for the
PERSONAL_CHARTS
property.
getPersonalFolder
CqQueryFolder getPersonalFolder()
throws WvcmException
- Returns the value of the
PERSONAL_FOLDER
property as defined by this proxy.
- Returns:
- A CqQueryFolder proxy for the root folder containing all personal
queries.
- Throws:
WvcmException
- if this proxy does not define a value for the
PERSONAL_FOLDER
property.
getPersonalQueries
ResourceList<CqQuery> getPersonalQueries()
throws WvcmException
- Returns the value of the
PERSONAL_QUERIES
property as defined by this proxy.
- Returns:
- A ResourceList of CqQuery proxies containing all the personal
queries (no charts or reports) defined in this database for the
current user.
- Throws:
WvcmException
- if this proxy does not define a value for the
PERSONAL_QUERIES
property.
getPersonalReports
ResourceList<CqReport> getPersonalReports()
throws WvcmException
- Returns the value of the
PERSONAL_REPORTS
property as defined by this proxy.
- Returns:
- A ResourceList containing a CqQuery proxy for each report query
owned by the current user.
- Throws:
WvcmException
- if this proxy does not define a value for the
PERSONAL_REPORTS
property.
getPublicCharts
ResourceList<CqQuery> getPublicCharts()
throws WvcmException
- Returns the value of the
PUBLIC_CHARTS
property as
defined by this proxy.
- Returns:
- A ResourceList containing a CqQuery proxy for each chart query in
this user database.
- Throws:
WvcmException
- if this proxy does not define a value for the
PUBLIC_CHARTS
property.
getPublicFolder
CqQueryFolder getPublicFolder()
throws WvcmException
- Returns the value of the
PUBLIC_FOLDER
property as
defined by this proxy.
- Returns:
- A CqQueryFolder proxy for the root query folder that contains all
public queries.
- Throws:
WvcmException
- if this proxy does not define a value for the
PUBLIC_FOLDER
property.
getPublicQueries
ResourceList<CqQuery> getPublicQueries()
throws WvcmException
- Returns the value of the
PUBLIC_QUERIES
property
as defined by this proxy.
- Returns:
- A ResourceList of CqQuery proxies containing all of the public
queries (no charts or reports) defined in this user database.
- Throws:
WvcmException
- if this proxy does not define a value for the
PUBLIC_QUERIES
property.
getPublicReports
ResourceList<CqReport> getPublicReports()
throws WvcmException
- Returns the value of the
PUBLIC_REPORTS
property
as defined by this proxy.
- Returns:
- A ResourceList containing a CqQuery proxy for each report query
accessible to the current user.
- Throws:
WvcmException
- if this proxy does not define a value for the
PUBLIC_REPORTS
property.
getQueryFolderItems
ResourceList<CqQueryFolderItem> getQueryFolderItems()
throws WvcmException
- Returns the value of the
QUERY_FOLDER_ITEMS
property as defined by this proxy.
- Returns:
- A list of two CqQueryFolder proxies; one for the public queries
folder and one for the personal queries folder.
- Throws:
WvcmException
- if this proxy does not define a value for the
QUERY_FOLDER_ITEMS
property.
getRecordTypeSet
ResourceList<CqRecordType> getRecordTypeSet()
throws WvcmException
- Returns the value of the
RECORD_TYPE_SET
property as defined by this proxy.
- Returns:
- A ResourceList containing a CqRecordType proxy for each record
type defined by this user database.
- Throws:
WvcmException
- if this proxy does not define a value for the
RECORD_TYPE_SET
property.
getReportFormats
ResourceList<CqReportFormat> getReportFormats()
throws WvcmException
- Returns the value of the
REPORT_FORMATS
property
as defined by this proxy.
- Returns:
- A ResourceList containing a CqReportFormat proxy for each report
format defined in the public and personal query folders . Will
never be null.
- Throws:
WvcmException
- if this proxy does not define a value for the
REPORT_FORMATS
property.
getSchemaRev
long getSchemaRev()
throws WvcmException
- Returns the value of the
SCHEMA_REV
property as
defined by this proxy.
- Returns:
- A Long containing the schema revision number.
- Throws:
WvcmException
- if this proxy does not define a value for the
SCHEMA_REV
property.
getServer
String getServer()
throws WvcmException
- Returns the value of the
SERVER
property as defined by
this proxy.
- Returns:
- A String containing the name of the server on which this database
is installed.
- Throws:
WvcmException
- if this proxy does not define a value for the
SERVER
property.
getSubscribedGroups
ResourceList<CqGroup> getSubscribedGroups()
throws WvcmException
- Returns the value of the
SUBSCRIBED_GROUPS
property as defined by this proxy.
- Returns:
- A ResourceList containing a CqGroup proxy for each group
explicitly subscribed to this user database. Will never be
null.
- Throws:
WvcmException
- if this proxy does not define a value for the
SUBSCRIBED_GROUPS
property.
getSubscribedUsers
ResourceList<CqUser> getSubscribedUsers()
throws WvcmException
- Returns the value of the
SUBSCRIBED_USERS
property as defined by this proxy.
- Returns:
- A ResourceList containing a CqUser proxy for each group
explicitly subscribed to this user database. Will never be
null.
- Throws:
WvcmException
- if this proxy does not define a value for the
SUBSCRIBED_USERS
property.
getTimeoutInterval
long getTimeoutInterval()
throws WvcmException
- Returns the value of the
TIMEOUT_INTERVAL
property as defined by this proxy.
- Returns:
- An integer indicating the TIMEOUT_INTERVAL in milliseconds
- Throws:
WvcmException
- if this proxy does not define a value for the
TIMEOUT_INTERVAL
property.
getUserInfo
CqUserInfo getUserInfo()
throws WvcmException
- Returns the value of the
USER_INFO
property as defined
by this proxy.
- Returns:
- A CqUserInfo instance containing read-only information about the
user currently logged into this database. Will never be null.
- Throws:
WvcmException
- if this proxy does not define a value for the
USER_INFO
property.
getVendor
CqUserDb.VendorType getVendor()
throws WvcmException
- Returns the value of the
VENDOR
property as defined by
this proxy.
- Returns:
- A VendorType enumerator indicating vendor of the physical
database.
- Throws:
WvcmException
- if this proxy does not define a value for the
VENDOR
property.
setAllNamedValues
void setAllNamedValues(StpProperty.List<StpProperty<String>> allNameValues)
- Defines a new value for the
ALL_NAMED_VALUES
property of this proxy.
- Parameters:
allNameValues
- An StpProperty.List associating names to String
values. The entries of this list replace the current
entries in the name/value map accessible to scripts on the
server. If this property is empty or null, the server
map will be emptied. To update individual name/value
associations, use setProperty with a NamedValueName and string
value.
setNamedValue
void setNamedValue(String name,
String value)
- A defines a new value for a NamedValue property of a given name. The
property is not updated until the next "do" operations is invoked.
Shorthand for
setProperty(new NamedValueName(name), value)
- Parameters:
name
- The name of the NamedValue whose value is to be set.value
- The new value for the NameValue property identified by the
name parameter.
Copyright © IBM 2013. All rights reserved.