Project: stp

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

All Superinterfaces:
CqContextResource, CqQueryFolderItem, CqResource, CqUserDbMember, Resource, StpResource

public interface CqReportFormat
extends CqQueryFolderItem

An interface specification for the proxy for a ClearQuest report format resource. New report formats cannot be created via this API. The Crystal Reports definition file can be obtained through this API by invoking doReadContent on a CqReportFormat proxy.

The user-friendly specification for the location of a report format has the form

  cq.query:<parent-folder-path>/<report-format-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<CqRecordType> RECORD_TYPE
          The type of record for which this report format is defined.
 
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
 CqRecordType getRecordType()
          Returns the value of the RECORD_TYPE property as defined by 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 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, doWriteContent, forgetProperty, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList
 

Field Detail

RECORD_TYPE

static final PropertyNameList.PropertyName<CqRecordType> RECORD_TYPE
The type of record for which this report format is defined.

Method Detail

getRecordType

CqRecordType getRecordType()
                           throws WvcmException
Returns the value of the RECORD_TYPE property as defined by this proxy.

Returns:
A CqRecordType proxy specifying the type of record this report format is designed to format.
Throws:
WvcmException - if this proxy does not define a value for the RECORD_TYPE property.

Generated Wed 17-Oct-2012 09:36 PM

Copyright © IBM 2012. All rights reserved.