oracle.epm.api.model

Class CustomCalcParameters

java.lang.Object

oracle.epm.api.model.CustomCalcParameters

public class CustomCalcParameters
extends java.lang.Object

This object represent the parameters required for a custom calc.

Example call from Groovy:

 /*RTPS: {curYear}*/
 CustomCalcParameters calcParameters = new CustomCalcParameters()
 calcParameters.pov = 'Crossjoin(Crossjoin(Crossjoin(Crossjoin(Crossjoin(
 Crossjoin(Crossjoin({[Jan]},{${mdxParams(rtps.curYear)}}),{[Current]}),
 {[BU Version_1]}),{[No Currency]}),
 {[No Entity]}),{[No Manager]}),{CHILDREN([Total Employees])})'
 calcParameters.script = '([Salary]) := 5000;'
 calcParameters.roundDigits = 2
 operation.getApplication().getCube('HP1_ASO').executeAsoCustomCalculation(calcParameters)
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomCalcParameters.DataLoadOption An enumeration containing a list of valid data load options to be used in custom calc.

Constructor Summary

Constructors

Constructor and Description
CustomCalcParameters() Constructs new instance of this class.

Method Summary

Modifier and Type	Method and Description
CustomCalcParameters	setCreditMember(java.lang.String creditMember) Specifies an MDX member expression indicating the member to which negative result values are written, if double-entry accounting is used.
CustomCalcParameters	setDataLoadOption(CustomCalcParameters.DataLoadOption dataLoadOption) Specifies how the calculated data is handled.
CustomCalcParameters	setDebitMember(java.lang.String debitMember) Specifies an MDX member expression indicating the member to which positive result values are written, if double-entry accounting is used.
CustomCalcParameters	setOffset(java.lang.String offset) Specifies an optional MDX tuple defining the location where an offsetting value is written for each source amount.
CustomCalcParameters	setPov(java.lang.String pov) Specifies an MDX set specifying the region in which the calculation is performed.
CustomCalcParameters	setRoundDigits(int roundDigits) Specifies the number of digits to round.
CustomCalcParameters	setScript(java.lang.String script) Specified the MDX script to be executed.
CustomCalcParameters	setSourceRegion(java.lang.String sourceRegion) Specifies an MDX set specifying the region referred to by the formulas in the script.
CustomCalcParameters	setTarget(java.lang.String target) Specifies an MDX tuple defining the region where results are written.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomCalcParameters

public CustomCalcParameters()

Constructs new instance of this class.

Method Detail

setCreditMember

public CustomCalcParameters setCreditMember(java.lang.String creditMember)

Specifies an MDX member expression indicating the member to which negative result values are written, if double-entry accounting is used.

This parameter is optional. You can specify only stored, level zero members; do not use upper-level members, attribute members, or dynamic calc members.

If credit member or debit member is not specified, debit/credit processing is not performed.

Parameters:

creditMember - member where credit processing is written to

Returns:

a reference to this object

setDataLoadOption

public CustomCalcParameters setDataLoadOption(CustomCalcParameters.DataLoadOption dataLoadOption)

Specifies how the calculated data is handled.

This option specifies if the value should be added, subtracted or set during the execution of the custom calc.

Parameters:

dataLoadOption - data load option

Returns:

a reference to this object

setDebitMember

public CustomCalcParameters setDebitMember(java.lang.String debitMember)

Specifies an MDX member expression indicating the member to which positive result values are written, if double-entry accounting is used.

This parameter is optional. You can specify only stored, level zero members; do not use upper-level members, attribute members, or dynamic calc members.

If credit member or debit member is not specified, debit/credit processing is not performed.

Parameters:

debitMember - member where debit processing is written to

Returns:

a reference to this object

setOffset

public CustomCalcParameters setOffset(java.lang.String offset)

Specifies an optional MDX tuple defining the location where an offsetting value is written for each source amount.

This parameter is optional. You can use only stored, level zero members in the tuple; do not use upper-level members, attribute members, or dynamic calc members.

Parameters:

offset - member where offset value is written to

Returns:

a reference to this object

setPov

public CustomCalcParameters setPov(java.lang.String pov)

Specifies an MDX set specifying the region in which the calculation is performed.

Parameters:

pov - area of calculation

Returns:

a reference to this object

See Also:

setScript(java.lang.String)

setRoundDigits

public CustomCalcParameters setRoundDigits(int roundDigits)

Specifies the number of digits to round.

Parameters:

roundDigits - number of digits to round

Returns:

a reference to this object

setScript

public CustomCalcParameters setScript(java.lang.String script)

Specified the MDX script to be executed.

The script will be executed once for every cross-product in the POV region.

Parameters:

script - custom calc script

Returns:

a reference to this object

setSourceRegion

public CustomCalcParameters setSourceRegion(java.lang.String sourceRegion)

Specifies an MDX set specifying the region referred to by the formulas in the script.

At a minimum, the source region should include all members from the right-hand sides of the assignment statements in the custom calc script.

Parameters:

sourceRegion - source region

Returns:

a reference to this object

See Also:

setScript(java.lang.String)

setTarget

public CustomCalcParameters setTarget(java.lang.String target)

Specifies an MDX tuple defining the region where results are written.

This parameter is optional. You can use only stored, level zero members in the tuple; do not use upper-level members, attribute members, or dynamic calc members.

Parameters:

target - target region

Returns:

a reference to this object