Package com.ptc.windchill.enterprise.report

Class Report

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
com.ptc.windchill.enterprise.report._Report
com.ptc.windchill.enterprise.report.Report
All Implemented Interfaces:
com.ptc.windchill.bac._BACManaged, com.ptc.windchill.bac.BACManaged, Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.inf.container._WTContained, WTContained, wt.query.template._CriteriaSavable, _ReportMetadata, CriteriaSavable, ReportMetadata, wt.recent.RecentlyVisited, wt.type._TypeManaged, wt.type.TypeManaged
@GenAsPersistable(superClass=Item.class,interfaces={WTContained.class,ReportMetadata.class,wt.type.TypeManaged.class,CriteriaSavable.class},serializable=EXTERNALIZABLE_BASIC,properties={@GeneratedProperty(name="reportTemplateReference",type=ObjectReference.class,supportedAPI=PUBLIC,javaDoc="Reference to {@link wt.query.template.ReportTemplate}. If specified, this serves as the source of this report\'s data unless a corresponding report exists in an external reporting system."),@GeneratedProperty(name="soapClass",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="SOAP class of Info*Engine task. If specified, this serves as the source of this report\'s data unless a corresponding report exists in an external reporting system."),@GeneratedProperty(name="soapMethod",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="SOAP method of Info*Engine task. If specified, this serves as the source of this report\'s data unless a corresponding report exists in an external reporting system."),@GeneratedProperty(name="readyForUse",type=boolean.class,supportedAPI=PUBLIC,javaDoc="Indicates whether the report is considered ready for use at this time."),@GeneratedProperty(name="uiContext",type=int.class,supportedAPI=PRIVATE,javaDoc="Bitmask field indicating UI contexts in which this report object should appear."),@GeneratedProperty(name="thirdPartyReport",type=int.class,supportedAPI=PUBLIC,javaDoc="Bitmask field indicating third party report."),@GeneratedProperty(name="localizedName",type=java.lang.String.class,javaDoc="Name that is localized using the server locale.",accessors=@PropertyAccessors(setAccess=PRIVATE),constraints=@PropertyConstraints(upperLimit=400),columnProperties=@ColumnProperties(index=true)),@GeneratedProperty(name="savedReport",type=boolean.class,initialValue="false",javaDoc="Flag to distinguish between saved report and live report"),@GeneratedProperty(name="folderPath",type=java.lang.String.class,javaDoc="create a folder under windchill folder or the folder specified by the db properties (wt.cognos.model.name) ."),@GeneratedProperty(name="reportingSystem",type=WBRReportingSystem.class,constraints=@PropertyConstraints(required=false),javaDoc="Reporting System Name"),@GeneratedProperty(name="reportExportFormatType",type=WBRExportFormatType.class,constraints=@PropertyConstraints(required=false),javaDoc="Default Format Type of Report Object"),@GeneratedProperty(name="criteriaPage",type=java.lang.String.class,constraints=@PropertyConstraints(required=false,upperLimit=400),javaDoc="When report is saved alongwith criteria, While executing same saved report on saved Report Table, We can plug an input page, which will have fetched criteria and can be displayed before executing")},tableProperties=@TableProperties(compositeIndex1="reportTemplateReference.key.id",compositeIndex2="soapClass+soapMethod",compositeIndex3="UPPER(name)",compositeUnique1="containerReference.key.id+name+reportingSystem"),iconProperties=@IconProperties(standardIcon="netmarkets/images/report.gif",openIcon="netmarkets/images/report.gif")) public class Report extends _Report
Object representing an executable report. This can mean an internal Info*Engine report task, a ReportTemplate, or a report in an external reporting system.

Use the newReport static factory method(s), not the Report 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:

  • Method Details

    • getLocalizedName

      public String getLocalizedName()
      Gets the value of the attribute: LOCALIZED_NAME. Name that is localized using the server locale.

      Supported API: true
      Overrides:
      getLocalizedName in class _Report
      Returns:
      String
      See Also:

    • getDescription

      public String getDescription()
      Gets the value of the attribute: DESCRIPTION. Describes this report object.

      Supported API: true
      Specified by:
      getDescription in interface _ReportMetadata
      Overrides:
      getDescription in class _Report
      Returns:
      String
      See Also:

    • getResourceBundle

      public String getResourceBundle()
      Gets the value of the attribute: RESOURCE_BUNDLE. Name of Java resource bundle to use to localize headers in output and parameter names when gathering user input.

      Supported API: true
      Specified by:
      getResourceBundle in interface _ReportMetadata
      Overrides:
      getResourceBundle in class _Report
      Returns:
      String
      See Also:

    • getXSLSpec

      public XSLSpec getXSLSpec()
      Gets the value of the attribute: XSLSPEC. Specifies the XSL that should be applied to this report object.

      Supported API: true
      Specified by:
      getXSLSpec in interface _ReportMetadata
      Overrides:
      getXSLSpec in class _Report
      Returns:
      XSLSpec
      See Also:

    • getReportExportFormatType

      public WBRExportFormatType getReportExportFormatType()
      If export format type not present then returning HTML as default format type. else returning assigned export report format type.

      Supported API: true
      Overrides:
      getReportExportFormatType in class _Report
      See Also: