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

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

Direct Known Subclasses:

ReportTemplate

public abstract class _ReportTemplate
extends FolderResident
implements wt.translate.Translatable, Indexable, Cloneable, Identified, WTContained, ReportMetadata, wt.type.TypeManaged, CriteriaSavable, Externalizable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOM_ACTION_MODEL	Specifies an optional, custom user interface action model for the table used to display results.
static final String	EXPOSE_AS_REPORT	Whether this ReportTemplate should be exposed as a Windchill Report object.

Fields inherited from interface wt.query.template._ReportMetadata

DESCRIPTION, INPUT_PAGE, NAME, RESOURCE_BUNDLE

Method Summary

Modifier and Type	Method	Description
String	getCustomActionModel()	Specifies an optional, custom user interface action model for the table used to display results.
String	getDescription()	Describes this report object.
String	getInputPage()	Relative path from Windchill web application root to custom input page for this report.
String	getName()	Name that identifies this report object within some scope (e.g.
String	getResourceBundle()	Name of Java resource bundle to use to localize headers in output and parameter names when gathering user input.
boolean	isExposeAsReport()	Whether this ReportTemplate should be exposed as a Windchill Report object.
void	setCustomActionModel(String customActionModel)	Specifies an optional, custom user interface action model for the table used to display results.
void	setDescription(String description)	Describes this report object.
void	setExposeAsReport(boolean exposeAsReport)	Whether this ReportTemplate should be exposed as a Windchill Report object.
void	setInputPage(String inputPage)	Relative path from Windchill web application root to custom input page for this report.
void	setName(String name)	Name that identifies this report object within some scope (e.g.
void	setResourceBundle(String resourceBundle)	Name of Java resource bundle to use to localize headers in output and parameter names when gathering user input.

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

Methods inherited from interface wt.fc.Identified

getIdentificationObject

Methods inherited from interface wt.fc.Persistable

checkAttributes

Field Details

EXPOSE_AS_REPORT

public static final String EXPOSE_AS_REPORT

Whether this ReportTemplate should be exposed as a Windchill Report object.

Supported API: true

See Also:

• ReportTemplate
• Constant Field Values

CUSTOM_ACTION_MODEL

public static final String CUSTOM_ACTION_MODEL

Specifies an optional, custom user interface action model for the table used to display results.

Supported API: true

See Also:

• ReportTemplate
• Constant Field Values

Method Details

isExposeAsReport

public boolean isExposeAsReport()

Whether this ReportTemplate should be exposed as a Windchill Report object.

Supported API: true

See Also:

• ReportTemplate

setExposeAsReport

public void setExposeAsReport(boolean exposeAsReport)
                       throws WTPropertyVetoException

Whether this ReportTemplate should be exposed as a Windchill Report object.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• ReportTemplate

getCustomActionModel

public String getCustomActionModel()

Specifies an optional, custom user interface action model for the table used to display results.

Supported API: true

See Also:

• ReportTemplate

setCustomActionModel

public void setCustomActionModel(String customActionModel)
                          throws WTPropertyVetoException

Specifies an optional, custom user interface action model for the table used to display results.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• ReportTemplate

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

Specified by:

getName in interface CabinetBased

Overrides:

getName in class FolderResident

Returns:

String

See Also:

• ReportMetadata

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:

• ReportMetadata

getDescription

public String getDescription()

Describes this report object.

Supported API: true

Specified by:

getDescription in interface _ReportMetadata

See Also:

• ReportMetadata

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:

• ReportMetadata

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:

• ReportMetadata

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:

• ReportMetadata

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:

• ReportMetadata

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:

• ReportMetadata