Package wt.query.template
Class ReportTemplate
java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.enterprise._FolderResident
wt.enterprise.FolderResident
wt.query.template._ReportTemplate
wt.query.template.ReportTemplate
- All Implemented Interfaces:
com.ptc.windchill.bac._BACManaged,com.ptc.windchill.bac.BACManaged,Externalizable,Serializable,Cloneable,wt.access._AccessControlled,wt.access._PolicyAccessControlled,wt.access._SecurityLabeled,AccessControlled,wt.access.PolicyAccessControlled,SecurityLabeled,wt.admin._DomainAdministered,DomainAdministered,wt.fc._Identified,wt.fc._NetFactor,wt.fc._ObjectMappable,wt.fc._Persistable,wt.fc.adminlock._AdministrativelyLockable,AdministrativelyLockable,wt.fc.BusinessInformation,Identified,NetFactor,ObjectMappable,Persistable,wt.folder._CabinetBased,wt.folder._Foldered,wt.folder._FolderEntry,wt.folder._FolderServiceManaged,CabinetBased,Foldered,FolderEntry,wt.folder.FolderServiceManaged,DisplayIdentification,wt.index._Indexable,Indexable,wt.inf.container._WTContained,WTContained,wt.notify._Notifiable,Notifiable,wt.ownership._Ownable,wt.ownership.Ownable,wt.query.template._CriteriaSavable,_ReportMetadata,CriteriaSavable,ReportMetadata,wt.recent.RecentlyVisited,wt.translate._Translatable,wt.translate.Translatable,wt.type._TypeManaged,wt.type.TypeManaged
@GenAsPersistable(superClass=FolderResident.class,interfaces={wt.translate.Translatable.class,Indexable.class,java.lang.Cloneable.class,Identified.class,WTContained.class,ReportMetadata.class,wt.type.TypeManaged.class,CriteriaSavable.class},versions=-5710077076546339708L,properties={@GeneratedProperty(name="xml",type=java.lang.String.class,javaDoc="String representation of the query.",constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(columnType=BLOB)),@GeneratedProperty(name="legacyXml",type=java.lang.String.class,javaDoc="String representation of the query before upgrade.",columnProperties=@ColumnProperties(columnType=BLOB)),@GeneratedProperty(name="qml",type=java.lang.String.class,javaDoc="String representation of the query in new format.",columnProperties=@ColumnProperties(columnType=XML,index=true)),@GeneratedProperty(name="exposeAsReport",type=boolean.class,supportedAPI=PUBLIC,javaDoc="Whether this ReportTemplate should be exposed as a Windchill Report object."),@GeneratedProperty(name="modifier",type=WTPrincipalReference.class,javaDoc="Principal that last modified this object.",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="lastExecutedStamp",type=java.sql.Timestamp.class,accessors=@PropertyAccessors(setExceptions={}),javaDoc="Timestamp that this ReportTemplate\'s query was last executed."),@GeneratedProperty(name="qmlUpgradeStamp",type=java.sql.Timestamp.class,accessors=@PropertyAccessors(setExceptions={}),javaDoc="Timestamp that this ReportTemplate\'s query was upgraded to the new format."),@GeneratedProperty(name="customActionModel",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="Specifies an optional, custom user interface action model for the table used to display results.",constraints=@PropertyConstraints(upperLimit=400))},tableProperties=@TableProperties(compositeIndex1="UPPER(name)",compositeUnique1="containerReference.key.id+name"),iconProperties=@IconProperties(standardIcon="wt/clients/images/reportTemplate.gif",openIcon="wt/clients/images/reportTemplate.gif"))
public class ReportTemplate
extends _ReportTemplate
This class is a default implementation of a template for reporting.
It consists of query source (represented in XML), a XSL specification
for the output format, and business object attributes (e.g. name, description).
Use the newReportTemplate static factory method(s), not
the ReportTemplate constructor, to construct instances of
this class. Instances must be constructed using the static factory(s),
in order to ensure proper initialization of the instance.
Supported API: true
Extendable: false
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringLabel for the attribute; Name that identifies this report object within some scope (e.g.Fields inherited from class wt.query.template._ReportTemplate
CUSTOM_ACTION_MODEL, EXPOSE_AS_REPORT, EXTERNALIZATION_VERSION_UID, LAST_EXECUTED_STAMP, LEGACY_XML, MODIFIER, QML, QML_UPGRADE_STAMP, XMLFields inherited from class wt.enterprise._FolderResident
CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAMEFields inherited from class wt.fc._WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMPFields inherited from interface wt.fc.adminlock._AdministrativelyLockable
ADMINISTRATIVE_LOCKFields inherited from interface wt.admin._DomainAdministered
DOMAIN_REF, INHERITED_DOMAINFields inherited from interface wt.folder._Foldered
CABINET, CABINET_NAME, FOLDERING_INFO, PARENT_FOLDERFields inherited from interface wt.index._Indexable
INDEXER_SETFields inherited from interface wt.notify._Notifiable
EVENT_SETFields inherited from interface wt.ownership._Ownable
OWNERSHIPFields inherited from interface wt.fc._Persistable
PERSIST_INFOFields inherited from interface wt.query.template._ReportMetadata
DESCRIPTION, INPUT_PAGE, RESOURCE_BUNDLE, XSLSPECFields inherited from interface wt.access._SecurityLabeled
SECURITY_LABELSFields inherited from interface wt.translate._Translatable
TRANSLATION_INFOFields inherited from interface wt.inf.container._WTContained
CONTAINER, CONTAINER_NAME, CONTAINER_REFERENCEFields inherited from interface wt.fc.BusinessInformation
BUSINESS_TYPE, IDENTITYFields inherited from interface wt.folder.CabinetBased
FOLDER_PATH, LOCATIONFields inherited from interface wt.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPEFields inherited from interface wt.fc.Persistable
IDENTITY, TYPEFields inherited from interface wt.access.SecurityLabeled
SECURITY_LABELS_INTERNAL_VALUEFields inherited from interface wt.inf.container.WTContained
CONTAINER_ID -
Method Summary
Modifier and TypeMethodDescriptionvoidClears the value of the attribute: Qml Object.Gets the value of the attribute: Qml Object Provides an abstraction for accessing the query XML.Deprecated.Methods inherited from class wt.query.template._ReportTemplate
getClassInfo, getConceptualClassname, getContainer, getContainerName, getContainerReference, getCustomActionModel, getDescription, getIndexerSet, getInputPage, getLastExecutedStamp, getLegacyXml, getModifier, getName, getQml, getQmlUpgradeStamp, getResourceBundle, getType, getXSLSpec, isExposeAsReport, readExternal, readExternal, readVersion, setContainer, setContainerReference, setCustomActionModel, setDescription, setExposeAsReport, setIndexerSet, setInputPage, setLastExecutedStamp, setLegacyXml, setModifier, setName, setQmlUpgradeStamp, setResourceBundle, super_readExternal_ReportTemplate, super_readVersion_ReportTemplate, super_writeExternal_ReportTemplate, writeExternal, writeExternalMethods inherited from class wt.enterprise.FolderResident
getBusinessType, getCabinetReference, getFolderPath, getLocation, initializeMethods inherited from class wt.enterprise._FolderResident
getAdministrativeLock, getCabinet, getCabinetName, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEventSet, getFolderingInfo, getOwnership, getParentFolder, getSecurityLabels, isInheritedDomain, readVersion, setAdministrativeLock, setDomainRef, setEventSet, setFolderingInfo, setInheritedDomain, setOwnership, setSecurityLabels, super_readExternal_FolderResident, super_readVersion_FolderResident, super_writeExternal_FolderResidentMethods inherited from class wt.fc.WTObject
checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, toStringMethods inherited from class wt.fc._WTObject
equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfoMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface wt.fc._Persistable
getPersistInfo, setPersistInfoMethods inherited from interface wt.fc.Persistable
checkAttributes
-
Field Details
-
NAME
Label for the attribute; Name that identifies this report object within some scope (e.g. within a given container).
Supported API: true- See Also:
-
-
Method Details
-
getQmlObject
Gets the value of the attribute: Qml Object Provides an abstraction for accessing the query XML.
Supported API: true- Returns:
- Object
- Throws:
WTException
-
getXMLSource
Deprecated.Gets the value of the attribute: XMLSOURCE. Provides an abstraction for accessing the query XML.
Supported API: true- Returns:
- XMLSource
- Throws:
WTException
-
clearQmlObject
Clears the value of the attribute: Qml Object.
Supported API: true- Throws:
WTException
-
ReportTemplateHelper.buildParameterTemplates(ReportTemplate)