com.essbase.api.datasource

Class EssOutlineEditOption

java.lang.Object

com.essbase.api.datasource.EssOutlineEditOption

All Implemented Interfaces:

java.io.Serializable

public class EssOutlineEditOption
extends java.lang.Object
implements java.io.Serializable

This is used for specifying the server outline editing options.

Since:

11.1.2.4.0

Author:

sramanav

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EssOutlineEditOption()

Method Summary

Modifier and Type	Method and Description
boolean	isIncremental() Returns the incremental mode Defaults to false.
boolean	isKeepTransaction() Returns the keepTransaction option Defaults to true.
boolean	isLock() Retrieves the locking option Defaults to true.
void	setIncremental(boolean bIncremental) Set to true if the outline should be opened in incremental mode Defaults to false.
void	setKeepTransaction(boolean bKeepTransaction) Set to true to keep transactions.
void	setLock(boolean bLock) Set to true if the outline should be locked when it is opened Defaults to true.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EssOutlineEditOption

public EssOutlineEditOption()

Method Detail

isLock

public boolean isLock()

Retrieves the locking option Defaults to true.

Returns:

the bLock

setLock

public void setLock(boolean bLock)

Set to true if the outline should be locked when it is opened Defaults to true.

Parameters:

bLock - the bLock to set

isKeepTransaction

public boolean isKeepTransaction()

Returns the keepTransaction option Defaults to true.

Returns:

the bKeepTransaction

setKeepTransaction

public void setKeepTransaction(boolean bKeepTransaction)

Set to true to keep transactions. If you are opening an existing outline to make changes, and you intend to restructure the cube and keep data, we recommend that you set this flag to true. When true, a log is kept of activities done to the outline. If you are starting from an empty outline or are not planning on saving data when you restructure, we recommend that you set this field to false. When false, no log is kept, saving time and memory. Defaults to true.

Parameters:

bKeepTransaction - the bKeepTransaction to set

isIncremental

public boolean isIncremental()

Returns the incremental mode Defaults to false.

Returns:

the bIncremental

setIncremental

public void setIncremental(boolean bIncremental)

Set to true if the outline should be opened in incremental mode Defaults to false.

Parameters:

bIncremental - the bIncremental to set