Project: stp

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

All Superinterfaces:
CqResource, CqUserDb.SearchKey<Boolean>, CqUserDbMember, Resource, StpResource

public interface CqRecordType
extends CqUserDbMember, CqUserDb.SearchKey<Boolean>

A proxy for the specification of a record type in a database. The user-friendly specification for the location of a record type has the form

  cq.record:<record-type-name>@<db-set>/<user-db>
 


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpResource
StpResource.UnsupportedProperty
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Field Summary
static PropertyNameList.PropertyName<ResourceList<CqAction>> ACTION_LIST
          All of the actions defined on this record type.
static PropertyNameList.PropertyName<Boolean> CAN_BE_SECURITY_CONTEXT
          Answers whether or not records of this type can be security contexts.
static PropertyNameList.PropertyName<ResourceList<CqRecordType>> FAMILY_MEMBERS
          The record types that are members of this record type family.
static PropertyNameList.PropertyName<ResourceList<CqFieldDefinition>> FIELD_DEFINITIONS
          A list of the field definitions of this record type
static PropertyNameList.PropertyName<Boolean> IS_BUILT_IN_SYSTEM_OWNED
          Answers whether or not this record type is a built-in record type, not added by a schema developer or package.
static PropertyNameList.PropertyName<Boolean> IS_FAMILY
          Answers whether or not this is the definition of a record type family.
static PropertyNameList.PropertyName<Boolean> IS_SECURITY_CONTEXT
          Answers whether or a record of this record type is used as a security context
static PropertyNameList.PropertyName<Boolean> IS_STATELESS
          Answers whether or not this record type is a stateless record type.
static PropertyNameList.PropertyName<Boolean> IS_SUBMITTABLE
          Answers whether or not records of this type may be submitted by clients.
static PropertyNameList.PropertyName<Boolean> IS_UCM_ENABLED
          Answers whether or not records of this type may be used as a UCM activity.
static PropertyNameList.PropertyName<ResourceList<CqFieldDefinition>> KEY_FIELDS
          A list of the schema-defined fields that constitute the unique key for records of this type, presented in sort-key order starting from the primary sort key.
static PropertyNameList.PropertyName<ResourceList<CqHook>> NAMED_HOOK_LIST
          All of the named hooks associated with this record type.
static PropertyNameList.PropertyName<ResourceList<CqRecordType>> PARENT_FAMILIES
          A list of the record type families this record is a member of.
static PropertyNameList.PropertyName<List<String>> STATE_NAME_LIST
          The names of all the states defined for this record type.
 
Fields inherited from interface CqUserDbMember
DB_SET, USER_DB
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpResource
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
 
Fields inherited from interface javax.wvcm.Resource
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
 
Method Summary
 CqRecordType doQuery(CqQuery.DisplayField[] displayFields, CqQuery.Filter filtering, File result, Feedback feedback, CqQuery.FileOptions options)
          Returns specified fields from records that are of the type defined by this record type and match a specified filtering expression.
 CqResultSet doQuery(CqQuery.DisplayField[] displayFields, CqQuery.Filter filtering, long targetRow, long maxRows, CqQuery.ListOptions options)
          Returns specified fields from records that are of this record type and match a specified filtering expression.
 CqRecordType doQuery(String sql, File result, Feedback feedback, CqQuery.FileOptions options)
          Returns specified fields from records that are of the type defined by this record type and match a specified filtering expression.
 CqResultSet doQuery(String sql, long targetRow, long maxRows, CqQuery.ListOptions options)
          Returns specified fields from records that are of the type defined by this record type and match a specified filtering expression.
 ResourceList<CqAction> getActionList()
          Returns the value of the ACTION_LIST property as defined by this proxy.
 boolean getCanBeSecurityContext()
          Returns the value of the CAN_BE_SECURITY_CONTEXT property as defined by this proxy.
 ResourceList<CqRecordType> getFamilyMembers()
          Returns the value of the FAMILY_MEMBERS property as defined by this proxy
 ResourceList<CqFieldDefinition> getFieldDefinitions()
          Returns the value of the FIELD_DEFINITIONS property as defined by this proxy.
 boolean getIsBuiltInSystemOwned()
          Returns the value of the IS_BUILD_IN_SYSTEM_OWNED property as defined by this proxy.
 boolean getIsFamily()
          Returns the value of the IS_FAMILY property as defined by this proxy.
 boolean getIsSecurityContext()
          Returns the value of the IS_SECURITY_CONTEXT property as defined by this proxy.
 boolean getIsStateless()
          Returns the value of the IS_STATELESS property as defined by this proxy.
 boolean getIsSubmittable()
          Returns the value of the IS_SUBMITTABLE property as defined by this proxy.
 boolean getIsUcmEnabled()
          Returns the value of the IS_UCM_ENABLED property as defined by this proxy.
 ResourceList<CqFieldDefinition> getKeyFields()
          Returns the value of the KEY_FIELDS property as defined by this proxy.
 ResourceList<CqHook> getNamedHookList()
          Returns the value of the NAMED_HOOK_LIST property as defined by this proxy.
 ResourceList<CqRecordType> getParentFamilies()
          Returns the value of the PARENT_FAMILIES property as defined by this proxy
 List<String> getStateNameList()
          Returns the value of the STATE_NAME_LIST property as defined by this proxy.
 
