com.essbase.api.datasource

Interface IEssPerformAllocation

public interface IEssPerformAllocation

Interface to perform Allocation. To performs the allocation in Essbase use API performAllocation(boolean, List). Before calling this API, all the parameters must be set using the appropriate set* methods in this class.

Since:

11.1.2

Field Summary

Fields

Modifier and Type	Field and Description
static long	ESS_ASO_ALLOCATION_METHOD_SHARE
static long	ESS_ASO_ALLOCATION_METHOD_SPREAD
static long	ESS_ASO_ALLOCATION_NEGBASIS_ABORT cancel the allocation
static long	ESS_ASO_ALLOCATION_NEGBASIS_ABS use absolute value
static long	ESS_ASO_ALLOCATION_NEGBASIS_DEFAULT default behavior
static long	ESS_ASO_ALLOCATION_NEGBASIS_MISSING treat it as #missing
static long	ESS_ASO_ALLOCATION_NEGBASIS_NEXTAMT skip to next Amount value
static long	ESS_ASO_ALLOCATION_NEGBASIS_ZERO treat it as a zero
static long	ESS_ASO_ALLOCATION_ROUND_DISCARDERRORS Perform rounding, but discard rounding errors
static long	ESS_ASO_ALLOCATION_ROUND_ERRORSTOHIGHEST Rounding errors are added to the highest allocated value
static long	ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOCATION Rounding errors are added to a specific location given by roundToLocation
static long	ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOWEST Rounding errors are added to the lowest allocated value
static long	ESS_ASO_ALLOCATION_ROUND_NONE No rounding performed
static long	ESS_ASO_ALLOCATION_SPREAD_OPTIONS
static long	ESS_ASO_ALLOCATION_SPREAD_SKIPMISSING
static long	ESS_ASO_ALLOCATION_SPREAD_SKIPNEGATIVE
static long	ESS_ASO_ALLOCATION_SPREAD_SKIPZERO
static long	ESS_ASO_ALLOCATION_TIMESPAN_COMBINE_BASIS Combine basis value across time periods in basisTimeSpan and use the combined basis for allocation.
static long	ESS_ASO_ALLOCATION_TIMESPAN_DIVIDEAMT
static long	ESS_ASO_ALLOCATION_TIMESPAN_REPEATAMT
static long	ESS_ASO_ALLOCATION_TIMESPAN_SPLIT_BASIS Process basis value for each time period individually
static long	ESS_ASO_ALLOCATION_ZEROAMT_ABORT cancel the whole allocation
static long	ESS_ASO_ALLOCATION_ZEROAMT_DEFAULT allocate zero values
static long	ESS_ASO_ALLOCATION_ZEROAMT_NEXTAMT skip to the next Amount value
static long	ESS_ASO_ALLOCATION_ZEROBASIS_ABORT cancel the whole allocation
static long	ESS_ASO_ALLOCATION_ZEROBASIS_NEXTAMT skip to the next Amount value

Method Summary

Modifier and Type	Method and Description
long	getAllocationMethod()
java.lang.String	getAmount()
java.lang.String	getAmountContext()
java.lang.String	getAmountTimeSpan()
java.lang.String	getBasis()
java.lang.String	getBasisTimeSpan()
long	getBasisTimeSpanOption()
java.lang.String	getCreditMember()
long	getDataloadOption()
java.lang.String	getDebitMember()
java.lang.String	getExcludedRange()
long	getGroupID()
long	getNegativeBasisOption()
java.lang.String	getOffset()
java.lang.String	getPOV()
java.lang.String	getRange()
java.lang.String	getRoundDigits()
long	getRoundMethod()
java.lang.String	getRoundToLocation()
long	getRuleID()
long	getSpreadSkipOption()
java.lang.String	getTarget()
java.lang.String	getTargetTimeSpan()
long	getTargetTimeSpanOption()
long	getZeroAmountOption()
long	getZeroBasisOption()
boolean	performAllocation(boolean verifyOnly, java.util.List outErrorsAndWarnings) Performs the allocation on a Essbase ASO(Aggregate Storage outline) cube.
void	setAllocationMethod(long allocationMethod) Sets the allocationMethod - Allocation method to use.
void	setAmount(java.lang.String amount) Sets the amount - MDX numeric value expression indicating the source of allocation.
void	setAmountContext(java.lang.String amountContext) Sets the amountContext - MDX tuple expression indicating the context for the amount argument above.
void	setAmountInfo(java.lang.String amount, java.lang.String amountContext, java.lang.String amountTimeSpan, long zeroAmountOption) Sets all amount related parameters.
void	setAmountTimeSpan(java.lang.String amountTimeSpan) Sets the amountTimeSpan - MDX tuple expression specifying time periods to consider for amount.
void	setBasis(java.lang.String basis) Sets the basis - MDX tuple expression specifying the Basis location.
void	setBasisInfo(java.lang.String basis, java.lang.String basisTimeSpan, long basisTimeSpanOption, long zeroBasisOption, long negativeBasisOption) Sets all basis related parameters.
void	setBasisTimeSpan(java.lang.String basisTimeSpan) Sets the basisTimeSpan - MDX tuple expression specifying time periods to consider for basis.
void	setBasisTimeSpanOption(long basisTimeSpanOption) Sets the basisTimeSpanOption - Option to specify how basis is computed across time periods specified in setBasisTimeSpan(String).
void	setCreditMember(java.lang.String creditMember) Sets the creditMember - An MDX member expression that specifies the credit member used for negative and offsetting result values.
void	setDataloadOption(long dataloadOption) The dataloadOption can have values IEssCube.ESS_ASO_DATA_LOAD_BUFFER_STORE_DATA, IEssCube.ESS_ASO_DATA_LOAD_BUFFER_ADD_DATA or IEssCube.ESS_ASO_DATA_LOAD_BUFFER_SUBTRACT_DATA
void	setDebitMember(java.lang.String debitMember) Sets the debitMember - An MDX member expression that specifies the debit member used for positive result values.
void	setExcludedRange(java.lang.String excludedRange) Sets the execludedRange - MDX set expression specifying a subset of range that will be used to calculate allocated values but will not be written to.
void	setGroupID(long groupID) Sets the groupID - The groupID refers to the Rule Set that this allocation is a part of.
void	setNegativeBasisOption(long negativeBasisOption) Sets negativeBasisOption - If the specified allocationMethod is ESS_ASO_ALLOCATION_METHOD_SHARE, then you can specify exactly one of the following options to tell Essbase what to do when a negative Basis value is encountered.
void	setOffset(java.lang.String offset) Sets the offset - MDX tuple expression indicating location where offsetting entries should be made for each source amount that is allocated.
void	setPOV(java.lang.String pov) Sets the MDX set expression specifying area of allocation.
void	setRange(java.lang.String range) Sets the range - MDX set expression that specifies cube region used for allocation.
void	setRoundDigits(java.lang.String roundDigits) Sets the roundDigits - If the roundMethod is ESS_ASO_ALLOCATION_ROUND_NONE, then this must be empty.
void	setRoundingInfo(long roundMethod, java.lang.String roundDigits, java.lang.String roundToLocation) Sets all the rounding related parameters.
void	setRoundMethod(long roundMethod) Sets the roundMethod - Rounding method to use for rounding allocated values.
void	setRoundToLocation(java.lang.String roundToLocation) Sets the roundToLocation - If the roundMethod is anything besides ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOCATION, then this must be empty.
void	setRuleID(long ruleID) The rule ID used to identify the information (rule name, rule description) related to this allocation rule.
void	setSpreadSkipOption(long spreadSkipOption) Sets the spreadSkipOption - When allocationMethod is ESS_ASO_ALLOCATION_METHOD_SHARE, this argument must be 0.
void	setTarget(java.lang.String target) Sets the target - MDX tuple expression indicating target location where allocations will be made.
void	setTargetInfo(java.lang.String target, java.lang.String targetTimeSpan, long targetTimeSpanOption) Sets all the target related parameters.
void	setTargetTimeSpan(java.lang.String targetTimeSpan) Sets the targetTimeSpan - MDX tuple expression specifying time periods to consider for target.
void	setTargetTimeSpanOption(long targetTimeSpanOption) Set the targetTimeSpanOption - Option to specify how values are allocated across time periods specified in setTargetTimeSpan(String).
void	setZeroAmountOption(long zeroAmountOption) Sets the zeroAmountOption - This option tells Essbase what to do when an Amount value (the value to be allocated) is either zero or missing.
void	setZeroBasisOption(long zeroBasisOption) Sets the zeroBasisOption - When the specified allocationMethod is ESS_ASO_ALLOCATION_METHOD_SHARE, then this argument tells Essbase what to do when the sum of all Basis values is zero.

