|
Project: stp | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CqReport
A proxy interface for a ClearQuest report definition.
The user-friendly specification for the location of a report has the form
cq.query:<parent-folder-path>/<report-name>@<db-set>/<user-db>
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface CqQueryFolderItem |
---|
CqQueryFolderItem.OverwriteMode |
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<Boolean> |
IS_VALID
Whether or not this report definition is complete and ready to use for generating reports. |
static PropertyNameList.PropertyName<CqRecordType> |
PRIMARY_RECORD_TYPE
The type of record upon which this report generates reports. |
static PropertyNameList.PropertyName<CqQuery> |
QUERY
The query that selects the records to be included in the report. |
static PropertyNameList.PropertyName<CqReportFormat> |
REPORT_FORMAT
The report format that specifies how the records selected by the report's query will be formatted into a report document. |
Fields inherited from interface CqQueryFolderItem |
---|
CAN_UPDATE_OR_DELETE, CQ_MASTER_REPLICA, IS_SITE_EXTENDED_NAME_REQUIRED, QUERY_FOLDER, SITE_EXTENDED_NAME, SITE_EXTENDED_NAMES |
Fields inherited from interface CqContextResource |
---|
IS_MODIFIED |
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 | |
---|---|
CqReport |
doCreateReport(Feedback feedback)
Creates a new report resource at the location specified by this proxy and immediately delivers it to the database. |
CqReport |
doCreateReport(Feedback feedback,
List<CqContextResource> deliveryOrder)
Creates a new report resource at the location specified by this proxy. |
void |
doMakeReport(OutputStream reportHTML,
long targetRow,
long maxRows,
CqQuery.FilterLeaf... dynamicFilters)
Executes the query associated with this report and generates an HTML formatted report from the result set based on the report's designated report format. |
boolean |
getIsValid()
Returns the value of the IS_VALID property as defined
by this proxy. |
CqRecordType |
getPrimaryRecordType()
Returns the value of the PRIMARY_RECORD_TYPE
property as defined by this proxy. |
CqQuery |
getQuery()
Returns the value of the QUERY
property as defined by this proxy. |
CqReportFormat |
getReportFormat()
Returns the value of the REPORT_FORMAT property as
defined by this proxy. |
void |
setQuery(CqQuery value)
Defines a new value for the QUERY property of this proxy. |
void |
setReportFormat(CqReportFormat value)
Defines a new value for the REPORT_FORMAT property
of this proxy. |
Methods inherited from interface CqQueryFolderItem |
---|
doCopy, doCopy, doMove, doMove, getCanUpdateOrDelete, getCqMasterReplica, getIsSiteExtendedNameRequired, getQueryFolder, getSiteExtendedName, getSiteExtendedNames, setCqMasterReplica |
Methods inherited from interface CqContextResource |
---|
doDeliver, doRevert, doUnbindAll, doUnbindAll, doWriteProperties, doWriteProperties, getIsModified |
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, doWriteContent, forgetProperty, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList |
Field Detail |
---|
static final PropertyNameList.PropertyName<Boolean> IS_VALID
static final PropertyNameList.PropertyName<CqRecordType> PRIMARY_RECORD_TYPE
static final PropertyNameList.PropertyName<CqQuery> QUERY
static final PropertyNameList.PropertyName<CqReportFormat> REPORT_FORMAT
Method Detail |
---|
CqReport doCreateReport(Feedback feedback) throws WvcmException
feedback
- A Feedback object specifying the properties, if any, to
be included in the proxy returned by this method.
WvcmException
- If the report cannot be created at the specified
location, one or more of the dirty properties of this
resource are inappropriate for the new report, or the new
report cannot be delivered to the database.CqReport doCreateReport(Feedback feedback, List<CqContextResource> deliveryOrder) throws WvcmException
feedback
- A Feedback object specifying the properties, if any, to
be included in the proxy returned by this method.deliveryOrder
- If CqProvider.HOLD
the created report is
left in a writable state in the change context--the new report
in the change context must be delivered before it becomes
visible to other providers. If not CqProvider.HOLD
,
the modified and moribund resources specified by this
parameter will be delivered to or deleted from the database in
the order indicated. To deliver all modified and moribund
resources in an arbitrary order, use
CqProvider.DELIVER_ALL
. To deliver just this new
report, use CqProvider.DELIVER
. Must not be null.
WvcmException
- If the report cannot be created at the specified
location, one or more of the dirty properties of this
resource are inappropriate for the new report, or one of the
resources to be delivered cannot be delivered.void doMakeReport(OutputStream reportHTML, long targetRow, long maxRows, CqQuery.FilterLeaf... dynamicFilters) throws WvcmException
reportHTML
- An open OutputSteam that will receive the generated
HTML.targetRow
- The first row of the result set to be included in the
report.maxRows
- The maximum number of rows to be included in the reportdynamicFilters
- Any dynamic filters needed to execute the query.
WvcmException
- If there are errorsboolean getIsValid() throws WvcmException
IS_VALID
property as defined
by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_VALID
property.CqRecordType getPrimaryRecordType() throws WvcmException
PRIMARY_RECORD_TYPE
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
PRIMARY_RECORD_TYPE
property.CqQuery getQuery() throws WvcmException
QUERY
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
QUERY
property.CqReportFormat getReportFormat() throws WvcmException
REPORT_FORMAT
property as
defined by this proxy.
WvcmException
- if this proxy does not define a value for the
REPORT_FORMAT
property.void setQuery(CqQuery value)
QUERY
property of this proxy.
value
- A CqQuery object specifying the new query that will select
records for this report.void setReportFormat(CqReportFormat value)
REPORT_FORMAT
property
of this proxy.
value
- A CqReportFormat proxy specifying the new report format to
use for this report.
|
Generated Thu 15-Aug-2013 10:38 PM | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |