Skip navigation links


com.essbase.api.datasource
Interface IEssOlapRequest

All Superinterfaces:
IEssBaseObject

public interface IEssOlapRequest
extends IEssBaseObject

The IEssOlapRequest is a olap request. This can be used to display information about, or terminate, sessions and requests. A session is the time between login and logout for a user connected to Essbase olap server. A request is a query sent to Essbase OLAP server by a user or by another process; for example, starting an application, or restructuring a database outline. Each session can process only one request at a time; therefore, sessions and requests have a one-to-one relationship.

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

Method Summary
 java.lang.String getCubeName()
          Gets the active cube (if any) name, for the session or request.
 long getLoginId()
          Gets the essbase login id
 java.lang.String getOlapApplicationName()
          Gets the active olap application (if any) name, for the session or request.
 short getRequestCode()
          Gets the request code (a positive integer representing an active session.
 java.lang.String getRequestSource()
          Gets the machine name from which the request is being made.
 short getRequestState()
          Gets the request state (i.e state of the current session or request: whether it is processing, terminating, or terminated).
 java.lang.String getRequestString()
          Gets the request string (a string representing the type of request.
 int getRequestTime()
          Gets the request time (i.e how long the session or request has been in progress - in seconds).
 java.lang.String getUserName()
          Gets the name of the requesting user.
 void kill()
          Terminates this sessions or request.

 

Method Detail

getUserName

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

getRequestSource

java.lang.String getRequestSource()
                                  throws com.essbase.api.base.EssException
Gets the machine name from which the request is being made.
Returns:
The client machine name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getOlapApplicationName

java.lang.String getOlapApplicationName()
                                        throws com.essbase.api.base.EssException
Gets the active olap application (if any) name, for the session or request.
Returns:
The olap 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 active cube (if any) name, for the session or request.
Returns:
The cube name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getRequestCode

short getRequestCode()
                     throws com.essbase.api.base.EssException
Gets the request code (a positive integer representing an active session. Eg:774896669).
Returns:
The cube request code.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getRequestString

java.lang.String getRequestString()
                                  throws com.essbase.api.base.EssException
Gets the request string (a string representing the type of request. Eg: Restructure, ClearData, GetStats, Calculate, DataLoad).
Returns:
The request string.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getRequestTime

int getRequestTime()
                   throws com.essbase.api.base.EssException
Gets the request time (i.e how long the session or request has been in progress - in seconds).
Returns:
The request time.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getRequestState

short getRequestState()
                      throws com.essbase.api.base.EssException
Gets the request state (i.e state of the current session or request: whether it is processing, terminating, or terminated).
Returns:
The request state. Values: 0 (processing), 1 (terminating), 2 (terminated).
Throws:
com.essbase.api.base.EssException - if an error occurs.

getLoginId

long getLoginId()
                throws com.essbase.api.base.EssException
Gets the essbase login id
Throws:
com.essbase.api.base.EssException - if an error occurs.

kill

void kill()
          throws com.essbase.api.base.EssException
Terminates this sessions or request.
Throws:
com.essbase.api.base.EssException - if an error occurs.

Skip navigation links