Field Detail

ESS_ASO_ALLOCATION_METHOD_SHARE

static final long ESS_ASO_ALLOCATION_METHOD_SHARE

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_METHOD_SPREAD

static final long ESS_ASO_ALLOCATION_METHOD_SPREAD

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_SPREAD_SKIPMISSING

static final long ESS_ASO_ALLOCATION_SPREAD_SKIPMISSING

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_SPREAD_SKIPZERO

static final long ESS_ASO_ALLOCATION_SPREAD_SKIPZERO

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_SPREAD_SKIPNEGATIVE

static final long ESS_ASO_ALLOCATION_SPREAD_SKIPNEGATIVE

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_SPREAD_OPTIONS

static final long ESS_ASO_ALLOCATION_SPREAD_OPTIONS

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ZEROAMT_DEFAULT

static final long ESS_ASO_ALLOCATION_ZEROAMT_DEFAULT

allocate zero values

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ZEROAMT_NEXTAMT

static final long ESS_ASO_ALLOCATION_ZEROAMT_NEXTAMT

skip to the next Amount value

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ZEROAMT_ABORT

static final long ESS_ASO_ALLOCATION_ZEROAMT_ABORT

cancel the whole allocation

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ZEROBASIS_NEXTAMT

static final long ESS_ASO_ALLOCATION_ZEROBASIS_NEXTAMT

skip to the next Amount value

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ZEROBASIS_ABORT

static final long ESS_ASO_ALLOCATION_ZEROBASIS_ABORT

cancel the whole allocation

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_NEGBASIS_DEFAULT

static final long ESS_ASO_ALLOCATION_NEGBASIS_DEFAULT

default behavior

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_NEGBASIS_NEXTAMT

static final long ESS_ASO_ALLOCATION_NEGBASIS_NEXTAMT

skip to next Amount value

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_NEGBASIS_ABORT

static final long ESS_ASO_ALLOCATION_NEGBASIS_ABORT

cancel the allocation

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_NEGBASIS_ABS

static final long ESS_ASO_ALLOCATION_NEGBASIS_ABS

use absolute value

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_NEGBASIS_MISSING

static final long ESS_ASO_ALLOCATION_NEGBASIS_MISSING

treat it as #missing

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_NEGBASIS_ZERO

static final long ESS_ASO_ALLOCATION_NEGBASIS_ZERO

treat it as a zero

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_TIMESPAN_SPLIT_BASIS

static final long ESS_ASO_ALLOCATION_TIMESPAN_SPLIT_BASIS

Process basis value for each time period individually

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_TIMESPAN_COMBINE_BASIS

static final long ESS_ASO_ALLOCATION_TIMESPAN_COMBINE_BASIS

Combine basis value across time periods in basisTimeSpan and use the combined basis for allocation.

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_TIMESPAN_DIVIDEAMT

static final long ESS_ASO_ALLOCATION_TIMESPAN_DIVIDEAMT

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_TIMESPAN_REPEATAMT

static final long ESS_ASO_ALLOCATION_TIMESPAN_REPEATAMT

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ROUND_NONE

static final long ESS_ASO_ALLOCATION_ROUND_NONE

No rounding performed

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ROUND_DISCARDERRORS

static final long ESS_ASO_ALLOCATION_ROUND_DISCARDERRORS

Perform rounding, but discard rounding errors

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ROUND_ERRORSTOHIGHEST

static final long ESS_ASO_ALLOCATION_ROUND_ERRORSTOHIGHEST

Rounding errors are added to the highest allocated value

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOWEST

static final long ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOWEST

Rounding errors are added to the lowest allocated value

See Also:

Constant Field Values

ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOCATION

static final long ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOCATION

Rounding errors are added to a specific location given by roundToLocation

