com.essbase.api.datasource

Interface IEssCube.IEssCubeLock

All Superinterfaces:

IEssBaseObject

Enclosing interface:

IEssCube

public static interface IEssCube.IEssCubeLock
extends IEssBaseObject

The IEssCubeLock interface provides information about the data blocks exclusively locked.

Version:

1.0, 04/04/2002

Author:

Srini Ranga

Method Summary

Modifier and Type	Method and Description
int	getCountLockedBlocks() Gets the number of blocks exclusively locked by this user.
java.lang.String	getLockedUserName() Gets the name of the user who has locked blocks.
int	getMaximumLockedTime() Gets the maximum time (in seconds) that blocks have been exclusively locked.
void	removeLocks() Removes all the data block locks held by a user on this cube.

Method Detail

getLockedUserName

java.lang.String getLockedUserName()
                            throws com.essbase.api.base.EssException

Gets the name of the user who has locked blocks.

Returns:

The user name.

Throws:

com.essbase.api.base.EssException - if an error occur.

getCountLockedBlocks

int getCountLockedBlocks()
                  throws com.essbase.api.base.EssException

Gets the number of blocks exclusively locked by this user.

Returns:

The number of blocks locked.

Throws:

com.essbase.api.base.EssException - if an error occur.

getMaximumLockedTime

int getMaximumLockedTime()
                  throws com.essbase.api.base.EssException

Gets the maximum time (in seconds) that blocks have been exclusively locked.

Returns:

The maximum locked time (in seconds).

Throws:

com.essbase.api.base.EssException - if an error occur.

removeLocks

void removeLocks()
          throws com.essbase.api.base.EssException

Removes all the data block locks held by a user on this cube.

Throws:

com.essbase.api.base.EssException - if an error occurs.