jet.server.api.custom.schedule
Interface ParameterGenerator


public interface ParameterGenerator

ParameterGenerator. Instances of classes that implement this interface are used to get report parameters. These instances are used to work out parameter values and provide the values to the server for running reports at the scheduled running time.

Since:
v8.0

Method Summary
 void close()
          Releases the resources of the generator.
 java.lang.String getParameterValue(java.lang.String pmName)
          Gets the value of a specified parameter.
 void initByReportContext(ServerInfo srvInfo)
          Initializes the generator by report context.
 

Method Detail

initByReportContext

void initByReportContext(ServerInfo srvInfo)
Initializes the generator by report context.

Parameters:
srvInfo - the ServerInfo>, which provides some methods for getting information of the server and tasks. e.g. task ID, task class, next run time, schedule type...

getParameterValue

java.lang.String getParameterValue(java.lang.String pmName)
Gets the value of a specified parameter.

Parameters:
pmName - the parameter name.
Returns:
the parameter value String.

close

void close()
Releases the resources of the generator.