See Also:

Constant Field Values

Method Detail

getPOV

java.lang.String getPOV()

Returns:

the pov

setPOV

void setPOV(java.lang.String pov)

Sets the MDX set expression specifying area of allocation.

Parameters:

pov - the pov to set

getAmount

java.lang.String getAmount()

Returns:

the amount

setAmount

void setAmount(java.lang.String amount)

Sets the amount - MDX numeric value expression indicating the source of allocation. If this is an expression, all members in the expression should be from same dimension.

Parameters:

amount - the amount to set

getAmountContext

java.lang.String getAmountContext()

Returns:

the amountContext

setAmountContext

void setAmountContext(java.lang.String amountContext)

Sets the amountContext - MDX tuple expression indicating the context for the amount argument above. This argument must only be used when amount is an MDX numeric value expression. Otherwise, when amount is a tuple or a constant number, this argument should be empty.

Parameters:

amountContext - the amountContext to set

getAmountTimeSpan

java.lang.String getAmountTimeSpan()

Returns:

the amountTimeSpan

setAmountTimeSpan

void setAmountTimeSpan(java.lang.String amountTimeSpan)

Sets the amountTimeSpan - MDX tuple expression specifying time periods to consider for amount. The amount value is aggregated over the time periods specified in amountTimeSpan and the resulting aggregated value is allocated across range.

Parameters:

amountTimeSpan - the amountTimeSpan to set

getTarget

java.lang.String getTarget()

Returns:

the target

setTarget

void setTarget(java.lang.String target)

Sets the target - MDX tuple expression indicating target location where allocations will be made.

Parameters:

target - the target to set

getTargetTimeSpan

java.lang.String getTargetTimeSpan()

Returns:

the targetTimeSpan

setTargetTimeSpan

void setTargetTimeSpan(java.lang.String targetTimeSpan)

Sets the targetTimeSpan - MDX tuple expression specifying time periods to consider for target. This argument in combination with setTargetTimeSpanOption(long) determines how values are allocated across time periods in targetTimeSpan

Parameters:

targetTimeSpan - the targetTimeSpan to set

getTargetTimeSpanOption

long getTargetTimeSpanOption()

Returns:

the targetTimeSpanOption

setTargetTimeSpanOption

void setTargetTimeSpanOption(long targetTimeSpanOption)

Set the targetTimeSpanOption - Option to specify how values are allocated across time periods specified in setTargetTimeSpan(String). It can have one of the following values: ESS_ASO_ALLOCATION_TIMESPAN_DIVIDEAMT ESS_ASO_ALLOCATION_TIMESPAN_REPEATAMT

Parameters:

targetTimeSpanOption - the targetTimeSpanOption to set

getOffset

java.lang.String getOffset()

Returns:

the offset

setOffset

void setOffset(java.lang.String offset)

Sets the offset - MDX tuple expression indicating location where offsetting entries should be made for each source amount that is allocated. If this argument is empty, then no offset calculation is done.

Parameters:

offset - the offset to set

getDebitMember

java.lang.String getDebitMember()

Returns:

the debitMember

setDebitMember

void setDebitMember(java.lang.String debitMember)

Sets the debitMember - An MDX member expression that specifies the debit member used for positive result values. If this argument or creditMember argument is empty, debit/credit processing is not performed.

Parameters:

debitMember - the debitMember to set

getCreditMember

java.lang.String getCreditMember()

Returns:

the creditMember

setCreditMember

void setCreditMember(java.lang.String creditMember)

Sets the creditMember - An MDX member expression that specifies the credit member used for negative and offsetting result values. If this argument or debitMember argument is empty, debit/credit processing is not performed.

Parameters:

creditMember - the creditMember to set

getRange

java.lang.String getRange()

Returns:

the range

setRange

void setRange(java.lang.String range)

Sets the range - MDX set expression that specifies cube region used for allocation.

Parameters:

range - the range to set

getExcludedRange

java.lang.String getExcludedRange()

Returns:

the excludedRange

setExcludedRange

void setExcludedRange(java.lang.String excludedRange)

Sets the execludedRange - MDX set expression specifying a subset of range that will be used to calculate allocated values but will not be written to. If this argument is empty, then no members in the range are excluded.

