|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IEssOlapApplication is olap application.
Nested Class Summary | |
static class |
IEssOlapApplication.EEssLoadStatus
The EEssLoadStatus class is an enumeration of Application load status. |
static class |
IEssOlapApplication.EEssOlapApplicationAccess
The EEssOlapApplicationAccess is an enumeration of olap application access levels. |
Nested classes inherited from class com.essbase.api.base.IEssProperties |
IEssProperties.EEssPropertyMode |
Field Summary | |
static int |
PROP_COUNT_OF_CUBES
|
static int |
PROP_COUNT_OF_USERS_CONNECTED
|
static int |
PROP_DESCRIPTION
|
static int |
PROP_ELAPSED_TIME
|
static int |
PROP_IS_ALLOW_COMMANDS
|
static int |
PROP_IS_ALLOW_CONNECTS
|
static int |
PROP_IS_ALLOW_UPDATES
|
static int |
PROP_IS_AUTO_LOAD
|
static int |
PROP_IS_ENABLE_SECURITY
|
static int |
PROP_IS_LOADABLE
|
static int |
PROP_LOAD_STATUS
|
static int |
PROP_LOCALE
|
static int |
PROP_LOCK_TIMEOUT
|
static int |
PROP_MAXIMUM_SIZE_OF_ATTACHMENT_FILE
|
static int |
PROP_MINIMUM_CUBE_ACCESS
|
static int |
PROP_NAME
|
static int |
PROP_SERVER_NAME
|
static int |
PROP_TYPE
|
static int |
s_countProperties
|
static IEssValueAny.EEssDataType[] |
s_propDataTypes
|
static IEssProperties.EEssPropertyMode[] |
s_propModes
|
static java.lang.String[] |
s_propNames
|
Method Summary | |
IEssOlapApplication |
copy(java.lang.String newAppName)
Copies this application to a new application, including all associated cubes and objects and also starts the new application. |
IEssCube |
createCube(java.lang.String cubeName,
IEssCube.EEssCubeType cubeType)
Creates a new cube within this application and starts it. |
void |
delete()
Deletes this application. |
void |
deleteCube(java.lang.String cubeName)
Deletes the specified cube. |
void |
deleteLogFile()
Deletes this application's log file. |
IEssOlapApplication.EEssLoadStatus |
getAppLoadStatus()
Gets the application load status. |
int |
getCountCubes()
Gets the count of cubes in the application. |
int |
getCountUsersConnected()
Gets the count of users connected to the application. |
IEssCube |
getCube(java.lang.String cubeName)
Gets the specified cube. |
IEssIterator |
getCubes()
Gets the cubes in this application that are accessible to this user. |
java.lang.String |
getDescription()
Gets the application description. |
int |
getElapsedAppTime()
Gets the elapsed number of seconds since application loading. |
java.lang.String |
getLocale()
Gets the application locale. |
int |
getLockTimeout()
Gets the timeout period (in minutes) after which block-level locks are automatically removed. |
int |
getMaxAttachFileSize()
Gets the maximum attchment file size for lro. |
IEssCube.EEssCubeAccess |
getMinimumCubeAccess()
Gets the minimum cube access (the lowest possible level of access for all users). |
java.lang.String |
getName()
Gets the name of the application. |
IEssOlapServer |
getOlapServer()
Gets the parent olap Server. |
java.lang.String |
getServerName()
Gets the name of the server the application resides. |
java.lang.String |
getType()
Gets the application type. |
IEssOlapApplication.EEssOlapApplicationAccess |
getUserOrGroupAccess(java.lang.String userOrGroupName)
Gets the user or group access for this application. |
boolean |
isAllowCommands()
Gets flag to indicate whether users can issue commands to the application. |
boolean |
isAllowConnects()
Gets flag to indicate whether users can connect to the application. |
boolean |
isAllowUpdates()
Gets flag to indicate whether users can update data in the application. |
boolean |
isAutoLoad()
Gets flag to indicate whether the application is loaded automatically when Essbase is started. |
boolean |
isEnableSecurity()
Gets flag to indicate whether application security is enabled. |
boolean |
isLoadable()
Gets flag to indicate whether application can be loaded. |
void |
refreshPropertyValues()
Refreshes the property values. |
void |
rename(java.lang.String newAppName)
Renames this application. |
void |
setAllowCommands(boolean allowCommands)
Sets flag to indicate whether users can issue commands to the application. |
void |
setAllowConnects(boolean allowConnects)
Sets flag to indicate whether users can connect to the application. |
void |
setAllowUpdates(boolean allowUpdates)
Sets flag to indicate whether users can update data in the application. |
void |
setAutoLoad(boolean autoload)
Sets flag to indicate whether the application is loaded automatically when olap server is started. |
void |
setDescription(java.lang.String desc)
Sets the application description. |
void |
setEnableSecurity(boolean enableSecurity)
Sets flag to indicate whether application security is enabled. |
void |
setLoadable(boolean loadable)
Sets flag to indicate whether application can be loaded. |
void |
setLockTimeout(int lockTimeOutPeriod)
Sets timeout period (in minutes) after which block-level locks are automatically removed. |
void |
setMaxAttachFileSize(int maxLroFileSize)
Sets the maximum attachment file size for lro. |
void |
setMinimumCubeAccess(IEssCube.EEssCubeAccess minCubeAccess)
Sets the minimum cube access (the lowest possible level of access for all users). |
void |
setUserOrGroupAccess(java.lang.String userOrGroupName,
IEssOlapApplication.EEssOlapApplicationAccess access)
Sets the user or group access for this application. |
void |
start()
Starts this application. |
void |
stop()
Stops this application. |
void |
updatePropertyValues()
Updates the property values. |
void |
updatePropertyValues(java.lang.String desc,
int maxLroFileSize,
boolean loadable,
boolean autoLoad,
boolean allowCommands,
boolean allowConnects,
boolean allowUpdates,
boolean enableSecurity,
int lockTimeOutPeriod,
IEssCube.EEssCubeAccess minCubeAccess)
Updates the specified property values. |
Methods inherited from interface com.essbase.api.base.IEssExtendedObject |
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled |
Methods inherited from interface com.essbase.api.base.IEssProperties |
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny |
Methods inherited from interface com.essbase.api.datasource.IEssSubstitutionVariables |
createSubstitutionVariable, deleteSubstitutionVariable, getSubstitutionVariables, getSubstitutionVariableValue |
Field Detail |
public static final int PROP_NAME
public static final int PROP_DESCRIPTION
public static final int PROP_COUNT_OF_USERS_CONNECTED
public static final int PROP_LOAD_STATUS
public static final int PROP_ELAPSED_TIME
public static final int PROP_IS_LOADABLE
public static final int PROP_IS_AUTO_LOAD
public static final int PROP_MINIMUM_CUBE_ACCESS
public static final int PROP_IS_ALLOW_CONNECTS
public static final int PROP_IS_ALLOW_COMMANDS
public static final int PROP_IS_ALLOW_UPDATES
public static final int PROP_IS_ENABLE_SECURITY
public static final int PROP_LOCK_TIMEOUT
public static final int PROP_COUNT_OF_CUBES
public static final int PROP_SERVER_NAME
public static final int PROP_MAXIMUM_SIZE_OF_ATTACHMENT_FILE
public static final int PROP_TYPE
public static final int PROP_LOCALE
public static final int s_countProperties
public static final java.lang.String[] s_propNames
public static final IEssValueAny.EEssDataType[] s_propDataTypes
public static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
public java.lang.String getName() throws EssException
getName
in interface IEssExtendedObject
EssException
- if an error occur.public java.lang.String getDescription() throws EssException
EssException
- if an error occur.public void setDescription(java.lang.String desc) throws EssException
desc
- The description.
EssException
- if an error occur.public java.lang.String getType() throws EssException
EssException
- if an error occurs.public java.lang.String getLocale() throws EssException
EssException
- if an error occurs.public int getMaxAttachFileSize() throws EssException
EssException
- if an error occur.public void setMaxAttachFileSize(int maxLroFileSize) throws EssException
maxLroFileSize
- The maximum attachment file size (in bytes). Pass 0
for unlimited file size.
EssException
- if an error occur.public boolean isLoadable() throws EssException
EssException
- if an error occur.public void setLoadable(boolean loadable) throws EssException
loadable
- true if application is loadable.
EssException
- if an error occur.public boolean isAutoLoad() throws EssException
EssException
- if an error occur.public void setAutoLoad(boolean autoload) throws EssException
EssException
- if an error occur.public boolean isAllowCommands() throws EssException
EssException
- if an error occur.public void setAllowCommands(boolean allowCommands) throws EssException
allowCommands
- true if the application is accepting user commands.
EssException
- if an error occur.public boolean isAllowConnects() throws EssException
EssException
- if an error occur.public void setAllowConnects(boolean allowConnects) throws EssException
allowConnects
- true if users can connect.
EssException
- if an error occur.public boolean isAllowUpdates() throws EssException
EssException
- if an error occur.public void setAllowUpdates(boolean allowUpdates) throws EssException
allowUpdates
- true if the application is accepting user update commands.
EssException
- if an error occur.public boolean isEnableSecurity() throws EssException
EssException
- if an error occur.public void setEnableSecurity(boolean enableSecurity) throws EssException
enableSecurity
- true security is enabled.
EssException
- if an error occur.public int getLockTimeout() throws EssException
EssException
- if an error occur.public void setLockTimeout(int lockTimeOutPeriod) throws EssException
lockTimeOutPeriod
- The time out period (in minutes).
EssException.
EssException
public IEssCube.EEssCubeAccess getMinimumCubeAccess() throws EssException
EssException
- if an error occurs.public void setMinimumCubeAccess(IEssCube.EEssCubeAccess minCubeAccess) throws EssException
minCubeAccess
- The minimum cube access.
EssException
- if an error occurs.public IEssOlapApplication.EEssLoadStatus getAppLoadStatus() throws EssException
EssException
- if an error occurs.public int getCountUsersConnected() throws EssException
EssException
- if an error occurs.public int getElapsedAppTime() throws EssException
EssException
- if an error occurs.public int getCountCubes() throws EssException
EssException
- if an error occurs.public java.lang.String getServerName() throws EssException
EssException
- if an error occur.public void refreshPropertyValues() throws EssException
refreshPropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void updatePropertyValues() throws EssException
updatePropertyValues
in interface IEssProperties
EssException
- if an error occurs.public void updatePropertyValues(java.lang.String desc, int maxLroFileSize, boolean loadable, boolean autoLoad, boolean allowCommands, boolean allowConnects, boolean allowUpdates, boolean enableSecurity, int lockTimeOutPeriod, IEssCube.EEssCubeAccess minCubeAccess) throws EssException
desc
- The description.maxLroFileSize
- The maximum file size (in bytes). Pass 0 for
unlimited file size.loadable
- true if application is loadable.autoLoad
- true if the application will be automatically loaded.allowCommands
- true if the application is accepting user commands.allowConnects
- true if users can connect.allowUpdates
- true if the application is accepting user update commands.enableSecurity
- true security is enabled.lockTimeOutPeriod
- The time out period (in minutes).minCubeAccess
- The minimum cube access.
EssException
public IEssIterator getCubes() throws EssException
EssException
- if an error occurs.public IEssCube createCube(java.lang.String cubeName, IEssCube.EEssCubeType cubeType) throws EssException
cubeName
- The cube name.cubeType
- The cube type.
EssException
- if an error occurs.public IEssCube getCube(java.lang.String cubeName) throws EssException
cubeName
- The cube name.
EssException
- if an error occur.public void deleteCube(java.lang.String cubeName) throws EssException
cubeName
- The cube name.
EssException
- if an error occur.public void rename(java.lang.String newAppName) throws EssException
newAppName
- The new name of the application.
EssException
- if an error occurs.public IEssOlapApplication copy(java.lang.String newAppName) throws EssException
newAppName
- The new application name.
EssException
- if an error occurs.public void delete() throws EssException
EssException
- if an error occurs.public void start() throws EssException
EssException
- if an error occurs.public void stop() throws EssException
EssException
- if an error occurs.public void deleteLogFile() throws EssException
EssException
- if an error occurs.public IEssOlapApplication.EEssOlapApplicationAccess getUserOrGroupAccess(java.lang.String userOrGroupName) throws EssException
EssException
- if an error occurs.public void setUserOrGroupAccess(java.lang.String userOrGroupName, IEssOlapApplication.EEssOlapApplicationAccess access) throws EssException
access
- The application access.
EssException
- if an error occurs.public IEssOlapServer getOlapServer() throws EssException
EssException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |