Skip navigation links


com.essbase.eas.essbase.server
Class ReportScriptPrimitives

java.lang.Object
  extended by com.essbase.eas.essbase.server.ReportScriptPrimitives


public final class ReportScriptPrimitives
extends java.lang.Object

This class provides the primitive operations for an Essbase Report Script. In the current implementation, no instances of this class should ever be instantiated. The current version of this class only moves the report script to and from Essbase.

Methods that need to be implemented

  1. many methods
Version:
1.00, 08/13/2000
Author:
Brian Litofsky
See Also:
EssSession, EssSessionMessage

Nested Class Summary
static class ReportScriptPrimitives.ReportFile
           

 

Method Summary
static boolean copy(EssSession destSession, java.lang.String destApp, java.lang.String destDatabase, java.lang.String destReport, java.lang.String srcApp, java.lang.String srcDatabase, java.lang.String srcReport)
          copies a report within an individual server.
static boolean delete(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String objName)
          deletes a Report Script rule
static int execute(ContextHandle context, java.lang.String appName, java.lang.String dbName, java.lang.String reportScript)
          executes a report script as a string using EssReport
static int executeFile(ContextHandle context, java.lang.String appName, java.lang.String dbName, java.lang.String reportName)
          executes a report script.
static boolean get(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean lock)
          gets a report script
static java.util.List getList(EssSession session, java.lang.String application, java.lang.String database)
          Creates a list of report scripts that belong to a specific server.
static int getReport(ContextHandle context, java.lang.String appName, java.lang.String dbName, java.lang.String filename, UnicodeInfo unicode)
          retrieves report output from an executed report
static int lock(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String reportName)
          locks a report script.
static boolean put(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean lock)
          puts a report script
static boolean rename(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String newReportName, java.lang.String oldReportName)
          renames a report script.
static boolean unlock(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String reportName)
          unlocks a report script.
static int verify(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String reportScript)
          verifies a report script as a string using EssReport
static int verifyFile(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String reportName)
          verifies a report script.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Method Detail

getList

public static java.util.List getList(EssSession session,
                                     java.lang.String application,
                                     java.lang.String database)
Creates a list of report scripts that belong to a specific server. Creates the list for a specific application and database.
Parameters:
session - object for this Essbase session.
application - to restrict request within.
database - to restrict request within
Returns:
a list collection containing strings with the report script names.

get

public static boolean get(EssSession session,
                          java.lang.String appName,
                          java.lang.String dbName,
                          java.lang.String objName,
                          java.lang.String localName,
                          boolean lock)
gets a report script
Parameters:
session - - session object for this command.
appName - - name of application.
dbName - - name of database.
objName - - name of the object.
localName - - name of the file to create
Returns:
true if the delete succeeds. What do we do about messages if the call fails?

put

public static boolean put(EssSession session,
                          java.lang.String appName,
                          java.lang.String dbName,
                          java.lang.String objName,
                          java.lang.String localName,
                          boolean lock)
puts a report script
Parameters:
session - - session object for this command.
appName - - name of application.
dbName - - name of database.
objName - - name of the object.
Returns:
true if the delete succeeds. What do we do about messages if the call fails?

delete

public static boolean delete(EssSession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String objName)
deletes a Report Script rule
Parameters:
session - - session object for this command.
appName - - name of application.
dbName - - name of database.
objName - - name of the object.
Returns:
true if the delete succeeds. What do we do about messages if the call fails?

lock

public static int lock(EssSession session,
                       java.lang.String appName,
                       java.lang.String dbName,
                       java.lang.String reportName)
locks a report script.
Parameters:
session - - session object for this command.
appName - - name of application containing the script.
dbName - - name of database containing the script.
reportName - - name of the report script.
Returns:
true if the lock succeeds.

unlock

public static boolean unlock(EssSession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String reportName)
unlocks a report script.
Parameters:
session - - session object for this command.
appName - - name of application containing the script.
dbName - - name of database containing the script.
reportName - - name of the report script.
Returns:
true if the lock succeeds.

verify

public static int verify(EssSession session,
                         java.lang.String appName,
                         java.lang.String dbName,
                         java.lang.String reportScript)
verifies a report script as a string using EssReport
Parameters:
session - - session object for this command.
reportScript - - report script stirng (should not exceed 64K).
Returns:
true if the verify succeeds.

verifyFile

public static int verifyFile(EssSession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String reportName)
verifies a report script.
Parameters:
session - - session object for this command.
appName - - name of application containing the script.
dbName - - name of database containing the script.
reportName - - name of the report script.
Returns:
true if the verify succeeds.

copy

public static boolean copy(EssSession destSession,
                           java.lang.String destApp,
                           java.lang.String destDatabase,
                           java.lang.String destReport,
                           java.lang.String srcApp,
                           java.lang.String srcDatabase,
                           java.lang.String srcReport)
copies a report within an individual server.

Should we throw an exception here?

Parameters:
session - - session object server.
destApp - - application name for the copy.
destDatabase - - database name for the copy.
destReport - - Report name for the copy.
srcApp - - application to be copied.
srcDatabase - - database to be copied.
srcReport - - Report name to be copied.
Returns:
true if the database is successfully copied. What do we do about messages if the call fails?

rename

public static boolean rename(EssSession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String newReportName,
                             java.lang.String oldReportName)
renames a report script.
Parameters:
session - - session object for this command.
appName - - name of application containing the script.
dbName - - name of database containing the script.
newReportName - - name of the new report script.
oldReportName - - name of the old report script.
Returns:
true if the rename succeeds.

execute

public static int execute(ContextHandle context,
                          java.lang.String appName,
                          java.lang.String dbName,
                          java.lang.String reportScript)
executes a report script as a string using EssReport
Parameters:
session - - session object for this command.
reportScript - - report script stirng (should not exceed 64K).
Returns:
0 if execute succeeds.

executeFile

public static int executeFile(ContextHandle context,
                              java.lang.String appName,
                              java.lang.String dbName,
                              java.lang.String reportName)
executes a report script.
Parameters:
session - - session object for this command.
appName - - name of application containing the script.
dbName - - name of database containing the script.
reportName - - name of the report script.
Returns:
0 if execute succeeds.

getReport

public static int getReport(ContextHandle context,
                            java.lang.String appName,
                            java.lang.String dbName,
                            java.lang.String filename,
                            UnicodeInfo unicode)
retrieves report output from an executed report
Parameters:
session - - session object for this command.
appName - - name of application containing the script.
dbName - - name of database containing the script.
Returns:
report as a String or null on failure

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.