Skip navigation links


com.essbase.eas.essbase.defs
Interface Application

All Known Implementing Classes:
DefaultApplication, FactoryApplication

public interface Application

Defines a generic interface for Essbase applications. This interface should be useable in both server and client side applications.

Version:
1.00, 09/13/2000
Author:
Hank Cox
See Also:
DefaultApplication

Method Summary
 void addAliasTableFileObject(DefaultAliasTableFileObject value)
          adds an alias table file object to this application's collection.
 void addApplicationListener(ApplicationListener l)
          adds a listener for events on an application.
 void addCalcScript(DefaultCalcScript value)
          adds a calc script to this application's collection.
 void addDatabase(Database value)
          adds an database to this application's collection.
 void addDatabases(Database[] value)
           
 void addExcelFileObject(DefaultExcelFileObject value)
          adds a excel file object to this application's collection.
 void addFunction(Function value)
          adds a Function to this app's collection.
 void addLotusFileObject(DefaultLotusFileObject value)
          adds a lotus file object to this application's collection.
 void addMacro(Macro value)
          adds a Macro to this app's collection.
 void addOutlineFileObject(DefaultOutlineFileObject value)
          adds an alias outline object to this application's collection.
 void addReportScript(DefaultReportScript value)
          adds a report script to this application's collection.
 void addRulesObject(DefaultRulesObject value)
          adds a rules object to this application's collection.
 void addTextFileObject(DefaultTextFileObject value)
          adds a text file object to this application's collection.
 void addVariable(Variable value)
          adds a Variable to this app's collection.
 void databaseRenamed(java.lang.String oldname, java.lang.String newname, java.lang.Object database)
           
 DefaultAliasTableFileObject getAliasTableFileObject(java.lang.String value)
          gets a specific alias table file object from this application's collection.
 DefaultAliasTableFileObject[] getAliasTableFileObjects()
          retrieves this application's collection of alias table file objects.
 short getAppFrontEndType()
           
 short getAppType()
          returns the type associated with this application.
 DefaultCalcScript getCalcScript(java.lang.String scriptName)
           
 DefaultCalcScript[] getCalcScripts()
          retrieves this application's collection of calc scripts.
 Database getDatabase(java.lang.String value)
          retrieves a specific database.
 Database[] getDatabases()
          retrieves this application's collection of databases.
 DefaultExcelFileObject getExcelFileObject(java.lang.String value)
           
 DefaultExcelFileObject[] getExcelFileObjects()
          retrieves this application's collection of excel file objects.
 Function getFunction(java.lang.String name)
          Returns the Function associated with the name from the collection of functions
 Function[] getFunctions()
          retrieves this application's collection of functions.
 Database[] getLoadedDatabases()
          retrieves this application's currently loaded of databases.
 DefaultLotusFileObject getLotusFileObject(java.lang.String value, short version)
           
 DefaultLotusFileObject[] getLotusFileObjects(short version)
          retrieves this application's collection of lotus file objects.
 Macro getMacro(java.lang.String name)
          Returns the Macro associated with the name from the collection of macros
 Macro[] getMacros()
          retrieves this application's collection of macros.
 java.lang.String getName()
          returns the name associated with this application.
 DefaultOutlineFileObject getOutlineFileObject(java.lang.String value)
          gets a specific outline file object from this application's collection.
 DefaultOutlineFileObject[] getOutlineFileObjects()
          retrieves this application's collection of outline file objects.
 ApplicationProperties getProperties()
          gets the properties object for this application object
 DefaultReportScript getReportScript(java.lang.String scriptName)
           
 DefaultReportScript[] getReportScripts()
          retrieves this application's collection of report scripts.
 DefaultRulesObject getRulesObject(java.lang.String scriptName)
           
 DefaultRulesObject[] getRulesObjects()
          retrieves this application's collection of rules objects.
 Server getServer()
          get the server that this application object is contained in.
 DefaultTextFileObject getTextFileObject(java.lang.String value)
           
 DefaultTextFileObject[] getTextFileObjects()
          retrieves this application's collection of text file objects.
 boolean getUnicode()
          returns whether the application is Unicode application
 Variable getVariable(java.lang.String name)
          Returns the Variable associated with the name from the collection of variables
 Variable[] getVariables()
          retrieves this application's collection of variables.
 boolean isASO()
          returns whether the application's storage is ASO
 boolean isStarted()
           
 boolean isUnicode()
          returns whether the application is Unicode application
 void removeAliasTableFileObject(DefaultAliasTableFileObject value)
          removes an alias table file object from this application's collection of alias table file objects.
 void removeAliasTableFileObject(java.lang.String value)
          removes an alias table file object from this server's collection of alias table file objects.
 void removeAliasTableFileObjectsNotIn(java.lang.String[] values)
          removes alias table file objects from the applications collection that aren't contained in this collection of names.
 void removeAllDatabases()
          removes all databases from this application's collection of databases.
 void removeApplicationListener(ApplicationListener l)
          removes an event listener from an application
 void removeCalcScript(DefaultCalcScript value)
          removes a calc script from this application's collection of calc scripts.
 void removeCalcScript(java.lang.String value)
          removes a calc script from this server's collection of calc scripts.
 void removeCalcScriptsNotIn(java.lang.String[] values)
          removes calc scripts from the applications collection that aren't contained in this collection of names.
 void removeDatabase(Database value)
          removes a database from this application's collection of databases.
 void removeDatabase(java.lang.String value)
          removes a database from this server's collection of databases.
 void removeExcelFileObject(DefaultExcelFileObject value)
          removes a excel file object from this application's collection of excel file objects.
 void removeExcelFileObject(java.lang.String value)
          removes a excel file object from this server's collection of excel file objects.
 void removeExcelFileObjectsNotIn(java.lang.String[] values)
          removes excel file objects from the applications collection that aren't contained in this collection of names.
 void removeFunction(Function value)
          removes a Function from this app's collection of functions.
 void removeLotusFileObject(DefaultLotusFileObject value)
          removes a lotus file object from this application's collection of lotus file objects.
 void removeLotusFileObject(java.lang.String value, short version)
          removes a lotus file object from this server's collection of lotus file objects.
 void removeLotusFileObjectsNotIn(java.lang.String[] values, short version)
          removes lotus file objects from the applications collection that aren't contained in this collection of names.
 void removeMacro(Macro value)
          removes a Macro from this app's collection of Macros.
 void removeOutlineFileObject(DefaultOutlineFileObject value)
          removes an outline file object from this application's collection of outline file objects.
 void removeOutlineFileObject(java.lang.String value)
          removes an outline file object from this server's collection of outline file objects.
 void removeOutlineFileObjectsNotIn(java.lang.String[] values)
          removes outline file objects from the applications collection that aren't contained in this collection of names.
 void removeReportScript(DefaultReportScript value)
          removes a report script from this application's collection of report scripts.
 void removeReportScript(java.lang.String value)
          removes a report script from this server's collection of report scripts.
 void removeReportScriptsNotIn(java.lang.String[] values)
          removes report scripts from the applications collection that aren't contained in this collection of names.
 void removeRulesObject(DefaultRulesObject value)
          removes a rules object from this application's collection of rules objects.
 void removeRulesObject(java.lang.String value)
          removes a rules object from this server's collection of rules objects.
 void removeRulesObjectsNotIn(java.lang.String[] values)
          removes rules objects from the applications collection that aren't contained in this collection of names.
 void removeTextFileObject(DefaultTextFileObject value)
          removes a text file object from this application's collection of text file objects.
 void removeTextFileObject(java.lang.String value)
          removes a text file object from this server's collection of text file objects.
 void removeTextFileObjectsNotIn(java.lang.String[] values)
          removes text file objects from the applications collection that aren't contained in this collection of names.
 void removeVariable(Variable value)
          removes a Variable from this app's collection of Variables.
 void setAppFrontEndType(short value)
           
 void setAppType(short value)
          sets the type associated with this application.
 void setDatabasesLoaded(boolean loaded)
           
 void setName(java.lang.String value)
          sets the name associated with this application.
 void setProperties(ApplicationProperties appProps)
          sets the properties object for this application object
 void setServer(Server value)
          set the server that this application object is contained in.
 void setStarted(boolean started)
           
 void setUnicode(boolean b)
          sets application mode

 

