Skip navigation links


com.essbase.api.datasource
Interface IEssOlapFileObject

All Superinterfaces:
IEssBaseObject

public interface IEssOlapFileObject
extends IEssBaseObject

The IEssOlapFileObject is the OLAP store file object.

Version:
1.0, 04/04/2001
Author:
Srini Ranga

Field Summary
static int TYPE_ALIAS
          Alias file object (*.alt).
static int TYPE_ALL
           
static int TYPE_ASCBACKUP
          ASCII backup file data object (*.bka).
static int TYPE_BACKUP
           
static int TYPE_BINBACKUP
          Binary backup file data object (*.bkb).
static int TYPE_CALCSCRIPT
          Calc script file object (*.csc).
static int TYPE_DATA
           
static int TYPE_EQD
          EGD object (*.eqd).
static int TYPE_EXCEL
          Excel worksheet file data object (*.xls).
static int TYPE_JAVA_CDF
          Java CDF object - most likely a jar file
static int TYPE_LOTUS2
          1-2-3 2.x worksheet file object (*.wk1).
static int TYPE_LOTUS3
          1-2-3 3.x worksheet file object (*.wk3).
static int TYPE_LOTUS4
          1-2-3 4.x Worksheet file object (*.wk4)
static int TYPE_LRO
          LRO object (*.lro).
static int TYPE_MAX
          maximum single object type value
static int TYPE_OUTLINE
          Outline file object (*.otl).
static int TYPE_PARTITION
          Partition defn file (*.ddb).
static int TYPE_REPORT
          Report specification file object (*.rep).
static int TYPE_RULES
          Rules file object (*.rul).
static int TYPE_SELECTION
          Selection file object (*.sel).
static int TYPE_STRUCTURE
          Structure file object (*.str).
static int TYPE_TEXT
          Text File data object (*.txt).
static int TYPE_WIZARD
          Wizard file object (*.wiz).
static int TYPE_WORKSHEET
           
static int TYPE_XML
          XML file (*.xml).

 

Method Summary
 java.lang.String getApplicationName()
          Gets the application name.
 java.lang.String getCubeName()
          Gets the cube name.
 int getFileSize()
          Deprecated. Replaced by getFileSizeLong()
 long getFileSizeLong()
          Gets the object's allocated file size on disk (in bytes).
 java.lang.String getName()
          Gets the object name.
 int[] getTimeModified()
          Gets the date and time of last modification as [0] = TimeValue [1] = Seconds [2] = Minutes [3] = Hours [4] = Day [5] = Month [6] = Year [7] = Weekday
 int getTimeStamp()
          Gets the date and time object was locked (if locked).
 int getType()
          Gets the object type.
 java.lang.String getUserNameWhoLocked()
          Gets the name of the user who has the object locked (if locked).
 boolean isLocked()
          Gets flag to indicate whether object is locked on the server.

 

Field Detail

TYPE_OUTLINE

static final int TYPE_OUTLINE
Outline file object (*.otl).
See Also:
Constant Field Values

TYPE_CALCSCRIPT

static final int TYPE_CALCSCRIPT
Calc script file object (*.csc).
See Also:
Constant Field Values

TYPE_REPORT

static final int TYPE_REPORT
Report specification file object (*.rep).
See Also:
Constant Field Values

TYPE_RULES

static final int TYPE_RULES
Rules file object (*.rul).
See Also:
Constant Field Values

TYPE_ALIAS

static final int TYPE_ALIAS
Alias file object (*.alt).
See Also:
Constant Field Values

TYPE_STRUCTURE

static final int TYPE_STRUCTURE
Structure file object (*.str).
See Also:
Constant Field Values

TYPE_ASCBACKUP

static final int TYPE_ASCBACKUP
ASCII backup file data object (*.bka).
See Also:
Constant Field Values

TYPE_BINBACKUP

static final int TYPE_BINBACKUP
Binary backup file data object (*.bkb).
See Also:
Constant Field Values

TYPE_EXCEL