Parameters:

excludedRange - the excludedRange to set

getBasis

java.lang.String getBasis()

Returns:

the basis

setBasis

void setBasis(java.lang.String basis)

Sets the basis - MDX tuple expression specifying the Basis location. This argument may be empty if the allocationMethod is SPREAD and spreadSkipOption is 0, since it will be ignored in that case.

Parameters:

basis - the basis to set

getBasisTimeSpan

java.lang.String getBasisTimeSpan()

Returns:

the basisTimeSpan

setBasisTimeSpan

void setBasisTimeSpan(java.lang.String basisTimeSpan)

Sets the basisTimeSpan - MDX tuple expression specifying time periods to consider for basis. This argument in combination with setBasisTimeSpanOption(long) determines basis to be used for allocation.

Parameters:

basisTimeSpan - the basisTimeSpan to set

getBasisTimeSpanOption

long getBasisTimeSpanOption()

Returns:

the basisTimeSpanOption

setBasisTimeSpanOption

void setBasisTimeSpanOption(long basisTimeSpanOption)

Sets the basisTimeSpanOption - Option to specify how basis is computed across time periods specified in setBasisTimeSpan(String). It can have one of the following values: ESS_ASO_ALLOCATION_TIMESPAN_SPLIT_BASIS - Process basis value for each time period individually. ESS_ASO_ALLOCATION_TIMESPAN_COMBINE_BASIS - Combine basis value across time periods in basisTimeSpan and use the combined basis for allocation.

Parameters:

basisTimeSpanOption - the basisTimeSpanOption to set

getAllocationMethod

long getAllocationMethod()

Returns:

the allocationMethod

setAllocationMethod

void setAllocationMethod(long allocationMethod)

Sets the allocationMethod - Allocation method to use. You can use one of the following options. ESS_ASO_ALLOCATION_METHOD_SHARE ESS_ASO_ALLOCATION_METHOD_SPREAD

Parameters:

allocationMethod - the allocationMethod to set

getSpreadSkipOption

long getSpreadSkipOption()

Returns:

the spreadSkipOption

setSpreadSkipOption

void setSpreadSkipOption(long spreadSkipOption)

Sets the spreadSkipOption - When allocationMethod is ESS_ASO_ALLOCATION_METHOD_SHARE, this argument must be 0. When allocationMethod is ESS_ASO_ALLOCATION_METHOD_SPREAD, this option tells which basis values should be skipped. You can specify zero or more of the following options. ESS_ASO_ALLOCATION_SPREAD_SKIPMISSING ESS_ASO_ALLOCATION_SPREAD_SKIPZERO ESS_ASO_ALLOCATION_SPREAD_SKIPNEGATIVE These are bitwise arguments intended to be ordered together. For instance, if the user wants to skip both zero and missing values, they should use as the argument: ESS_ASO_ALLOCATION_OPTION_SKIPMISSING | ESS_ASO_ALLOCATION_OPTION_SKIPZERO

Parameters:

spreadSkipOption - the spreadSkipOption to set

getZeroAmountOption

long getZeroAmountOption()

Returns:

the zeroAmountOption

setZeroAmountOption

void setZeroAmountOption(long zeroAmountOption)

Sets the zeroAmountOption - This option tells Essbase what to do when an Amount value (the value to be allocated) is either zero or missing. ESS_ASO_ALLOCATION_ZEROAMT_DEFAULT - allocate zero values ESS_ASO_ALLOCATION_ZEROAMT_NEXTAMT - skip to the next Amount value ESS_ASO_ALLOCATION_ZEROAMT_ABORT - cancel the whole allocation

Parameters:

zeroAmountOption - the zeroAmountOption to set

getZeroBasisOption

long getZeroBasisOption()

Returns:

the zeroBasisOption

setZeroBasisOption

void setZeroBasisOption(long zeroBasisOption)

