com.gestalt.scribe
Class Parameter

java.lang.Object
  |
  +--com.gestalt.scribe.Parameter

public class Parameter

extends java.lang.Object

Parameter class provides the means of passing run-time parameters to a report. All parameter values, regardless of their internal data type, are passed as Strings. However, they must be formatted according to the data types, as described in setValue() method. Parameter objects are created by Scribe server, and are returned to the client application via getReportParameters() method of Connector class. The client application is responsible for setting values of the report parameters and passing them back to the server.

See Also:

Connector

Method Summary

int	getDataType() Returns the Parameter data type.
java.lang.String	getName()
void	setValue(java.lang.String str) Sets the value of the Parameter.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

setValue

public void setValue(java.lang.String str)

Sets the value of the Parameter.

Parameters:

str - value of the Parameter. Depending on the Parameter's data type, the str value must be formatted as follows:

Data type	Formatting
TEXT	Free-formatted
PASSWORD	Free-formatted
DATE	YYYYMMDD (e.g. "20040315" for March 15, 2004)
TIME	HHMMSS (e.g. "172500" for 5:25 PM)
INTEGER	Integer number (only + or - sign, followed by digits from 0 to 9)
SHORT	Short number, same as INTEGER
TINY	1-byte number, same as INTEGER
FLOAT	Floating-point number (only + or - sign, followed by digits from 0 to 9, with an optional decimal point)
MONEY	Same as FLOAT
LOGICAL	"Yes" or "No"

See Also:

Constants

getName

public java.lang.String getName()

Returns the Parameter name.

Returns:

Name of the Parameter as defined in the Report procedure.

getDataType

public int getDataType()

Returns the Parameter data type. Data types are defined in Constants interface.

Returns:

Data type of the Parameter as defined in the Report procedure.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object