wt.query.template
Interface ReportMetadata

All Known Implementing Classes:

ReportTemplate

public interface ReportMetadata

This interface contains attributes held in common between ReportTemplate and Report.

Supported API: true

Extendable: false

Field Summary

static String	DESCRIPTION Label for the attribute; Describes this report object.
static String	INPUT_PAGE Label for the attribute; Relative path from Windchill web application root to custom input page for this report.
static String	NAME Label for the attribute; Name that identifies this report object within some scope (e.g.
static String	RESOURCE_BUNDLE Label for the attribute; Name of Java resource bundle to use to localize headers in output and parameter names when gathering user input.

Method Summary

String	getDescription() Gets the value of the attribute: DESCRIPTION.
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.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
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.

Field Detail

NAME

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

DESCRIPTION

static final String DESCRIPTION

Label for the attribute; Describes this report object.

Supported API: true

See Also:

Constant Field Values

INPUT_PAGE

static final String INPUT_PAGE

Label for the attribute; Relative path from Windchill web application root to custom input page for this report.

Supported API: true

See Also:

Constant Field Values

RESOURCE_BUNDLE

static final String RESOURCE_BUNDLE

Label for the attribute; Name of Java resource bundle to use to localize headers in output and parameter names when gathering user input.

Supported API: true

See Also:

Constant Field Values

Method Detail

getName

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

Returns:

String

setName

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

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

String getDescription()

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

Supported API: true

Returns:

String

setDescription

void setDescription(String a_Description)

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

Supported API: true

Parameters:

a_Description -

getInputPage

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

Returns:

String

setInputPage

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

Parameters:

a_InputPage -

Throws:

WTPropertyVetoException

getResourceBundle

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

Returns:

String

setResourceBundle

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

Parameters:

a_ResourceBundle -

Throws:

WTPropertyVetoException