Method Detail

getServer

Server getServer()
get the server that this application object is contained in.

setServer

void setServer(Server value)
set the server that this application object is contained in.

getName

java.lang.String getName()
returns the name associated with this application.

setName

void setName(java.lang.String value)
sets the name associated with this application.

getAppType

short getAppType()
returns the type associated with this application.

getAppFrontEndType

short getAppFrontEndType()

isStarted

boolean isStarted()
Returns:
true if the app is started

setStarted

void setStarted(boolean started)

setAppType

void setAppType(short value)
sets the type associated with this application.

setAppFrontEndType

void setAppFrontEndType(short value)

addDatabase

void addDatabase(Database value)
                 throws DuplicateDatabaseException
adds an database to this application's collection.
Throws:
DuplicateDatabaseException

addDatabases

void addDatabases(Database[] value)

databaseRenamed

void databaseRenamed(java.lang.String oldname,
                     java.lang.String newname,
                     java.lang.Object database)

addMacro

void addMacro(Macro value)
              throws DuplicateMacroException
adds a Macro to this app's collection.
Throws:
DuplicateMacroException

addFunction

void addFunction(Function value)
                 throws DuplicateFunctionException
adds a Function to this app's collection.
Throws:
DuplicateFunctionException

addVariable

void addVariable(Variable value)
                 throws DuplicateVariableException
adds a Variable to this app's collection.
Throws:
DuplicateVariableException

getLoadedDatabases

Database[] getLoadedDatabases()
retrieves this application's currently loaded of databases.

getDatabases

Database[] getDatabases()
retrieves this application's collection of databases.

getMacros

Macro[] getMacros()
retrieves this application's collection of macros.

getVariables

Variable[] getVariables()
retrieves this application's collection of variables.

getFunctions

Function[] getFunctions()
retrieves this application's collection of functions.

getDatabase

Database getDatabase(java.lang.String value)
retrieves a specific database.

removeAllDatabases

void removeAllDatabases()
                        throws MissingDatabaseException
removes all databases from this application's collection of databases.
Throws:
MissingDatabaseException

removeDatabase

void removeDatabase(Database value)
                    throws MissingDatabaseException
removes a database from this application's collection of databases.
Throws:
MissingDatabaseException

removeDatabase

void removeDatabase(java.lang.String value)
                    throws MissingDatabaseException
removes a database from this server's collection of databases.
Throws:
MissingDatabaseException

addCalcScript

void addCalcScript(DefaultCalcScript value)
                   throws DuplicateCalcScriptException
adds a calc script to this application's collection.
Throws:
DuplicateCalcScriptException

getCalcScripts

DefaultCalcScript[] getCalcScripts()
retrieves this application's collection of calc scripts.

getCalcScript

DefaultCalcScript getCalcScript(java.lang.String scriptName)

removeCalcScript

void removeCalcScript(DefaultCalcScript value)
                      throws MissingCalcScriptException
removes a calc script from this application's collection of calc scripts.
Throws:
MissingCalcScriptException

removeCalcScript

void removeCalcScript(java.lang.String value)
                      throws MissingCalcScriptException
removes a calc script from this server's collection of calc scripts.
Throws:
MissingCalcScriptException

removeCalcScriptsNotIn

void removeCalcScriptsNotIn(java.lang.String[] values)
removes calc scripts from the applications collection that aren't contained in this collection of names.

addApplicationListener

void addApplicationListener(ApplicationListener l)
adds a listener for events on an application.

removeApplicationListener

void removeApplicationListener(ApplicationListener l)
removes an event listener from an application

getProperties

ApplicationProperties getProperties()
gets the properties object for this application object

setProperties

void setProperties(ApplicationProperties appProps)
sets the properties object for this application object

addReportScript

void addReportScript(DefaultReportScript value)
                     throws DuplicateReportScriptException
adds a report script to this application's collection.
Throws:
DuplicateReportScriptException

getReportScript

DefaultReportScript getReportScript(java.lang.String scriptName)

getReportScripts

