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
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
Direct Known Subclasses:
Report
public abstract class _Report extends Item implements WTContained, ReportMetadata, wt.type.TypeManaged, CriteriaSavable, Externalizable
See Also:

  • Field Details

    • REPORT_TEMPLATE_REFERENCE

      public static final String REPORT_TEMPLATE_REFERENCE
      Reference to ReportTemplate. If specified, this serves as the source of this report's data unless a corresponding report exists in an external reporting system.

      Supported API: true

      See Also:

    • SOAP_CLASS

      public static final String SOAP_CLASS
      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.

      Supported API: true

      See Also:

    • SOAP_METHOD

      public static final String SOAP_METHOD
      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.

      Supported API: true

      See Also:

    • READY_FOR_USE

      public static final String READY_FOR_USE
      Indicates whether the report is considered ready for use at this time.

      Supported API: true

      See Also:

    • THIRD_PARTY_REPORT

      public static final String THIRD_PARTY_REPORT
      Bitmask field indicating third party report.

      Supported API: true

      See Also:

  • Method Details

    • getReportTemplateReference

      public ObjectReference getReportTemplateReference()
      Reference to ReportTemplate. If specified, this serves as the source of this report's data unless a corresponding report exists in an external reporting system.

      Supported API: true

      See Also:

    • setReportTemplateReference

      public void setReportTemplateReference(ObjectReference reportTemplateReference) throws WTPropertyVetoException
      Reference to ReportTemplate. If specified, this serves as the source of this report's data unless a corresponding report exists in an external reporting system.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • getSoapClass

      public String getSoapClass()
      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.

      Supported API: true

      See Also:

    • setSoapClass

      public void setSoapClass(String soapClass) throws WTPropertyVetoException
      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.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • getSoapMethod

      public String getSoapMethod()
      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.

      Supported API: true

      See Also:

    • setSoapMethod

      public void setSoapMethod(String soapMethod) throws WTPropertyVetoException
      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.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • isReadyForUse

      public boolean isReadyForUse()
      Indicates whether the report is considered ready for use at this time.

      Supported API: true

      See Also:

    • setReadyForUse

      public void setReadyForUse(boolean readyForUse) throws WTPropertyVetoException
      Indicates whether the report is considered ready for use at this time.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • getThirdPartyReport

      public int getThirdPartyReport()
      Bitmask field indicating third party report.

      Supported API: true

      See Also:

    • setThirdPartyReport

      public void setThirdPartyReport(int thirdPartyReport) throws WTPropertyVetoException
      Bitmask field indicating third party report.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • getName

      public String getName()
      Name that identifies this report object within some scope (e.g. within a given container).

      Supported API: true

      Specified by:
      getName in interface _ReportMetadata
      See Also:

    • setName

      public void setName(String name) throws WTPropertyVetoException
      Name that identifies this report object within some scope (e.g. within a given container).

      Supported API: true

      Specified by:
      setName in interface _ReportMetadata
      Throws:
      WTPropertyVetoException
      See Also:

    • getDescription

      public String getDescription()
      Describes this report object.

      Supported API: true

      Specified by:
      getDescription in interface _ReportMetadata
      See Also:

    • setDescription

      public void setDescription(String description) throws WTPropertyVetoException
      Describes this report object.

      Supported API: true

      Specified by:
      setDescription in interface _ReportMetadata
      Throws:
      WTPropertyVetoException
      See Also:

    • getInputPage

      public String getInputPage()
      Relative path from Windchill web application root to custom input page for this report.

      Supported API: true

      Specified by:
      getInputPage in interface _ReportMetadata
      See Also:

    • setInputPage

      public void setInputPage(String inputPage) throws WTPropertyVetoException
      Relative path from Windchill web application root to custom input page for this report.

      Supported API: true

      Specified by:
      setInputPage in interface _ReportMetadata
      Throws:
      WTPropertyVetoException
      See Also:

    • getResourceBundle

      public String getResourceBundle()
      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
      See Also:

    • setResourceBundle

      public void setResourceBundle(String resourceBundle) throws WTPropertyVetoException
      Name of Java resource bundle to use to localize headers in output and parameter names when gathering user input.

      Supported API: true

      Specified by:
      setResourceBundle in interface _ReportMetadata
      Throws:
      WTPropertyVetoException
      See Also: