org.eclipse.birt.report.engine.api.script
Interface IReportContext


public interface IReportContext

An interface used to share information between the event methods in scripting. Gives access to report parameters and configuration values. Also provides a way for the report developer to register and retrieve custom properties.


Method Summary
 void deleteGlobalVariable(java.lang.String name)
          Remove an object from runtime scope.
 void deletePersistentGlobalVariable(java.lang.String name)
          Remove an object from report document scope.
 java.util.Map getAppContext()
          Get the application context
 java.lang.Object getConfigVariableValue(java.lang.String varName)
          Deprecated. 2.1
 java.lang.Object getGlobalVariable(java.lang.String name)
          Retireve an object from runtime scope.
 java.lang.Object getHttpServletRequest()
          Get the http servlet request object
 java.util.Locale getLocale()
           
 java.lang.String getMessage(java.lang.String key)
          Finds user-defined messages for the current thread's locale.
 java.lang.String getMessage(java.lang.String key, java.util.Locale locale)
          Finds user-defined messages for the given locale.
 java.lang.String getMessage(java.lang.String key, java.util.Locale locale, java.lang.Object[] params)
          Finds user-defined messages for the given locale using parameters
 java.lang.String getMessage(java.lang.String key, java.lang.Object[] params)
          Finds user-defined messages for the current thread's locale
 java.lang.String getOutputFormat()
           
 java.lang.String getParameterDisplayText(java.lang.String name)
           
 java.lang.Object getParameterValue(java.lang.String name)
           
 java.lang.Object getPersistentGlobalVariable(java.lang.String name)
          Retireve an object from report document scope.
 org.eclipse.birt.report.engine.api.IReportRunnable getReportRunnable()
          return the report runnable used to create/render this report
 void setGlobalVariable(java.lang.String name, java.lang.Object obj)
          Add the object to runtime scope.
 void setParameterDisplayText(java.lang.String name, java.lang.String value)
           
 void setParameterValue(java.lang.String name, java.lang.Object value)
           
 void setPersistentGlobalVariable(java.lang.String name, java.io.Serializable obj)
          Add the object to report document scope.
 

Method Detail

getReportRunnable

public org.eclipse.birt.report.engine.api.IReportRunnable getReportRunnable()
return the report runnable used to create/render this report

Returns:

getParameterValue

public java.lang.Object getParameterValue(java.lang.String name)
Parameters:
name -
Returns:

setParameterValue

public void setParameterValue(java.lang.String name,
                              java.lang.Object value)
Parameters:
name -
value -

getParameterDisplayText

public java.lang.String getParameterDisplayText(java.lang.String name)
Parameters:
name -
Returns:

setParameterDisplayText

public void setParameterDisplayText(java.lang.String name,
                                    java.lang.String value)
Parameters:
name -
value -

getConfigVariableValue

public java.lang.Object getConfigVariableValue(java.lang.String varName)
Deprecated. 2.1

always return NULL as 125963

Parameters:
varName -
Returns:

getLocale

public java.util.Locale getLocale()
Returns:

getOutputFormat

public java.lang.String getOutputFormat()
Returns:

getAppContext

public java.util.Map getAppContext()
Get the application context


getHttpServletRequest

public java.lang.Object getHttpServletRequest()
Get the http servlet request object


setGlobalVariable

public void setGlobalVariable(java.lang.String name,
                              java.lang.Object obj)
Add the object to runtime scope. This object can only be retrieved in the same phase, i.e. it is not persisted between generation and presentation.


deleteGlobalVariable

public void deleteGlobalVariable(java.lang.String name)
Remove an object from runtime scope.


getGlobalVariable

public java.lang.Object getGlobalVariable(java.lang.String name)
Retireve an object from runtime scope.


setPersistentGlobalVariable

public void setPersistentGlobalVariable(java.lang.String name,
                                        java.io.Serializable obj)
Add the object to report document scope. This object can be retrieved later. It is persisted between phases, i.e. between generation and presentation.


deletePersistentGlobalVariable

public void deletePersistentGlobalVariable(java.lang.String name)
Remove an object from report document scope.


getPersistentGlobalVariable

public java.lang.Object getPersistentGlobalVariable(java.lang.String name)
Retireve an object from report document scope.


getMessage

public java.lang.String getMessage(java.lang.String key)
Finds user-defined messages for the current thread's locale.


getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.util.Locale locale)
Finds user-defined messages for the given locale.


getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object[] params)
Finds user-defined messages for the current thread's locale


getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.util.Locale locale,
                                   java.lang.Object[] params)
Finds user-defined messages for the given locale using parameters



Copyright © 2005 Actuate Corp. All rights reserved.