Sets the zeroBasisOption - When the specified allocationMethod is ESS_ASO_ALLOCATION_METHOD_SHARE, then this argument tells Essbase what to do when the sum of all Basis values is zero. However, if the specified allocationMethod is ESS_ASO_ALLOCATION_METHOD_SPREAD, then this argument tells Essbase what to do when all of the Basis values have been skipped. You must specify one of the following options. ESS_ASO_ALLOCATION_ZEROBASIS_NEXTAMT - skip to the next Amount value ESS_ASO_ALLOCATION_ZEROBASIS_ABORT - cancel the whole allocation Note that if Essbase encounters any other unexpected errors besides the two mentioned above, it will always cancel the whole allocation regardless of what this argument says.

Parameters:

zeroBasisOption - the zeroBasisOption to set

getNegativeBasisOption

long getNegativeBasisOption()

Returns:

the negativeBasisOption

setNegativeBasisOption

void setNegativeBasisOption(long negativeBasisOption)

Sets negativeBasisOption - If the specified allocationMethod is ESS_ASO_ALLOCATION_METHOD_SHARE, then you can specify exactly one of the following options to tell Essbase what to do when a negative Basis value is encountered. See the functional spec for more detailed explanation on behavior. ESS_ASO_ALLOCATION_NEGBASIS_DEFAULT - default behavior ESS_ASO_ALLOCATION_NEGBASIS_NEXTAMT - skip to next Amt value ESS_ASO_ALLOCATION_NEGBASIS_ABORT - cancel the allocation ESS_ASO_ALLOCATION_NEGBASIS_ABS - use absolute value ESS_ASO_ALLOCATION_NEGBASIS_MISSING - treat it as #missing ESS_ASO_ALLOCATION_NEGBASIS_ZERO - treat it as a zero When allocationMethod is ESS_ASO_ALLOCATION_METHOD_SPREAD, then only the first three options are valid.

Parameters:

negativeBasisOption - the negativeBasisOption to set

getRoundMethod

long getRoundMethod()

Returns:

the roundMethod

setRoundMethod

void setRoundMethod(long roundMethod)

Sets the roundMethod - Rounding method to use for rounding allocated values. The options available are: ESS_ASO_ALLOCATION_ROUND_NONE - No rounding performed. ESS_ASO_ALLOCATION_ROUND_DISCARDERRORS - Perform rounding, but discard rounding errors. ESS_ASO_ALLOCATION_ROUND_ERRORSTOHIGHEST - Rounding errors are added to the highest allocated value. ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOWEST - Rounding errors are added to the lowest allocated value. ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOCATION - Rounding errors are added to a specific location given by roundToLocation.

Parameters:

roundMethod - the roundMethod to set

getRoundDigits

java.lang.String getRoundDigits()

Returns:

the roundDigits

setRoundDigits

void setRoundDigits(java.lang.String roundDigits)

Sets the roundDigits - If the roundMethod is ESS_ASO_ALLOCATION_ROUND_NONE, then this must be empty. Otherwise, you must specify this parameter as a string that is an MDX numeric value expression. Essbase supports maximum of 19 decimal places and hence any value above this is ineffective. Values outside the range[0,100] are considered invalid and no rounding is performed. Values '0' or '-1' will round values to 0 decimal places.

Parameters:

roundDigits - the roundDigits to set. Acceptable value is in range of [0, 100].

getRoundToLocation

java.lang.String getRoundToLocation()

Returns:

the roundToLocation

setRoundToLocation

void setRoundToLocation(java.lang.String roundToLocation)

Sets the roundToLocation - If the roundMethod is anything besides ESS_ASO_ALLOCATION_ROUND_ERRORSTOLOCATION, then this must be empty. Otherwise, this is an MDX tuple expression specifying where rounding errors should be written to.

Parameters:

roundToLocation - the roundToLocation to set

getGroupID

long getGroupID()

Returns:

the groupID

setGroupID

void setGroupID(long groupID)

Sets the groupID - The groupID refers to the Rule Set that this allocation is a part of. The groupID is used to export allocated/calculated data for a batch to GL tables. Data calculated during execution will be written a load buffer corresponding to groupID, in addition to committing data to cube. If this functionality is not desired, user should pass in 0. If the value is greater than 0, this feature is turned on.

Parameters:

groupID - the groupID to set

getRuleID

long getRuleID()

Returns:

the ruleID

setRuleID

void setRuleID(long ruleID)

The rule ID used to identify the information (rule name, rule description) related to this allocation rule.

