|
Oracle Reports Java API Reference 11g Release 1 (11.1.1) E10775-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.reports.plugin.definition.ReportContext
public class ReportContext
Reports context object. The context object provides environment information such Reports path, locale, and etc.
Field Summary | |
---|---|
protected oracle.reports.definition.RWReport |
mRWObj
|
protected Trace |
mTrace
|
Constructor Summary | |
---|---|
ReportContext(oracle.reports.definition.RWReport rwobj,
Trace trace)
Constructor NOTE: Plugin must never try to create any Reports objects by itself. |
Method Summary | |
---|---|
java.lang.String |
findFileInReportsPath(java.lang.String filename)
Search for file named in paths specified by REPORTS_PATH environment variable If no such file is found, return null. |
java.lang.String |
getCacheDirectory()
Returns cache directory |
java.util.Hashtable |
getCommandLineArguments()
Returns the command line arguments |
java.lang.String |
getConfigDirectory()
Returns config directory |
java.lang.String[] |
getDomains()
|
java.lang.String |
getDTDDirectory()
Returns DTD directory |
java.util.Locale |
getLocale()
|
java.lang.String |
getOracleHome()
Returns ORACLE_HOME directory |
java.lang.String |
getPluginParam(java.lang.String name)
Get the named plugin param from the server config file |
java.lang.String[] |
getProxyInfo()
|
java.lang.String |
getReportsDirectory()
Returns the Reports directory |
java.lang.String |
getServerDirectory()
Returns server directory |
java.lang.String |
getTemplateDirectory()
Returns template directory |
java.lang.String |
getTemporaryDirectory()
Returns Reports temporary directory as defined by REPORTS_TMP environment variable |
java.lang.String |
getTemporaryFile(java.lang.String basename)
Returns a unique temporary file in Reports temporary directory defined by REPORTS_TMP environment variable This method only returns a unique filename for you, no file is created. |
Trace |
getTrace()
Returns trace object |
java.lang.String |
getVersion()
Returns Reports version |
boolean |
isInsideReportsBuilder()
Returns true if current context is running inside Reports Builder. |
boolean |
isUIAllowedNow()
Returns true if Plugin is allowed to raise its UI (say, connect dialog) at this moment. |
void |
showHelpContent(java.lang.String helpSetID)
Displays the help content helpSetID is the id set by Iplugin.setHelpSetID() |
void |
showHelpTopic(java.lang.String helpSetID,
java.lang.String topicID)
Displays the help topic If no such topic is found, a generic "Help not found" topic is displayed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected oracle.reports.definition.RWReport mRWObj
protected Trace mTrace
Constructor Detail |
---|
public ReportContext(oracle.reports.definition.RWReport rwobj, Trace trace) throws PluginException
PluginException
Method Detail |
---|
public boolean isInsideReportsBuilder() throws PluginException
PluginException
public boolean isUIAllowedNow() throws PluginException
PluginException
public Trace getTrace() throws PluginException
PluginException
public java.lang.String findFileInReportsPath(java.lang.String filename) throws PluginException
PluginException
public java.util.Locale getLocale() throws PluginException
PluginException
public java.lang.String[] getProxyInfo()
public java.lang.String[] getDomains()
public java.lang.String getPluginParam(java.lang.String name) throws PluginException
PluginException
public void showHelpContent(java.lang.String helpSetID) throws PluginException
PluginException
public void showHelpTopic(java.lang.String helpSetID, java.lang.String topicID) throws PluginException
PluginException
public java.util.Hashtable getCommandLineArguments() throws PluginException
PluginException
public java.lang.String getReportsDirectory() throws PluginException
PluginException
public java.lang.String getConfigDirectory() throws PluginException
PluginException
public java.lang.String getCacheDirectory() throws PluginException
PluginException
public java.lang.String getDTDDirectory() throws PluginException
PluginException
public java.lang.String getOracleHome() throws PluginException
PluginException
public java.lang.String getServerDirectory() throws PluginException
PluginException
public java.lang.String getTemplateDirectory() throws PluginException
PluginException
public java.lang.String getTemporaryDirectory() throws PluginException
PluginException
public java.lang.String getTemporaryFile(java.lang.String basename) throws PluginException
PluginException
public java.lang.String getVersion() throws PluginException
PluginException
|
Oracle Reports Java API Reference |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |