public interface CqUserDb extends StpRepository, CqDb
In addition to representing the physical database, a CqUserDb object also represents the on-going ClearQuest session between the user and that database. As such, it represents a user-specific, server-resident area in which changes to CqContextResources are performed. This server-area is referred to as the database's change context. Here, the term change refers to the creation, revision, or deletion of a resource, its content or its properties as a consequence of some server interaction.
In general, any changes made to a CqContextResource are held in the change
context area until the client explicitly directs the server to deliver those
changes to the database. Each operation that changes a database object has a
parameter named
If the operation fails, no delivery is attempted.
Special instances of List
The properties that describe the state of the database's change context are
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:
The user-friendly specification for the location of a user database has the
form
deliveryOrder
(usually the last parameter).
This parameter controls the disposition of the changes after the operation
completes. The parameter is a ListCqProvider.HOLD
, CqProvider.AUTO
,
CqProvider.DELIVER
, and CqProvider.DELIVER_ALL
for more
information.
CONTEXT_IS_EMPTY
, MODIFIED_RESOURCES_LIST
, and
MORIBUND_RESOURCES_LIST
.
doClearContext(Feedback)
,
doDeliver(Feedback, List)
, and doRevert(Feedback, List)
.
cq.userdb:<db-set>/<user-db>
CqContextResource
Modifier and Type | Interface and Description |
---|---|
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.
|
StpResource.UnsupportedProperty
Resource.CopyFlag
Modifier and Type | Field and Description |
---|---|
static PropertyNameList.PropertyName<ResourceList<CqQuery>> |
ALL_CHARTS
All chart queries defined in this database and accessible to the current
user.
|
static PropertyNameList.PropertyName<StpProperty.List<StpProperty<String>>> |
ALL_NAMED_VALUES
A list of all the name/value properties defined for this database
session.
|
static PropertyNameList.PropertyName<ResourceList<CqQuery>> |
ALL_QUERIES
All queries (no charts or reports) defined in this database and
accessible to the current user.
|
static PropertyNameList.PropertyName<ResourceList<CqReport>> |
ALL_REPORTS
All report queries defined in this database and accessible to the current
user.
|
static PropertyNameList.PropertyName<Long> |
CHECK_TIMEOUT_INTERVAL
The interval at which to check for user timeouts.
|
static PropertyNameList.PropertyName<String> |
CONNECT_OPTIONS
The connection options for the physical database.
|
static 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.
|
static PropertyNameList.PropertyName<String> |
DATABASE_NAME
The name by which the database vendor installation knows this user
database.
|
static PropertyNameList.PropertyName<CqDbSet> |
DB_SET
The database set that contains this user database
|
static 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.
|
static PropertyNameList.PropertyName<ResourceList<CqDynamicChoiceList>> |
DYNAMIC_CHOICE_LISTS
A list of the dynamic choice lists that are defined in this database
|
static PropertyNameList.PropertyName<Long> |
FEATURE_LEVEL
Implements CQSession.GetSessionFeatureLevel
|
static PropertyNameList.PropertyName<ResourceList<CqRecordType>> |
INDEXED_RECORD_TYPES
A list of the record types that are being indexed for full-text searches.
|
static 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().
|
static PropertyNameList.PropertyName<Boolean> |
IS_FULL_TEXT_SEARCH_ENABLED
Answers whether or not full-text search has been enabled for this user
database.
|
static 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).
|
static 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().
|
static 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
|
static PropertyNameList.PropertyName<Boolean> |
IS_RESTRICTED_USER
Answers whether or not the current user has logged in as a restricted
user
|
static PropertyNameList.PropertyName<Boolean> |
IS_TEST_DATABASE
Answers whether or not this is a test database
|
static PropertyNameList.PropertyName<Long> |
MAX_COMPATIBLE_FEATURE_LEVEL
The highest feature level supported by the server.
|
static PropertyNameList.PropertyName<Long> |
MIN_COMPATIBLE_FEATURE_LEVEL
The lowest feature level supported by the server
|
static PropertyNameList.PropertyName<ResourceList<CqContextResource>> |
MODIFIED_RESOURCES_LIST
A list of the modified resources currently in the database's change
context.
|
static PropertyNameList.PropertyName<ResourceList<CqContextResource>> |
MORIBUND_RESOURCES_LIST
A list of the context resources whose deletion has been initiated but not
yet committed.
|
static PropertyNameList.PropertyName<String> |
NAME
The logical database name.
|
static PropertyNameList.PropertyName<ResourceList<CqRecordType>> |
OSLCLINKS_ENABLED_RECORD_TYPES
A list of the record types that are OSLCLinks package enabled.
|
static PropertyNameList.PropertyName<ResourceList<CqQuery>> |
PERSONAL_CHARTS
All chart queries owned by the current user.
|
static PropertyNameList.PropertyName<CqQueryFolder> |
PERSONAL_FOLDER
The query folder containing all queries in this database privately owned
by the current user.
|
static PropertyNameList.PropertyName<ResourceList<CqQuery>> |
PERSONAL_QUERIES
The queries (no charts or reports) owned by the current user
|
static PropertyNameList.PropertyName<ResourceList<CqReport>> |
PERSONAL_REPORTS
All report queries owned by the current user.
|
static PropertyNameList.PropertyName<ResourceList<CqQuery>> |
PUBLIC_CHARTS
The chart queries defined in this database
|
static PropertyNameList.PropertyName<CqQueryFolder> |
PUBLIC_FOLDER
The query folder containing all public queries in this database
|
static PropertyNameList.PropertyName<ResourceList<CqQuery>> |
PUBLIC_QUERIES
The queries (no charts or reports) defined in the public folder of this
database
|
static PropertyNameList.PropertyName<ResourceList<CqReport>> |
PUBLIC_REPORTS
All reports defined in this database that are accessible to the current
user
|
static PropertyNameList.PropertyName<ResourceList<CqQueryFolderItem>> |
QUERY_FOLDER_ITEMS
The first-level query folder items in this user database.
|
static PropertyNameList.PropertyName<ResourceList<CqRecordType>> |
RECORD_TYPE_SET
A list of the record types defined by this user database.
|
static PropertyNameList.PropertyName<ResourceList<CqReportFormat>> |
REPORT_FORMATS
A list of all report formats defined in this database and accessible to
the current user.
|
static PropertyNameList.PropertyName<Long> |
SCHEMA_REV
The schema revision currently in use by the database.
|
static PropertyNameList.PropertyName<String> |
SERVER
The name of the server on which this database resides.
|
static PropertyNameList.PropertyName<ResourceList<CqGroup>> |
SUBSCRIBED_GROUPS
The groups explicitly subscribed to this database.
|
static PropertyNameList.PropertyName<ResourceList<CqUser>> |
SUBSCRIBED_USERS
The users explicitly subscribed to this database.
|
static PropertyNameList.PropertyName<Long> |
TIMEOUT_INTERVAL
The login timeout interval.
|
static PropertyNameList.PropertyName<CqUserInfo> |
USER_INFO
Returns a CqUserInfo structure containing read-only information about the
user currently logged into this database.
|
static PropertyNameList.PropertyName<CqUserDb.VendorType> |
VENDOR
the vendor type of the database
|
PRODUCT_INFO
ALL_GROUPS, ALL_USERS, AUTHENTICATION_LOGIN_NAME, CURRENT_USER, DIAG_INFO, EVERYONE_GROUP_NAME, LDAP_PROPERTY, LOCAL_REPLICA
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST
Modifier and Type | Method and Description |
---|---|
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.
|
CqHitSet |
doFullTextSearch(String parentRecordTypeLocation,
String parentRecordLocation,
String parentRecordFieldNameLocation,
List<String> displayFieldNameLocation,
CqUserDb.SearchFilter searchFilter,
long... setParams)
The typeahead enabled search, 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. |
CqDb |
getCqDb()
Returns the value of the
USER_INFO 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
OSLCLINKS_ENABLED_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.
|
getProductInfo
doValidateUserCredentials, getAllGroups, getAllUsers, getAuthenticationLoginName, getCurrentUser, getDiagInfo, getEveryoneGroupName, getLDAPProperty, getLocalReplica, getMasterPropertyValue, getMasterPropertyValueFromUserSession, setDiagInfo, setMasterPropertyValue, unsetMasterPropertyValue
cqProvider, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getCreatorGroupName, getCreatorLoginName, getIsExecutable, getLastModified, getProviderList, getWorkspaceFolderList, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setIsExecutable
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> ALL_CHARTS
static final PropertyNameList.PropertyName<StpProperty.List<StpProperty<String>>> ALL_NAMED_VALUES
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.static final PropertyNameList.PropertyName<ResourceList<CqQuery>> ALL_QUERIES
static final PropertyNameList.PropertyName<ResourceList<CqReport>> ALL_REPORTS
static final PropertyNameList.PropertyName<Long> CHECK_TIMEOUT_INTERVAL
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.
static final PropertyNameList.PropertyName<String> CONNECT_OPTIONS
static final PropertyNameList.PropertyName<Boolean> CONTEXT_IS_EMPTY
static final PropertyNameList.PropertyName<String> DATABASE_NAME
static final PropertyNameList.PropertyName<CqDbSet> DB_SET
static final PropertyNameList.PropertyName<CqRecordType> DEFAULT_RECORD_TYPE
static final PropertyNameList.PropertyName<ResourceList<CqDynamicChoiceList>> DYNAMIC_CHOICE_LISTS
static final PropertyNameList.PropertyName<Long> FEATURE_LEVEL
static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> INDEXED_RECORD_TYPES
static final PropertyNameList.PropertyName<Boolean> IS_CHARTING_ENABLED
static final PropertyNameList.PropertyName<Boolean> IS_FULL_TEXT_SEARCH_ENABLED
static final PropertyNameList.PropertyName<Boolean> IS_MULTISITE_ACTIVATED
static final PropertyNameList.PropertyName<Boolean> IS_REPORTING_ENABLED
static final PropertyNameList.PropertyName<Boolean> IS_REQUISITE_PRO_ENABLED
static final PropertyNameList.PropertyName<Boolean> IS_RESTRICTED_USER
static final PropertyNameList.PropertyName<Boolean> IS_TEST_DATABASE
static final PropertyNameList.PropertyName<Long> MAX_COMPATIBLE_FEATURE_LEVEL
static final PropertyNameList.PropertyName<Long> MIN_COMPATIBLE_FEATURE_LEVEL
static final PropertyNameList.PropertyName<ResourceList<CqContextResource>> MODIFIED_RESOURCES_LIST
static final PropertyNameList.PropertyName<ResourceList<CqContextResource>> MORIBUND_RESOURCES_LIST
static final PropertyNameList.PropertyName<String> NAME
static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> OSLCLINKS_ENABLED_RECORD_TYPES
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> PERSONAL_CHARTS
static final PropertyNameList.PropertyName<CqQueryFolder> PERSONAL_FOLDER
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> PERSONAL_QUERIES
static final PropertyNameList.PropertyName<ResourceList<CqReport>> PERSONAL_REPORTS
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> PUBLIC_CHARTS
static final PropertyNameList.PropertyName<CqQueryFolder> PUBLIC_FOLDER
static final PropertyNameList.PropertyName<ResourceList<CqQuery>> PUBLIC_QUERIES
static final PropertyNameList.PropertyName<ResourceList<CqReport>> PUBLIC_REPORTS
static final PropertyNameList.PropertyName<ResourceList<CqQueryFolderItem>> QUERY_FOLDER_ITEMS
static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> RECORD_TYPE_SET
static final PropertyNameList.PropertyName<ResourceList<CqReportFormat>> REPORT_FORMATS
static final PropertyNameList.PropertyName<Long> SCHEMA_REV
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.
static final PropertyNameList.PropertyName<String> SERVER
static final PropertyNameList.PropertyName<ResourceList<CqGroup>> SUBSCRIBED_GROUPS
CqGroup.IS_SUBSCRIBED_TO_ALL_DATABASES
property is true.static final PropertyNameList.PropertyName<ResourceList<CqUser>> SUBSCRIBED_USERS
CqUser.IS_SUBSCRIBED_TO_ALL_DATABASES
property is true.static final PropertyNameList.PropertyName<Long> 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.
static final PropertyNameList.PropertyName<CqUserInfo> USER_INFO
static final PropertyNameList.PropertyName<CqUserDb.VendorType> VENDOR
CqUserDb.SearchFilter buildSearchFilter(String simpleString)
simpleString
- A search specification using the simple specification
syntax. If null, an empty SearchFilter will be
returned.CqUserDb doClearContext(Feedback feedback) throws WvcmException
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.WvcmException
- If the resources cannot be reverted.CqUserDb doDeliver(Feedback feedback, List<CqContextResource> deliveryOrder) throws WvcmException
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).
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.WvcmException
- if any preconditions are not satisfied or if other
errors are detected while writing the records to the
database.CqRecord doFindRecord(long dbid, CqUserDb.FindMode mode, Feedback feedback, Location... possibleRecordTypes) throws WvcmException
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.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.doFindRecord(long, com.ibm.rational.wvcm.stp.cq.CqUserDb.FindMode,
Feedback, Location[])
CqRecord doFindRecord(String displayName, CqUserDb.FindMode mode, Feedback feedback, Location... possibleRecordTypes) throws WvcmException
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.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.ResourceList<CqResource> doFindSiteExtendedNames(StpLocation name, Feedback feedback) throws WvcmException
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.
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.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.CqHitSet doFullTextSearch(CqUserDb.SearchFilter searchFilter, long... setParams) throws WvcmException
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.
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.
WvcmException
CqHitSet.doGetMore(long)
CqHitSet doFullTextSearch(String parentRecordTypeLocation, String parentRecordLocation, String parentRecordFieldNameLocation, List<String> displayFieldNameLocation, CqUserDb.SearchFilter searchFilter, long... setParams) throws WvcmException
When this method returns, the highest ranking hits will be available immediately for inspection on the client. Four arguments are setting the scope of the typeahead search, controls which filed of a record is typeahead enabled, and which fields will be searched and put in the result set. If there were more hits found than could be returned immediately, the remaining hits can be requested using the CqHitSet.doGetMore() method.
parentRecordTypeLocation
- A Lcation string specifying which recordType is for the recordparentRecordLocation
- A String specifying which record is to be selected to do the
typeaheadparentRecordFieldNameLocation
- A Location string specifying which field of the record is typeahead
enableddisplayFieldNameLocation
- A List of Location strings specifying which fields of a recordtype are
to be searched and displayed in the result setsearchFilter
- 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.
WvcmException
CqUserDb doRevert(Feedback feedback, List<CqContextResource> revertOrder) throws WvcmException
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.
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.WvcmException
- if any preconditions are not satisfied or if other
errors are detected while writing the records to the
database.CqUserDb doUpgradeUsersAndGroups(Feedback feedback) throws WvcmException
feedback
- Specifies optional feedback to the caller.WvcmException
CqQueryFolderItem doValidateLocation(CqQueryFolderItem item, Feedback feedback) throws WvcmException
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.WvcmException
- if the location is not valid on the target
database.ResourceList<CqQuery> getAllCharts() throws WvcmException
ALL_CHARTS
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
ALL_CHARTS
property.StpProperty.List<StpProperty<String>> getAllNamedValues() throws WvcmException
ALL_NAMED_VALUES
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
ALL_NAMED_VALUES
property.ResourceList<CqQuery> getAllQueries() throws WvcmException
ALL_QUERIES
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
ALL_QUERIES
property.ResourceList<CqReport> getAllReports() throws WvcmException
ALL_REPORTS
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
ALL_REPORTS
property.long getCheckTimeoutInterval() throws WvcmException
CHECK_TIME
OUT_INTERVAL
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
CHECK_TIMEOUT_INTERVAL
property.String getConnectOptions() throws WvcmException
CONNECT_OPTIONS
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
CONNECT_OPTIONS
property.boolean getContextIsEmpty() throws WvcmException
CONTEXT_IS_EMPTY
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
CONTEXT_IS_EMPTY
property.CqDb getCqDb() throws WvcmException
USER_INFO
property as defined
by this proxy.WvcmException
- if this proxy does not define a value for the
USER_INFO
property.String getDatabaseName() throws WvcmException
DATABASE_NAME
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
DATABASE_NAME
property.CqDbSet getDbSet() throws WvcmException
DB_SET
property as defined by
this proxy.WvcmException
- if this proxy does not define a value for the
DB_SET
property.CqRecordType getDefaultRecordType() throws WvcmException
DEFAULT_RECORD_TYPE
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
DEFAULT_RECORD_TYPE
property.ResourceList<CqDynamicChoiceList> getDynamicChoiceLists() throws WvcmException
DYNAMIC_CHOICE_LISTS
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
DYNAMIC_CHOICE_LISTS
property.long getFeatureLevel() throws WvcmException
FEATURE_LEVEL
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
FEATURE_LEVEL
property.ResourceList<CqRecordType> getIndexedRecordTypes() throws WvcmException
INDEXED_RECORD_TYPES
property as defined by
this proxy.WvcmException
- if this proxy does not define a value for the
INDEXED_RECORD_TYPES
property.boolean getIsChartingEnabled() throws WvcmException
IS_CHARTING_ENABLED
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
IS_CHARTING_ENABLED
property.boolean getIsFullTextSearchEnabled() throws WvcmException
IS_FULL_TEXT_SEARCH_ENABLED
property
as defined by this proxy.WvcmException
- if this proxy does not define a value for the
IS_FULL_TEXT_SEARCH_ENABLED
property.boolean getIsMultisiteActivated() throws WvcmException
IS_MULTISITE_ACTIVATED
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
IS_MULTISITE_ACTIVATED
property.boolean getIsReportingEnabled() throws WvcmException
IS_REPORTING_ENABLED
property as defined by
this proxy.WvcmException
- if this proxy does not define a value for the
IS_REPORTING_ENABLED
property.boolean getIsRequisiteProEnabled() throws WvcmException
IS_REQUISITE_PRO_ENABLED
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
IS_REQUISITE_PRO_ENABLED
property.boolean getIsRestrictedUser() throws WvcmException
IS_RESTRICTED_USER
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
IS_RESTRICTED_USER
property.boolean getIsTestDatabase() throws WvcmException
IS_TEST_DATABASE
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
IS_TEST_DATABASE
property.long getMaxCompatibleFeatureLevel() throws WvcmException
MAX_COMPATIBLE_FEATURE_LEVEL
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
MAX_COMPATIBLE_FEATURE_LEVEL
property.long getMinCompatibleFeatureLevel() throws WvcmException
MIN_COMPATIBLE_FEATURE_LEVEL
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
MIN_COMPATIBLE_FEATURE_LEVEL
property.ResourceList<CqContextResource> getModifiedResourcesList() throws WvcmException
MODIFIED_RESOURCES_LIST
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
MODIFIED_RESOURCES_LIST
property.ResourceList<CqContextResource> getMoribundResourcesList() throws WvcmException
MORIBUND_RESOURCES_LIST
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
MORIBUND_RESOURCES_LIST
property.String getName() throws WvcmException
NAME
property as defined by this
proxy.WvcmException
- if this proxy does not define a value for the
NAME
property.String getNamedValue(String name) throws WvcmException
getProperty(new NamedValueName(name))
name
- The name for which a value was requested.WvcmException
- If the NameValue for the given name was not
requested or otherwise not available.ResourceList<CqRecordType> getOslclinksEnabledRecordTypes() throws WvcmException
OSLCLINKS_ENABLED_RECORD_TYPES
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
OSLCLINKS_ENABLED_RECORD_TYPES
property.ResourceList<CqQuery> getPersonalCharts() throws WvcmException
PERSONAL_CHARTS
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
PERSONAL_CHARTS
property.CqQueryFolder getPersonalFolder() throws WvcmException
PERSONAL_FOLDER
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
PERSONAL_FOLDER
property.ResourceList<CqQuery> getPersonalQueries() throws WvcmException
PERSONAL_QUERIES
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
PERSONAL_QUERIES
property.ResourceList<CqReport> getPersonalReports() throws WvcmException
PERSONAL_REPORTS
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
PERSONAL_REPORTS
property.ResourceList<CqQuery> getPublicCharts() throws WvcmException
PUBLIC_CHARTS
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
PUBLIC_CHARTS
property.CqQueryFolder getPublicFolder() throws WvcmException
PUBLIC_FOLDER
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
PUBLIC_FOLDER
property.ResourceList<CqQuery> getPublicQueries() throws WvcmException
PUBLIC_QUERIES
property
as defined by this proxy.WvcmException
- if this proxy does not define a value for the
PUBLIC_QUERIES
property.ResourceList<CqReport> getPublicReports() throws WvcmException
PUBLIC_REPORTS
property
as defined by this proxy.WvcmException
- if this proxy does not define a value for the
PUBLIC_REPORTS
property.ResourceList<CqQueryFolderItem> getQueryFolderItems() throws WvcmException
QUERY_FOLDER_ITEMS
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
QUERY_FOLDER_ITEMS
property.ResourceList<CqRecordType> getRecordTypeSet() throws WvcmException
RECORD_TYPE_SET
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
RECORD_TYPE_SET
property.ResourceList<CqReportFormat> getReportFormats() throws WvcmException
REPORT_FORMATS
property
as defined by this proxy.WvcmException
- if this proxy does not define a value for the
REPORT_FORMATS
property.long getSchemaRev() throws WvcmException
SCHEMA_REV
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
SCHEMA_REV
property.String getServer() throws WvcmException
SERVER
property as defined by
this proxy.WvcmException
- if this proxy does not define a value for the
SERVER
property.ResourceList<CqGroup> getSubscribedGroups() throws WvcmException
SUBSCRIBED_GROUPS
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
SUBSCRIBED_GROUPS
property.ResourceList<CqUser> getSubscribedUsers() throws WvcmException
SUBSCRIBED_USERS
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
SUBSCRIBED_USERS
property.long getTimeoutInterval() throws WvcmException
TIMEOUT_INTERVAL
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
TIMEOUT_INTERVAL
property.CqUserInfo getUserInfo() throws WvcmException
USER_INFO
property as defined
by this proxy.WvcmException
- if this proxy does not define a value for the
USER_INFO
property.CqUserDb.VendorType getVendor() throws WvcmException
VENDOR
property as defined by
this proxy.WvcmException
- if this proxy does not define a value for the
VENDOR
property.void setAllNamedValues(StpProperty.List<StpProperty<String>> allNameValues)
ALL_NAMED_VALUES
property of this proxy.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.void setNamedValue(String name, String value)
setProperty(new NamedValueName(name), value)
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 2016. All rights reserved.