static final int TYPE_EXCEL
Excel worksheet file data object (*.xls).
See Also:
Constant Field Values

TYPE_LOTUS2

static final int TYPE_LOTUS2
1-2-3 2.x worksheet file object (*.wk1).
See Also:
Constant Field Values

TYPE_LOTUS3

static final int TYPE_LOTUS3
1-2-3 3.x worksheet file object (*.wk3).
See Also:
Constant Field Values

TYPE_TEXT

static final int TYPE_TEXT
Text File data object (*.txt).
See Also:
Constant Field Values

TYPE_LOTUS4

static final int TYPE_LOTUS4
1-2-3 4.x Worksheet file object (*.wk4)
See Also:
Constant Field Values

TYPE_WIZARD

static final int TYPE_WIZARD
Wizard file object (*.wiz).
See Also:
Constant Field Values

TYPE_PARTITION

static final int TYPE_PARTITION
Partition defn file (*.ddb).
See Also:
Constant Field Values

TYPE_SELECTION

static final int TYPE_SELECTION
Selection file object (*.sel).
See Also:
Constant Field Values

TYPE_LRO

static final int TYPE_LRO
LRO object (*.lro).
See Also:
Constant Field Values

TYPE_EQD

static final int TYPE_EQD
EGD object (*.eqd).
See Also:
Constant Field Values

TYPE_XML

static final int TYPE_XML
XML file (*.xml).
See Also:
Constant Field Values

TYPE_JAVA_CDF

static final int TYPE_JAVA_CDF
Java CDF object - most likely a jar file
See Also:
Constant Field Values

TYPE_MAX

static final int TYPE_MAX
maximum single object type value
See Also:
Constant Field Values

TYPE_BACKUP

static final int TYPE_BACKUP
See Also:
Constant Field Values

TYPE_WORKSHEET

static final int TYPE_WORKSHEET
See Also:
Constant Field Values

TYPE_DATA

static final int TYPE_DATA
See Also:
Constant Field Values

TYPE_ALL

static final int TYPE_ALL
See Also:
Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException
Gets the object name.
Returns:
The object name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getType

int getType()
            throws com.essbase.api.base.EssException
Gets the object type.
Returns:
The object type. Values from IEssOLAPFileObject.TYPE_*.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getApplicationName

java.lang.String getApplicationName()
                                    throws com.essbase.api.base.EssException
Gets the application name.
Returns:
The application name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getCubeName

java.lang.String getCubeName()
                             throws com.essbase.api.base.EssException
Gets the cube name.
Returns:
The cube name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getFileSize

int getFileSize()
                throws com.essbase.api.base.EssException
Deprecated. Replaced by getFileSizeLong()
Gets the object's allocated file size on disk (in bytes).
Returns:
The file size.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getFileSizeLong

long getFileSizeLong()
                     throws com.essbase.api.base.EssException
Gets the object's allocated file size on disk (in bytes).
Returns:
The file size.
Throws:
com.essbase.api.base.EssException - if an error occurs.
Since:
11.1.2.1.00

isLocked

boolean isLocked()
                 throws com.essbase.api.base.EssException
Gets flag to indicate whether object is locked on the server.
Returns:
true if the object is locked.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getUserNameWhoLocked

java.lang.String getUserNameWhoLocked()
                                      throws com.essbase.api.base.EssException
Gets the name of the user who has the object locked (if locked).
Returns:
The cube name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getTimeStamp

int getTimeStamp()
                 throws com.essbase.api.base.EssException
Gets the date and time object was locked (if locked).
Returns:
The date and time object was locked.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getTimeModified

int[] getTimeModified()
                      throws com.essbase.api.base.EssException
Gets the date and time of last modification as [0] = TimeValue [1] = Seconds [2] = Minutes [3] = Hours [4] = Day [5] = Month [6] = Year [7] = Weekday
Returns:
The date and time of last modification.
Throws:
com.essbase.api.base.EssException - if an error occurs.

Skip navigation links