Skip navigation links

com.essbase.eas.essbase.server
Class ReportScriptLogic

java.lang.Object
com.essbase.eas.essbase.server.ReportScriptLogic

public class ReportScriptLogic

extends java.lang.Object

Constructor Summary

ReportScriptLogic()

Method Summary

boolean	copy(EssSession destSession, java.lang.String destApp, java.lang.String destDb, java.lang.String destReport, EssSession srcSession, java.lang.String srcApp, java.lang.String srcDb, java.lang.String srcReport) Currenly only cross server copy is enabled
boolean	delete(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String objName) deletes a Report Script file
java.io.File	execute(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String report, java.util.ArrayList errors)
void	executeFAF(java.lang.String processID, EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String report) Executes report script in Fire and Forget mode
java.io.File	executeFile(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String reportName, java.util.ArrayList errors)
void	executeFileFAF(java.lang.String processID, EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String reportName) Executes report file in Fire and Forget mode
java.lang.String	get(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String reptName, boolean lock, EssbaseString essbaseString, java.lang.String locale)
java.lang.String	getEASUser()
java.util.List	getList(EssSession session, java.lang.String appName, java.lang.String dbName)
void	isReportFileShared(boolean share)
int	lock(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String reportName)
boolean	put(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean lock)
boolean	rename(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String newReportName, java.lang.String oldReportName)
void	setEASUser(java.lang.String user)
void	setEmailBcc(java.lang.String bcc)
void	setEmailCC(java.lang.String cc)
void	setEmailReport(boolean email)
void	setEmailSubject(java.lang.String sub)
void	setEmailText(java.lang.String text)
void	setEmailTo(java.lang.String to)
void	setFromEmail(java.lang.String from)
void	setFromName(java.lang.String name)
void	setPrintReport(boolean print)
void	setReportFileName(java.lang.String name)
void	setSmtpHost(java.lang.String host)
boolean	unlock(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String scriptName)
int	verify(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String scriptStr)
int	verifyFile(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String scriptName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportScriptLogic

public ReportScriptLogic()

Method Detail

getList

public java.util.List getList(EssSession session,
                              java.lang.String appName,
                              java.lang.String dbName)

delete

public boolean delete(EssSession session,
                      java.lang.String appName,
                      java.lang.String dbName,
                      java.lang.String objName)

deletes a Report Script file

Parameters:

session - - session object for this command.

appName - - name of application containing the report to be deleted.

dbName - - name of database containing the report to be deleted.

objName - - name of the Report Script file to delete

Returns:

true if the delete succeeds. What do we do about messages if the call fails?

copy

public boolean copy(EssSession destSession,
                    java.lang.String destApp,
                    java.lang.String destDb,
                    java.lang.String destReport,
                    EssSession srcSession,
                    java.lang.String srcApp,
                    java.lang.String srcDb,
                    java.lang.String srcReport)

Currenly only cross server copy is enabled

get

public java.lang.String get(EssSession session,
                            java.lang.String appName,
                            java.lang.String dbName,
                            java.lang.String reptName,
                            boolean lock,
                            EssbaseString essbaseString,
                            java.lang.String locale)

lock

public int lock(EssSession session,
                java.lang.String appName,
                java.lang.String dbName,
                java.lang.String reportName)

put

public boolean put(EssSession session,
                   java.lang.String appName,
                   java.lang.String dbName,
                   java.lang.String objName,
                   java.lang.String localName,
                   boolean lock)

verifyFile

public int verifyFile(EssSession session,
                      java.lang.String appName,
                      java.lang.String dbName,
                      java.lang.String scriptName)

verify

public int verify(EssSession session,
                  java.lang.String appName,
                  java.lang.String dbName,
                  java.lang.String scriptStr)

unlock

public boolean unlock(EssSession session,
                      java.lang.String appName,
                      java.lang.String dbName,
                      java.lang.String scriptName)

rename

public boolean rename(EssSession session,
                      java.lang.String appName,
                      java.lang.String dbName,
                      java.lang.String newReportName,
                      java.lang.String oldReportName)

execute

public java.io.File execute(EssSession session,
                            java.lang.String appName,
                            java.lang.String dbName,
                            java.lang.String report,
                            java.util.ArrayList errors)

executeFile

public java.io.File executeFile(EssSession session,
                                java.lang.String appName,
                                java.lang.String dbName,
                                java.lang.String reportName,
                                java.util.ArrayList errors)

executeFAF

public void executeFAF(java.lang.String processID,
                       EssSession session,
                       java.lang.String appName,
                       java.lang.String dbName,
                       java.lang.String report)
                throws java.lang.Exception

Executes report script in Fire and Forget mode

Throws:

java.lang.Exception

executeFileFAF

public void executeFileFAF(java.lang.String processID,
                           EssSession session,
                           java.lang.String appName,
                           java.lang.String dbName,
                           java.lang.String reportName)
                    throws java.lang.Exception

Executes report file in Fire and Forget mode

Throws:

java.lang.Exception

setReportFileName

public void setReportFileName(java.lang.String name)

isReportFileShared

public void isReportFileShared(boolean share)

setPrintReport

public void setPrintReport(boolean print)

setEmailReport

public void setEmailReport(boolean email)

setEmailTo

public void setEmailTo(java.lang.String to)

setEmailCC

public void setEmailCC(java.lang.String cc)

setEmailBcc

public void setEmailBcc(java.lang.String bcc)

setEmailSubject

public void setEmailSubject(java.lang.String sub)

setEmailText

public void setEmailText(java.lang.String text)

setFromEmail

public void setFromEmail(java.lang.String from)

setFromName

public void setFromName(java.lang.String name)

setSmtpHost

public void setSmtpHost(java.lang.String host)

setEASUser

public void setEASUser(java.lang.String user)

getEASUser

public java.lang.String getEASUser()

Skip navigation links