jet.server.api.rmi
Interface RemoteParamInfo

All Superinterfaces:

java.rmi.Remote

public interface RemoteParamInfo

extends java.rmi.Remote

Interface RemoteParamInfo contains description of parameters of a report.

Since:

5.2

Method Summary

java.lang.String	getDefaultValue() Return default value of the parameter.
java.util.Vector	getDisplayValues(java.util.Locale locale) Return the parameter value displayed.
java.lang.String	getMaxLimit(java.util.Locale locale) Return the max limit of the parameter value.
java.lang.String	getMinLimit(java.util.Locale locale) Return the max limit of the parameter value.
java.lang.String	getName() Return the name of the parameter.
java.lang.String	getPrompt() Return the prompt message of the parameter.
java.lang.String	getType() Return the type of the parameter.
java.lang.String	getUserFormat() Return the user defined format of the parameter.
java.util.Vector	getValueOptions(java.util.Locale locale) Return the options of the parameter value.
boolean	isColumn() Return if the parameter only accepts a column name as its value.
boolean	isDistinct() Returns if the parameter is distinct.
boolean	isParameters() Return if the values are parameters.
boolean	isReferedBy() Return if the parameter is refered by other parameters.
boolean	isRequired() Returns if the parameter is required.
void	setEncoding(java.lang.String encoding)
void	setValue(java.lang.String value) Set the parameter value.

Method Detail

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException

Return the name of the parameter.

Returns:

name of the parameter.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

getType

public java.lang.String getType()
                         throws java.rmi.RemoteException

Return the type of the parameter. Possible values are: "String", "Number", "Currency", "Boolean", "Date", "Time", "DateTime".

Returns:

type of the parameter.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

getPrompt

public java.lang.String getPrompt()
                           throws java.rmi.RemoteException

Return the prompt message of the parameter.

Returns:

the prompt message of the parameter.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

getDefaultValue

public java.lang.String getDefaultValue()
                                 throws java.rmi.RemoteException

Return default value of the parameter.

Returns:

default value of the parameter.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

isColumn

public boolean isColumn()
                 throws java.rmi.RemoteException

Return if the parameter only accepts a column name as its value.

Returns:

if the parameter only accepts a column name as its value.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

isDistinct

public boolean isDistinct()
                   throws java.rmi.RemoteException

Returns if the parameter is distinct.

Returns:

if the parameter is distinct.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

isRequired

public boolean isRequired()
                   throws java.rmi.RemoteException

Returns if the parameter is required.

Returns:

if the parameter is required.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

getValueOptions

public java.util.Vector getValueOptions(java.util.Locale locale)
                                 throws java.rmi.RemoteException

Return the options of the parameter value.

Parameters:

locale - the Locale of the parameter.

Returns:

the options of the parameter value. The Vector contains the Strings of value options.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

getDisplayValues

public java.util.Vector getDisplayValues(java.util.Locale locale)
                                  throws java.rmi.RemoteException

Return the parameter value displayed.

Parameters:

locale - the Locale of the parameter.

Returns:

original column if no binding, return binding column if binding.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

setEncoding

public void setEncoding(java.lang.String encoding)
                 throws java.rmi.RemoteException

java.rmi.RemoteException

setValue

public void setValue(java.lang.String value)
              throws java.rmi.RemoteException

Set the parameter value.

Parameters:

value - the parameter value.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

getMaxLimit

public java.lang.String getMaxLimit(java.util.Locale locale)
                             throws java.rmi.RemoteException

Return the max limit of the parameter value.

Parameters:

locale - the Locale of the parameter.

Returns:

the max limit of the parameter value.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

getMinLimit

public java.lang.String getMinLimit(java.util.Locale locale)
                             throws java.rmi.RemoteException

Return the max limit of the parameter value.

Parameters:

locale - the Locale of the parameter.

Returns:

the max limit of the parameter value.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

getUserFormat

public java.lang.String getUserFormat()
                               throws java.rmi.RemoteException

Return the user defined format of the parameter. If the parameter type is "String", the user format is the String Encoding. return the user defined format of the parameter.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

isParameters

public boolean isParameters()
                     throws java.rmi.RemoteException

Return if the values are parameters.

Returns:

if the values are parameters.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.

isReferedBy

public boolean isReferedBy()
                    throws java.rmi.RemoteException

Return if the parameter is refered by other parameters.

Returns:

if the parameter is refered by other parameters.

Throws:

java.rmi.RemoteException - if a RemoteException occurs.