Methods inherited from interface CqUserDbMember
getDbSet, getUserDb
 
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
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, stpLocation, stpProvider
 
Methods inherited from interface javax.wvcm.Resource
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
 

Field Detail

ACTION_LIST

static final PropertyNameList.PropertyName<ResourceList<CqAction>> ACTION_LIST
All of the actions defined on this record type.


CAN_BE_SECURITY_CONTEXT

static final PropertyNameList.PropertyName<Boolean> CAN_BE_SECURITY_CONTEXT
Answers whether or not records of this type can be security contexts.


FAMILY_MEMBERS

static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> FAMILY_MEMBERS
The record types that are members of this record type family. The list is empty is this is not a record type family.


FIELD_DEFINITIONS

static final PropertyNameList.PropertyName<ResourceList<CqFieldDefinition>> FIELD_DEFINITIONS
A list of the field definitions of this record type


IS_BUILT_IN_SYSTEM_OWNED

static final PropertyNameList.PropertyName<Boolean> IS_BUILT_IN_SYSTEM_OWNED
Answers whether or not this record type is a built-in record type, not added by a schema developer or package.


IS_FAMILY

static final PropertyNameList.PropertyName<Boolean> IS_FAMILY
Answers whether or not this is the definition of a record type family.


IS_SECURITY_CONTEXT

static final PropertyNameList.PropertyName<Boolean> IS_SECURITY_CONTEXT
Answers whether or a record of this record type is used as a security context


IS_STATELESS

static final PropertyNameList.PropertyName<Boolean> IS_STATELESS
Answers whether or not this record type is a stateless record type.


IS_SUBMITTABLE

static final PropertyNameList.PropertyName<Boolean> IS_SUBMITTABLE
Answers whether or not records of this type may be submitted by clients.


IS_UCM_ENABLED

static final PropertyNameList.PropertyName<Boolean> IS_UCM_ENABLED
Answers whether or not records of this type may be used as a UCM activity.


KEY_FIELDS

static final PropertyNameList.PropertyName<ResourceList<CqFieldDefinition>> KEY_FIELDS
A list of the schema-defined fields that constitute the unique key for records of this type, presented in sort-key order starting from the primary sort key. (Note: In this release computation of this property requires the IS_RAW_SQL_WRITER permission.)


NAMED_HOOK_LIST

static final PropertyNameList.PropertyName<ResourceList<CqHook>> NAMED_HOOK_LIST
All of the named hooks associated with this record type.


PARENT_FAMILIES

static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> PARENT_FAMILIES
A list of the record type families this record is a member of.


STATE_NAME_LIST

static final PropertyNameList.PropertyName<List<String>> STATE_NAME_LIST
The names of all the states defined for this record type. Will be an empty list if this is a stateless record type.

Method Detail

doQuery

CqRecordType doQuery(CqQuery.DisplayField[] displayFields,
                     CqQuery.Filter filtering,
                     File result,
                     Feedback feedback,
                     CqQuery.FileOptions options)
                     throws WvcmException
Returns specified fields from records that are of the type defined by this record type and match a specified filtering expression. This proxy does not need to define any properties as only its location is needed to establish the type of records to be selected and the database from which to select them.

Parameters:
displayFields - An array of CqQuery.DisplayField objects, each specifying a value to be returned from each selected record and collectively specifying the order in which the matched records are to be included in the response. Must not be null.
filtering - A CqQuery.Filter node specifying how the records of this type are to be selected for inclusion in the response. May be null, in which case all records of this record type will be included (up to the limits imposed by the targetRow and maxRows parameters).
options - An instance of CqQuery.FileOptions that specifies optional attributes for controlling the format of the response response. May be null, in which case server-specified values will be used for each attribute.
feedback - A Feedback instance specifying properties to be returned from the operation in the CqRecordType proxy. May be null.
result - The File into which the result set is to be written. Must not be null.
Returns:
A proxy for this record type, populated with the properties requested by the Feedback argument.
Throws:
WvcmException - if any errors occur during the execution of the query or the formation of the response.

doQuery

CqResultSet doQuery(CqQuery.DisplayField[] displayFields,
                    CqQuery.Filter filtering,
                    long targetRow,
                    long maxRows,
                    CqQuery.ListOptions options)
                    throws WvcmException
Returns specified fields from records that are of this record type and match a specified filtering expression. This proxy does not need to define any properties as only its location is needed to establish the record type to be selected and the database from which to select them.

Parameters:
displayFields - An array of CqQuery.DisplayField objects, each specifying a value to be returned from each selected record and collectively specifying the order in which the matched records are to be included in the response. Must not be null.
filtering - A CqQuery.Filter object specifying how the records of this type are to be selected for inclusion in the response. May be null, in which case all records of this record type will be included (up to the limits imposed by the targetRow and maxRows parameters).
targetRow - Specifies the first record that is to be included in the response among the records that match the filter, where a value of 1 specifies the first matching record. The ordering of matched records is defined by the display fields array.
maxRows - The maximum number of records that should be included in the response to this request. A value of Long.MAX_VALUE will request that the targeted record and all records after it in the prescribed ordering should be included in the response; If this parameter is 0, no records will be included. If the filter matches fewer than the maximum records requested, it is not an error.
options - An instance of CqQuery.ListOptions that specifies optional attributes for controlling the performance of the query or its response. May be null, in which case server-specified values will be used for each attribute.
Returns:
A CqResultSet of CqRowData objects each representing a record selected by the filter and containing the values specified by the display fields array. The values in each CqRowData object are ordered according to the display fields array. The total row count, if requested, is available as a field of the returned CqResultSet.
Throws:
WvcmException - if any errors occur during the execution of the query or the formation of the response.
See Also:
CqQuery.doExecute(long, long, com.ibm.rational.wvcm.stp.cq.CqQuery.ListOptions, com.ibm.rational.wvcm.stp.cq.CqQuery.FilterLeaf[])

doQuery

CqRecordType doQuery(String sql,
                     File result,
                     Feedback feedback,
                     CqQuery.FileOptions options)
                     throws WvcmException
Returns specified fields from records that are of the type defined by this record type and match a specified filtering expression. To launch this method this proxy does not need to define any properties as only its location is needed to establish the type of records to be selected and the database from which to select them.

Parameters:
sql - A String containing an SQL specification for the fields to be returned by the query and the filter to be used to select the records.
result - The File into which the result set is to be written. Must not be null.
feedback - A Feedback instance specifying properties to be returned from the operation in the CqRecordType proxy. May be null.
options - An instance of FileOptions that specifies optional attributes for controlling the format of the response response. May be null, in which case server-specified values will be used for each attribute.
Returns:
A proxy for this record type, populated with the properties requested by the Feedback argument.
Throws:
WvcmException - if any errors occur during the execution of the query or the formation of the response.

doQuery

CqResultSet doQuery(String sql,
                    long targetRow,
                    long maxRows,
                    CqQuery.ListOptions options)
                    throws WvcmException
Returns specified fields from records that are of the type defined by this record type and match a specified filtering expression. To launch this method this proxy does not need to define any properties as only its location is needed to establish the type of records to be selected and the database from which to select them.

Parameters:
sql - A String containing an SQL select statement specifying the fields to be returned by the query and the filter to be used to select the records.
targetRow - Specifies the first record that is to be included in the response among the records that match the filter, where a value of 1 specifies the first matching record. The ordering of matched records is defined by the display fields array.
maxRows - The maximum number of records that should be included in the response to this request. A value of Long.MAX_VALUE will request that the targeted record and all records after it in the prescribed ordering should be included in the response; If this parameter is 0, no records will be included. If the filter matches fewer than the maximum records requested, it is not an error.
options - An instance of CqQuery.ListOptions that specifies optional attributes for controlling the performance of the query or its response. May be null, in which case server-specified values will be used for each attribute.
Returns:
A CqResultSet containing a list of CqRowData objects, each representing a record selected by the filter and containing the values specified by the SQL string. The values in each CqRowData object are ordered according to the SQL select statement.
Throws:
WvcmException - if any errors occur during the execution of the query or the formation of the response.

getActionList

ResourceList<CqAction> getActionList()
                                     throws WvcmException
Returns the value of the ACTION_LIST property as defined by this proxy.

Returns:
A ResourceList of CqAction proxies containing all of the actions defined for this record type.
Throws:
WvcmException - if this proxy does not define a value for the ACTION_LIST property.

getCanBeSecurityContext

boolean getCanBeSecurityContext()
                                throws WvcmException
Returns the value of the CAN_BE_SECURITY_CONTEXT property as defined by this proxy.

Returns:
true if records of this type can be security contexts
Throws:
WvcmException - if this proxy does not define a value for the CAN_BE_SECURITY_CONTEXT property.

getFamilyMembers

ResourceList<CqRecordType> getFamilyMembers()
                                            throws WvcmException
Returns the value of the FAMILY_MEMBERS property as defined by this proxy

Returns:
A ResourceList containing a CqRecordType proxy for each record type that is a member of this record type family; Will never be null but may be empty if this is not a record type family or if no members are defined.
Throws:
WvcmException - if this proxy does not define a value for the FAMILY_MEMBERS property.

getFieldDefinitions

ResourceList<CqFieldDefinition> getFieldDefinitions()
                                                    throws WvcmException
Returns the value of the FIELD_DEFINITIONS property as defined by this proxy.

Returns:
A ResourceList of CqFieldDefinition record proxies; one proxy per field of this record type. Will never by null.
Throws:
WvcmException - if this proxy does not define a value for the FIELD_DEFINITIONS property.

getIsBuiltInSystemOwned

boolean getIsBuiltInSystemOwned()
                                throws WvcmException
Returns the value of the IS_BUILD_IN_SYSTEM_OWNED property as defined by this proxy.

Returns:
true if this record type is defined for all ClearQuest schemas as part of the base implementation.
Throws:
WvcmException - if this proxy does not define a value for the IS_BUILT_IN_SYSTEM_OWNED property.

getIsFamily

boolean getIsFamily()
                    throws WvcmException
Returns the value of the IS_FAMILY property as defined by this proxy.

Returns:
true if this is a record type family specification.
Throws:
WvcmException - if this proxy does not define a value for the IS_FAMILY property.

getIsSecurityContext

boolean getIsSecurityContext()
                             throws WvcmException
Returns the value of the IS_SECURITY_CONTEXT property as defined by this proxy.

Returns:
true if records of this type are used as security contexts.
Throws:
WvcmException - if this proxy does not define a value for the IS_SECURITY_CONTEXT property.

getIsStateless

boolean getIsStateless()
                       throws WvcmException
Returns the value of the IS_STATELESS property as defined by this proxy.

Returns:
true if this is a stateless record type.
Throws:
WvcmException - if this proxy does not define a value for the IS_STATELESS property.

getIsSubmittable

boolean getIsSubmittable()
                         throws WvcmException
Returns the value of the IS_SUBMITTABLE property as defined by this proxy.

Returns:
true if records of this type may be submitted by clients.
Throws:
WvcmException - if this proxy does not define a value for the IS_SUBMITTABLE property.

getIsUcmEnabled

boolean getIsUcmEnabled()
                        throws WvcmException
Returns the value of the IS_UCM_ENABLED property as defined by this proxy.

Returns:
true if records of this type may be used as a UCM activity.
Throws:
WvcmException - if this proxy does not define a value for the IS_UCM_ENABLED property.

getKeyFields

ResourceList<CqFieldDefinition> getKeyFields()
                                             throws WvcmException
Returns the value of the KEY_FIELDS property as defined by this proxy.

Returns:
A ResourceList of CqFieldDefinition proxies each representing a key field of this record type presented in sort-key order..
Throws:
WvcmException - if this proxy does not define a value for the KEY_FIELDS property.

getNamedHookList

ResourceList<CqHook> getNamedHookList()
                                      throws WvcmException
Returns the value of the NAMED_HOOK_LIST property as defined by this proxy.

Returns:
A ResourceList of CqHook proxies containing all the named hooks of this record type.
Throws:
WvcmException - if this proxy does not define a value for the NAMED_HOOK_LIST property.

getParentFamilies

ResourceList<CqRecordType> getParentFamilies()
                                             throws WvcmException
Returns the value of the PARENT_FAMILIES property as defined by this proxy

Returns:
A ResourceList containing a CqRecordType proxy for each record type family that this record type is a member of; Will never be null but may be empty if this record type is not a member of a record type family.
Throws:
WvcmException - if this proxy does not define a value for the PARENT_FAMILIES property.

getStateNameList

List<String> getStateNameList()
                              throws WvcmException
Returns the value of the STATE_NAME_LIST property as defined by this proxy.

Returns:
A list of Strings, each containing the name of a state of this record type. Will be an empty list if this is a stateless record type.
Throws:
WvcmException - if this proxy does not define a value for the STATE_NAME_LIST property.

Generated Wed 18-May-2011 12:24 PM

Copyright © IBM 2011. All rights reserved.