|
Project: stp | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CqRecordType
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 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 |
---|
static final PropertyNameList.PropertyName<ResourceList<CqAction>> ACTION_LIST
static final PropertyNameList.PropertyName<Boolean> CAN_BE_SECURITY_CONTEXT
static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> FAMILY_MEMBERS
static final PropertyNameList.PropertyName<ResourceList<CqFieldDefinition>> FIELD_DEFINITIONS
static final PropertyNameList.PropertyName<Boolean> IS_BUILT_IN_SYSTEM_OWNED
static final PropertyNameList.PropertyName<Boolean> IS_FAMILY
static final PropertyNameList.PropertyName<Boolean> IS_SECURITY_CONTEXT
static final PropertyNameList.PropertyName<Boolean> IS_STATELESS
static final PropertyNameList.PropertyName<Boolean> IS_SUBMITTABLE
static final PropertyNameList.PropertyName<Boolean> IS_UCM_ENABLED
static final PropertyNameList.PropertyName<ResourceList<CqFieldDefinition>> KEY_FIELDS
static final PropertyNameList.PropertyName<ResourceList<CqHook>> NAMED_HOOK_LIST
static final PropertyNameList.PropertyName<ResourceList<CqRecordType>> PARENT_FAMILIES
static final PropertyNameList.PropertyName<List<String>> STATE_NAME_LIST
Method Detail |
---|
CqRecordType doQuery(CqQuery.DisplayField[] displayFields, CqQuery.Filter filtering, File result, Feedback feedback, CqQuery.FileOptions options) throws WvcmException
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.
WvcmException
- if any errors occur during the execution of the
query or the formation of the response.CqResultSet doQuery(CqQuery.DisplayField[] displayFields, CqQuery.Filter filtering, long targetRow, long maxRows, CqQuery.ListOptions options) throws WvcmException
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.
WvcmException
- if any errors occur during the execution of the
query or the formation of the response.CqQuery.doExecute(long, long, com.ibm.rational.wvcm.stp.cq.CqQuery.ListOptions, com.ibm.rational.wvcm.stp.cq.CqQuery.FilterLeaf[])
CqRecordType doQuery(String sql, File result, Feedback feedback, CqQuery.FileOptions options) throws WvcmException
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.
WvcmException
- if any errors occur during the execution of the
query or the formation of the response.CqResultSet doQuery(String sql, long targetRow, long maxRows, CqQuery.ListOptions options) throws WvcmException
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.
WvcmException
- if any errors occur during the execution of the
query or the formation of the response.ResourceList<CqAction> getActionList() throws WvcmException
ACTION_LIST
property as
defined by this proxy.
WvcmException
- if this proxy does not define a value for the
ACTION_LIST
property.boolean getCanBeSecurityContext() throws WvcmException
CAN_BE_SECURITY_CONTEXT
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
CAN_BE_SECURITY_CONTEXT
property.ResourceList<CqRecordType> getFamilyMembers() throws WvcmException
FAMILY_MEMBERS
property as defined by
this proxy
WvcmException
- if this proxy does not define a value for the
FAMILY_MEMBERS
property.ResourceList<CqFieldDefinition> getFieldDefinitions() throws WvcmException
FIELD_DEFINITIONS
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
FIELD_DEFINITIONS
property.boolean getIsBuiltInSystemOwned() throws WvcmException
IS_BUILD_IN_SYSTEM_OWNED
property as
defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_BUILT_IN_SYSTEM_OWNED
property.boolean getIsFamily() throws WvcmException
IS_FAMILY
property as defined
by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_FAMILY
property.boolean getIsSecurityContext() throws WvcmException
IS_SECURITY_CONTEXT
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_SECURITY_CONTEXT
property.boolean getIsStateless() throws WvcmException
IS_STATELESS
property as
defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_STATELESS
property.boolean getIsSubmittable() throws WvcmException
IS_SUBMITTABLE
property
as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_SUBMITTABLE
property.boolean getIsUcmEnabled() throws WvcmException
IS_UCM_ENABLED
property
as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_UCM_ENABLED
property.ResourceList<CqFieldDefinition> getKeyFields() throws WvcmException
KEY_FIELDS
property as
defined by this proxy.
WvcmException
- if this proxy does not define a value for the
KEY_FIELDS
property.ResourceList<CqHook> getNamedHookList() throws WvcmException
NAMED_HOOK_LIST
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
NAMED_HOOK_LIST
property.ResourceList<CqRecordType> getParentFamilies() throws WvcmException
PARENT_FAMILIES
property as defined by
this proxy
WvcmException
- if this proxy does not define a value for the
PARENT_FAMILIES
property.List<String> getStateNameList() throws WvcmException
STATE_NAME_LIST
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
STATE_NAME_LIST
property.
|
Generated Wed 15-Jul-2015 01:05 AM | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |