Skip navigation links

com.essbase.eas.essbase.server
Class NamedObjectPrimitives

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

public class NamedObjectPrimitives

extends java.lang.Object

This class provides the primitive operations for manipulating Essbase file objects. File objects include Calc Scripts, Report scripts, Rules files, and other files. See NamedObjectTypes for a complete list.

Version:

6.5.0, 2/12/2002

Author:

Joe Fernandez

See Also:

for object type definitions

Method Summary

static boolean	copy(EssSession destSession, int objType, java.lang.String destApp, java.lang.String destDatabase, java.lang.String destObject, java.lang.String srcApp, java.lang.String srcDatabase, java.lang.String srcObject)
static boolean	copy(EssSession destSession, int objType, java.lang.String destApp, java.lang.String destDatabase, java.lang.String destObject, java.lang.String srcApp, java.lang.String srcDatabase, java.lang.String srcObject, boolean replace) Copies an Essbase file object within an individual server.
static boolean	delete(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName) Deletes an Essbase file object.
static boolean	get(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean lock) Gets an Essbase file object.
static java.util.List	getAllLockedObjects(EssSession session) Get all the locked objects using maxl then use the JNI to get info on only the locked objects because maxl returns the lock time as a string which we can't localize
static NamedObjectInfo	getInfo(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName) Gets information on an Essbase file object.
static java.util.List	getInfoList(EssSession session, int objType, java.lang.String appName, java.lang.String dbName) Gets a list of information on Essbase file objects.
static java.util.List	getList(EssSession session, int objType, java.lang.String appName, java.lang.String dbName) Gets a list of names of Essbase file objects.
static java.util.List	getLockedObjects(EssSession session, java.lang.String appname, java.lang.String dbname)
static boolean	lock(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName) Locks an Essbase file object.
static boolean	put(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean unlock)
static boolean	put(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean unlock, boolean replace) Puts an Essbase file object.
static boolean	rename(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String newName, java.lang.String oldName) Renames an Essbase file object.
static boolean	unlock(EssSession session, int objType, java.lang.String appName, java.lang.String dbName, java.lang.String objName) Unlocks an Essbase file object.

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,
                                     int objType,
                                     java.lang.String appName,
                                     java.lang.String dbName)

Gets a list of names of Essbase file objects.

Parameters:

session - - session object for this command.

objType - - the object type being operated on

appName - - name of application.

dbName - - name of database.

Returns:

A list of strings containing the names of file objects.

getInfoList

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

Gets a list of information on Essbase file objects.

Parameters:

session - - session object for this command.

objType - - the object type being operated on

appName - - name of application.

dbName - - name of database.

Returns:

A list of NamedObjectInfo objects for the file objects.

getLockedObjects

public static java.util.List getLockedObjects(EssSession session,
                                              java.lang.String appname,
                                              java.lang.String dbname)

getInfo

public static NamedObjectInfo getInfo(EssSession session,
                                      int objType,
                                      java.lang.String appName,
                                      java.lang.String dbName,
                                      java.lang.String objName)

Gets information on an Essbase file object.

Parameters:

session - - session object for this command.

objType - - the object type being operated on

appName - - name of application.

dbName - - name of database.

objName - - name of the object.

localName - - name of the file to create

Returns:

If successful, returns a populated NamedObjectInfo object.

get

public static boolean get(EssSession session,
                          int objType,
                          java.lang.String appName,
                          java.lang.String dbName,
                          java.lang.String objName,
                          java.lang.String localName,
                          boolean lock)

Gets an Essbase file object.

Parameters:

session - - session object for this command.

objType - - the object type being operated on

appName - - name of application.

dbName - - name of database.

objName - - name of the object.

localName - - name of the file to create

Returns:

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

put

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

put

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

Puts an Essbase file object.

Parameters:

session - - session object for this command.

objType - - the object type being operated on

appName - - name of application.

dbName - - name of database.

objName - - name of the object.

localName -

unlock - - indicates whether the object should be unlocked or locked after it is put to the server.

replace - - replace if exists

Returns:

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

delete

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

Deletes an Essbase file object.

Parameters:

session - - session object for this command.

objType - - the object type being operated on

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 boolean lock(EssSession session,
                           int objType,
                           java.lang.String appName,
                           java.lang.String dbName,
                           java.lang.String objName)

Locks an Essbase file object.

Parameters:

session - - session object for this command.

objType - - the object type being operated on

appName - - name of application containing the object.

dbName - - name of database containing the object.

objName - - name of the object.

Returns:

true if the lock succeeds.

unlock

public static 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 object for this command.

objType - - the object type being operated on

appName - - name of application containing the object.

dbName - - name of database containing the object.

objName - - name of the object

Returns:

true if the unlock succeeds.

copy

public static boolean copy(EssSession destSession,
                           int objType,
                           java.lang.String destApp,
                           java.lang.String destDatabase,
                           java.lang.String destObject,
                           java.lang.String srcApp,
                           java.lang.String srcDatabase,
                           java.lang.String srcObject)

copy

public static boolean copy(EssSession destSession,
                           int objType,
                           java.lang.String destApp,
                           java.lang.String destDatabase,
                           java.lang.String destObject,
                           java.lang.String srcApp,
                           java.lang.String srcDatabase,
                           java.lang.String srcObject,
                           boolean replace)

Copies an Essbase file object within an individual server.

Should we throw an exception here?

Parameters:

session - - session object for this command.

objType - - the object type being operated on

destApp - - application name for the copy.

destDatabase - - database name for the copy.

destObject - - Object name for the copy.

srcApp - - application to be copied.

srcDatabase - - database to be copied.

srcObject - - Object name to be copied.

replace - - replace object if it already exists;

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,
                             int objType,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String newName,
                             java.lang.String oldName)

Renames an Essbase file object.

Parameters:

session - - session object for this command.

objType - - the object type being operated on

appName - - name of application containing the rules object.

dbName - - name of database containing the rules object.

newName - - name of the new rules object.

oldName - - name of the old rules object.

Returns:

true if the rename succeeds.

getAllLockedObjects

public static java.util.List getAllLockedObjects(EssSession session)

Get all the locked objects using maxl then use the JNI to get info on only the locked objects because maxl returns the lock time as a string which we can't localize

Parameters:

session -

Returns:

Skip navigation links