Parameters:

ruleID - the rule ID to set

getDataloadOption

long getDataloadOption()

Returns:

the dataloadOption

setDataloadOption

void setDataloadOption(long dataloadOption)

The dataloadOption can have values IEssCube.ESS_ASO_DATA_LOAD_BUFFER_STORE_DATA, IEssCube.ESS_ASO_DATA_LOAD_BUFFER_ADD_DATA or IEssCube.ESS_ASO_DATA_LOAD_BUFFER_SUBTRACT_DATA

Parameters:

dataloadOption - the dataloadOption to set

setAmountInfo

void setAmountInfo(java.lang.String amount,
                   java.lang.String amountContext,
                   java.lang.String amountTimeSpan,
                   long zeroAmountOption)

Sets all amount related parameters.

Parameters:

amount - The amount value.

amountContext - The amount context.

amountTimeSpan - The amount of time span.

zeroAmountOption - The zero amount option.

setBasisInfo

void setBasisInfo(java.lang.String basis,
                  java.lang.String basisTimeSpan,
                  long basisTimeSpanOption,
                  long zeroBasisOption,
                  long negativeBasisOption)

Sets all basis related parameters.

Parameters:

basis - The basis.

basisTimeSpan - The base time span.

basisTimeSpanOption - The base time option

zeroBasisOption - The zero basis option.

negativeBasisOption - The negative basis option.

setTargetInfo

void setTargetInfo(java.lang.String target,
                   java.lang.String targetTimeSpan,
                   long targetTimeSpanOption)

Sets all the target related parameters.

Parameters:

target - The target name.

targetTimeSpan - The target time span.

targetTimeSpanOption - The target time span option.

setRoundingInfo

void setRoundingInfo(long roundMethod,
                     java.lang.String roundDigits,
                     java.lang.String roundToLocation)

Sets all the rounding related parameters.

Parameters:

roundMethod - The round method.

roundDigits - The round digits.

roundToLocation - The location to be rounded to.

performAllocation

boolean performAllocation(boolean verifyOnly,
                          java.util.List outErrorsAndWarnings)
                   throws com.essbase.api.base.EssException

Performs the allocation on a Essbase ASO(Aggregate Storage outline) cube. Before calling this API, set the necessary values, using the set methods available in this class. Note, this operation is not applicable/supported on a Block storage database.

This allocation operation could result in any of the below cases: 1) Succeeds without any warnings: In this scenario, this operation will return true and outErrorsAndWarnings will not have any messages added to your outErrorsAndWarnings object.

2) Executes, but has warning(s): In this scenario, this operation will return false, indicating the operation was executed, but has warning(s) which will be returned to you, by appending to your outErrorsAndWarnings object. Each warning message element within your outErrorsAndWarnings list is of type, EssPerformAllocationError

3) Fails with Errors (may also have warnings additionally): This will result in an EssException being thrown containing the error message from Essbase. The outErrorsAndWarnings list will be populated with the errors (and warnings if any). If there are no errors added to your outErrorsAndWarnings object, then the exception occurred may be due to other reasons like for instance, failing to connect to Essbase when trying to perform this allocation operation. In such a case, the EssException message will clearly reflect the appropriate Essbase Error code and error message.

Refer Allocation.java sample for an example usage.

Parameters:

verifyOnly - This is a flag to validate the allocation parameters without performing allocation. If it is set to true, the allocation parameters are validated only. If it is false, the allocation is verified and executed on the associated Essbase cube.

outErrorsAndWarnings - This is output object for collecting the errors and/or warnings returned by Essbase. This object needs to be instantiated by the caller so that Essbase can populate the messages (if any). Note that, if this List object is non-empty, this operation will be appending the returned errors. So, if you are reusing your outErrorsAndWarnings object and like to have the errors/warnings corresponding to this particular call only, please make sure that you clear your list before invoking this method. The list will contain objects of type EssPerformAllocationError only.

Returns:

true - if allocation was successful; false - if allocation happened with warnings

Throws:

com.essbase.api.base.EssException - when Essbase fails to perform the allocation on the cube. Refer case (3) mentioned above for more details.

Since:

11.1.2

See Also:

EssPerformAllocationError