DefaultReportScript[] getReportScripts()
retrieves this application's collection of report scripts.

removeReportScript

void removeReportScript(DefaultReportScript value)
                        throws MissingReportScriptException
removes a report script from this application's collection of report scripts.
Throws:
MissingReportScriptException

removeReportScript

void removeReportScript(java.lang.String value)
                        throws MissingReportScriptException
removes a report script from this server's collection of report scripts.
Throws:
MissingReportScriptException

removeReportScriptsNotIn

void removeReportScriptsNotIn(java.lang.String[] values)
removes report scripts from the applications collection that aren't contained in this collection of names.

addRulesObject

void addRulesObject(DefaultRulesObject value)
                    throws DuplicateRulesObjectException
adds a rules object to this application's collection.
Throws:
DuplicateRulesObjectException

getRulesObject

DefaultRulesObject getRulesObject(java.lang.String scriptName)

getRulesObjects

DefaultRulesObject[] getRulesObjects()
retrieves this application's collection of rules objects.

removeRulesObject

void removeRulesObject(DefaultRulesObject value)
                       throws MissingRulesObjectException
removes a rules object from this application's collection of rules objects.
Throws:
MissingRulesObjectException

removeRulesObject

void removeRulesObject(java.lang.String value)
                       throws MissingRulesObjectException
removes a rules object from this server's collection of rules objects.
Throws:
MissingRulesObjectException

removeRulesObjectsNotIn

void removeRulesObjectsNotIn(java.lang.String[] values)
removes rules objects from the applications collection that aren't contained in this collection of names.

removeMacro

void removeMacro(Macro value)
                 throws MissingMacroException
removes a Macro from this app's collection of Macros.
Throws:
MissingMacroException

removeVariable

void removeVariable(Variable value)
                    throws MissingVariableException
removes a Variable from this app's collection of Variables.
Throws:
MissingVariableException

removeFunction

void removeFunction(Function value)
                    throws MissingFunctionException
removes a Function from this app's collection of functions.
Throws:
MissingFunctionException

getMacro

Macro getMacro(java.lang.String name)
Returns the Macro associated with the name from the collection of macros

getFunction

Function getFunction(java.lang.String name)
Returns the Function associated with the name from the collection of functions

getVariable

Variable getVariable(java.lang.String name)
Returns the Variable associated with the name from the collection of variables

addTextFileObject

void addTextFileObject(DefaultTextFileObject value)
                       throws DuplicateTextFileObjectException
adds a text file object to this application's collection.
Throws:
DuplicateTextFileObjectException

getTextFileObject

DefaultTextFileObject getTextFileObject(java.lang.String value)

getTextFileObjects

DefaultTextFileObject[] getTextFileObjects()
retrieves this application's collection of text file objects.

removeTextFileObject

void removeTextFileObject(DefaultTextFileObject value)
                          throws MissingTextFileObjectException
removes a text file object from this application's collection of text file objects.
Throws:
MissingTextFileObjectException

removeTextFileObject

void removeTextFileObject(java.lang.String value)
                          throws MissingRulesObjectException
removes a text file object from this server's collection of text file objects.
Throws:
MissingRulesObjectException

removeTextFileObjectsNotIn

void removeTextFileObjectsNotIn(java.lang.String[] values)
removes text file objects from the applications collection that aren't contained in this collection of names.

getLotusFileObject

DefaultLotusFileObject getLotusFileObject(java.lang.String value,
                                          short version)

addLotusFileObject

void addLotusFileObject(DefaultLotusFileObject value)
                        throws DuplicateLotusFileObjectException
adds a lotus file object to this application's collection.
Throws:
DuplicateLotusFileObjectException

getLotusFileObjects

DefaultLotusFileObject[] getLotusFileObjects(short version)
retrieves this application's collection of lotus file objects.

removeLotusFileObject

void removeLotusFileObject(DefaultLotusFileObject value)
                           throws MissingLotusFileObjectException
removes a lotus file object from this application's collection of lotus file objects.
Throws:
MissingLotusFileObjectException

removeLotusFileObject

void removeLotusFileObject(java.lang.String value,
                           short version)
                           throws MissingRulesObjectException
removes a lotus file object from this server's collection of lotus file objects.
Throws:
MissingRulesObjectException

removeLotusFileObjectsNotIn

void removeLotusFileObjectsNotIn(java.lang.String[] values,
                                 short version)
removes lotus file objects from the applications collection that aren't contained in this collection of names.

getExcelFileObject

DefaultExcelFileObject getExcelFileObject(java.lang.String value)

addExcelFileObject

void addExcelFileObject(DefaultExcelFileObject value)
                        throws DuplicateExcelFileObjectException
adds a excel file object to this application's collection.
Throws:
DuplicateExcelFileObjectException

getExcelFileObjects

DefaultExcelFileObject[] getExcelFileObjects()
retrieves this application's collection of excel file objects.

removeExcelFileObject

void removeExcelFileObject(DefaultExcelFileObject value)
                           throws MissingExcelFileObjectException
removes a excel file object from this application's collection of excel file objects.
Throws:
MissingExcelFileObjectException

removeExcelFileObject

void removeExcelFileObject(java.lang.String value)
                           throws MissingExcelFileObjectException
removes a excel file object from this server's collection of excel file objects.
Throws:
MissingExcelFileObjectException

removeExcelFileObjectsNotIn

void removeExcelFileObjectsNotIn(java.lang.String[] values)
removes excel file objects from the applications collection that aren't contained in this collection of names.

getAliasTableFileObject

DefaultAliasTableFileObject getAliasTableFileObject(java.lang.String value)
gets a specific alias table file object from this application's collection.

addAliasTableFileObject

void addAliasTableFileObject(DefaultAliasTableFileObject value)
                             throws DuplicateAliasTableFileObjectException
adds an alias table file object to this application's collection.
Throws:
DuplicateAliasTableFileObjectException

getAliasTableFileObjects

DefaultAliasTableFileObject[] getAliasTableFileObjects()
retrieves this application's collection of alias table file objects.

removeAliasTableFileObject

void removeAliasTableFileObject(DefaultAliasTableFileObject value)
                                throws MissingAliasTableFileObjectException
removes an alias table file object from this application's collection of alias table file objects.
Throws:
MissingAliasTableFileObjectException

removeAliasTableFileObject

void removeAliasTableFileObject(java.lang.String value)
                                throws MissingAliasTableFileObjectException
removes an alias table file object from this server's collection of alias table file objects.
Throws:
MissingAliasTableFileObjectException

removeAliasTableFileObjectsNotIn

void removeAliasTableFileObjectsNotIn(java.lang.String[] values)
removes alias table file objects from the applications collection that aren't contained in this collection of names.

getOutlineFileObject

DefaultOutlineFileObject getOutlineFileObject(java.lang.String value)
gets a specific outline file object from this application's collection.

addOutlineFileObject

void addOutlineFileObject(DefaultOutlineFileObject value)
                          throws DuplicateOutlineFileObjectException
adds an alias outline object to this application's collection.
Throws:
DuplicateOutlineFileObjectException

getOutlineFileObjects

DefaultOutlineFileObject[] getOutlineFileObjects()
retrieves this application's collection of outline file objects.

removeOutlineFileObject

void removeOutlineFileObject(DefaultOutlineFileObject value)
                             throws MissingOutlineFileObjectException
removes an outline file object from this application's collection of outline file objects.
Throws:
MissingOutlineFileObjectException

removeOutlineFileObject

void removeOutlineFileObject(java.lang.String value)
                             throws MissingOutlineFileObjectException
removes an outline file object from this server's collection of outline file objects.
Throws:
MissingOutlineFileObjectException

removeOutlineFileObjectsNotIn

void removeOutlineFileObjectsNotIn(java.lang.String[] values)
removes outline file objects from the applications collection that aren't contained in this collection of names.

isUnicode

boolean isUnicode()
returns whether the application is Unicode application

isASO

boolean isASO()
returns whether the application's storage is ASO

setUnicode

void setUnicode(boolean b)
sets application mode

getUnicode

boolean getUnicode()
returns whether the application is Unicode application

setDatabasesLoaded

void setDatabasesLoaded(boolean loaded)

Skip navigation links


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