wt.query.template
Class ReportTemplate

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.FolderResident
          wt.query.template.ReportTemplate

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, wt.fc.BusinessInformation, Identified, NetFactor, ObjectMappable, Persistable, CabinetBased, Foldered, FolderEntry, wt.folder.FolderServiceManaged, DisplayIdentification, Indexable, WTContained, Notifiable, Ownable, ReportMetadata, wt.recent.RecentlyVisited

public class ReportTemplate
extends FolderResident
implements Indexable, Cloneable, Identified, WTContained, ReportMetadata, Externalizable

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:

Serialized Form

Field Summary

static String	EXPOSE_AS_REPORT Label for the attribute; Whether this ReportTemplate should be exposed as a Windchill Report object.
static String	NAME Label for the attribute; Name that identifies this report object within some scope (e.g.
static String	XMLSOURCE Label for the attribute; Provides an abstraction for accessing the query XML.

Fields inherited from interface wt.query.template.ReportMetadata

DESCRIPTION, INPUT_PAGE, RESOURCE_BUNDLE

Method Summary

String	getDescription() Gets the value of the attribute: DESCRIPTION.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getInputPage() Gets the value of the attribute: INPUT_PAGE.
String	getName() Gets the value of the attribute: NAME.
String	getResourceBundle() Gets the value of the attribute: RESOURCE_BUNDLE.
XMLSource	getXMLSource() Gets the value of the attribute: XMLSOURCE.
boolean	isExposeAsReport() Gets the value of the attribute: EXPOSE_AS_REPORT.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setExposeAsReport(boolean a_ExposeAsReport) Sets the value of the attribute: EXPOSE_AS_REPORT.
void	setInputPage(String a_InputPage) Sets the value of the attribute: INPUT_PAGE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setResourceBundle(String a_ResourceBundle) Sets the value of the attribute: RESOURCE_BUNDLE.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

XMLSOURCE

public static final String XMLSOURCE

Label for the attribute; Provides an abstraction for accessing the query XML.

Supported API: true

See Also:

Constant Field Values

EXPOSE_AS_REPORT

public static final String EXPOSE_AS_REPORT

Label for the attribute; Whether this ReportTemplate should be exposed as a Windchill Report object.

Supported API: true

See Also:

Constant Field Values

NAME

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

Constant Field Values

Method Detail

getXMLSource

public XMLSource getXMLSource()
                       throws WTException

Gets the value of the attribute: XMLSOURCE. Provides an abstraction for accessing the query XML.

Supported API: true

Returns:

XMLSource

Throws:

WTException

isExposeAsReport

public boolean isExposeAsReport()

Gets the value of the attribute: EXPOSE_AS_REPORT. Whether this ReportTemplate should be exposed as a Windchill Report object.

Supported API: true

Returns:

boolean

setExposeAsReport

public void setExposeAsReport(boolean a_ExposeAsReport)
                       throws WTPropertyVetoException

Sets the value of the attribute: EXPOSE_AS_REPORT. Whether this ReportTemplate should be exposed as a Windchill Report object.

Supported API: true

Parameters:

a_ExposeAsReport -

Throws:

WTPropertyVetoException

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: true

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getName

public String getName()

Gets the value of the attribute: NAME. Name that identifies this report object within some scope (e.g. within a given container).

Supported API: true

Specified by:

getName in interface ReportMetadata

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. Name that identifies this report object within some scope (e.g. within a given container).

Supported API: true

Specified by:

setName in interface ReportMetadata

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Describes this report object.

Supported API: true

Specified by:

getDescription in interface ReportMetadata

Returns:

String

setDescription

public void setDescription(String a_Description)

Sets the value of the attribute: DESCRIPTION. Describes this report object.

Supported API: true

Specified by:

setDescription in interface ReportMetadata

Parameters:

a_Description -

getInputPage

public String getInputPage()

Gets the value of the attribute: INPUT_PAGE. Relative path from Windchill web application root to custom input page for this report.

Supported API: true

Specified by:

getInputPage in interface ReportMetadata

Returns:

String

setInputPage

public void setInputPage(String a_InputPage)
                  throws WTPropertyVetoException

Sets the value of the attribute: INPUT_PAGE. Relative path from Windchill web application root to custom input page for this report.

Supported API: true

Specified by:

setInputPage in interface ReportMetadata

Parameters:

a_InputPage -

Throws:

WTPropertyVetoException

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

Returns:

String

setResourceBundle

public void setResourceBundle(String a_ResourceBundle)
                       throws WTPropertyVetoException

Sets 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:

setResourceBundle in interface ReportMetadata

Parameters:

a_ResourceBundle -

Throws:

WTPropertyVetoException