Skip navigation links

com.essbase.eas.essbase.server
Class NamedObjectLogic

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

public class NamedObjectLogic

extends java.lang.Object

Constructor Summary

NamedObjectLogic()

Method Summary

boolean	copy(EssSession destSession, int objType, java.lang.String destApp, java.lang.String destDb, java.lang.String destSelection, EssSession srcSession, java.lang.String srcApp, java.lang.String srcDb, java.lang.String srcSelection) Currenly only cross server copy is enabled
boolean	copy(EssSession destSession, int objType, java.lang.String destApp, java.lang.String destDb, java.lang.String destSelection, EssSession srcSession, java.lang.String srcApp, java.lang.String srcDb, java.lang.String srcSelection, boolean replace) Currenly only cross server copy is enabled
java.util.List	copyAll(EssSession destSession, int objType, java.lang.String destApp, java.lang.String destDb, EssSession srcSession, java.lang.String srcApp, java.lang.String srcDb, boolean replace) Currenly only cross server copy is enabled
boolean	delete(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName) Deletes an Essbase file object.
java.util.List	getAllLockedObjects(EssSession session)
java.util.List	getList(EssSession session, int objType, java.lang.String appName, java.lang.String dbName) Returns a list of file objects of a given type in an application or database
java.util.List	getLockedObjects(EssSession session, java.lang.String appName, java.lang.String dbName) Unlocks a list of Essbase file objects.
java.io.File	getObject(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String objectName, int objType)
boolean	put(EssSession session, int objType, java.lang.String app, java.lang.String db, java.lang.String objName, java.lang.String localName)
boolean	put(EssSession session, int objType, java.lang.String app, java.lang.String db, java.lang.String objName, java.lang.String localName, boolean lock, boolean replace)
boolean	unlock(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName) Unlocks an Essbase file object.
boolean	unlock(EssSession session, java.util.List fileObjects) Unlocks a list of Essbase file objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedObjectLogic

public NamedObjectLogic()

Method Detail

delete

public boolean delete(EssSession session,
                      int objType,
                      java.lang.String appName,
                      java.lang.String dbName,
                      java.lang.String objName)
               throws NamedObjectLockedException

Deletes an Essbase file object. This method includes checks for a file lock and asks the user if s/he wants to remove the lock and proceed with the delete

Parameters:

session - - session for this command.

objType - - the type of file object

appName - - name of application containing the object

dbName - - name of database containing the object

objName - - name of the file object

Returns:

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

Throws:

an - exception if the object is locked

NamedObjectLockedException

getLockedObjects

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

Unlocks a list of Essbase file objects.

Parameters:

session - - session for this command.

appName - - name of application in which to look for locked objects

dbName - - Name of database in which to look for locked objects. If this parameter is null or blank, the application with all databases will be searched.

getAllLockedObjects

public java.util.List getAllLockedObjects(EssSession session)

unlock

public boolean unlock(EssSession session,
                      java.util.List fileObjects)

Unlocks a list of Essbase file objects.

Parameters:

session - - session for this command.

fileObjects - - A list of NamedObjectInfo objects

Returns:

true to indicate success for all unlocks.

unlock

public boolean unlock(EssSession session,
                      int objType,
                      java.lang.String appName,
                      java.lang.String dbName,
                      java.lang.String objName)

Unlocks an Essbase file object.

Parameters:

session - - session for this command.

objType - - the type of file object

appName - - name of application containing the object

dbName - - name of database containing the object

objName - - name of the file object

Returns:

true to indicate success for unlock operation.

getList

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

Returns a list of file objects of a given type in an application or database

Parameters:

session - - session for this command.

objType - - the type of file object

appName - - name of application containing the object

dbName - - name of database containing the object

objName - - name of the file object

getObject

public java.io.File getObject(EssSession session,
                              java.lang.String appName,
                              java.lang.String dbName,
                              java.lang.String objectName,
                              int objType)

copy

public boolean copy(EssSession destSession,
                    int objType,
                    java.lang.String destApp,
                    java.lang.String destDb,
                    java.lang.String destSelection,
                    EssSession srcSession,
                    java.lang.String srcApp,
                    java.lang.String srcDb,
                    java.lang.String srcSelection)

Currenly only cross server copy is enabled

copy

public boolean copy(EssSession destSession,
                    int objType,
                    java.lang.String destApp,
                    java.lang.String destDb,
                    java.lang.String destSelection,
                    EssSession srcSession,
                    java.lang.String srcApp,
                    java.lang.String srcDb,
                    java.lang.String srcSelection,
                    boolean replace)

Currenly only cross server copy is enabled

copyAll

public java.util.List copyAll(EssSession destSession,
                              int objType,
                              java.lang.String destApp,
                              java.lang.String destDb,
                              EssSession srcSession,
                              java.lang.String srcApp,
                              java.lang.String srcDb,
                              boolean replace)

Currenly only cross server copy is enabled

put

public boolean put(EssSession session,
                   int objType,
                   java.lang.String app,
                   java.lang.String db,
                   java.lang.String objName,
                   java.lang.String localName)

put

public boolean put(EssSession session,
                   int objType,
                   java.lang.String app,
                   java.lang.String db,
                   java.lang.String objName,
                   java.lang.String localName,
                   boolean lock,
                   boolean replace)

Skip navigation links