Package com.appliedolap.essbase

Class EssBatchOutlineEdit.MemberAction

java.lang.Object

com.appliedolap.essbase.EssBatchOutlineEdit.Action

com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction

Enclosing class:

EssBatchOutlineEdit

public static class EssBatchOutlineEdit.MemberAction
extends EssBatchOutlineEdit.Action

An action carrying a mbrInfo block - add, addOrUpdate, update.

Method Summary

Modifier and Type	Method	Description
EssBatchOutlineEdit.MemberAction	after(String sibling)	Puts the member right after the given sibling.
EssBatchOutlineEdit.MemberAction	alias(String alias)	An alias in the Default table.
EssBatchOutlineEdit.MemberAction	alias(String aliasTable, String alias)
EssBatchOutlineEdit.MemberAction	attribute(String name, Object value)	Sets an attribute the builder does not otherwise expose.
EssBatchOutlineEdit.MemberAction	byMemberId()	Says that the member names in this action are actually member ids.
EssBatchOutlineEdit.MemberAction	comment(String comment)
EssBatchOutlineEdit.MemberAction	consolidation(EssBatchOutlineEdit.Consolidation consolidation)
EssBatchOutlineEdit.MemberAction	dataStorage(EssBatchOutlineEdit.DataStorage storage)
EssBatchOutlineEdit.MemberAction	expense(boolean expense)	Expense reporting, for an accounts member.
EssBatchOutlineEdit.MemberAction	formatString(String formatString)
EssBatchOutlineEdit.MemberAction	formula(String formula)
EssBatchOutlineEdit.MemberAction	hierarchyType(EssBatchOutlineEdit.HierarchyType type)
EssBatchOutlineEdit.MemberAction	prototype(String member)	The member this one shares data with.
EssBatchOutlineEdit.MemberAction	skip(EssBatchOutlineEdit.Skip skip)
EssBatchOutlineEdit.MemberAction	solveOrder(int solveOrder)
EssBatchOutlineEdit.MemberAction	timeBalance(EssBatchOutlineEdit.TimeBalance timeBalance)
EssBatchOutlineEdit.MemberAction	twoPassCalc(boolean twoPass)	Two-pass calculation, which is an attribute of mbrInfo rather than an element.
EssBatchOutlineEdit.MemberAction	uda(String uda)	Adds a UDA, replacing whatever the member had.
EssBatchOutlineEdit.MemberAction	uda(String uda, boolean replace, boolean remove)

Methods inherited from class java.lang.Object

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

Method Details

attribute

public EssBatchOutlineEdit.MemberAction attribute(String name,
 Object value)

Description copied from class: EssBatchOutlineEdit.Action

Sets an attribute the builder does not otherwise expose.

Overrides:

attribute in class EssBatchOutlineEdit.Action

Parameters:

name - the attribute name, as the schema spells it

value - the value; null removes the attribute

byMemberId

public EssBatchOutlineEdit.MemberAction byMemberId()

Description copied from class: EssBatchOutlineEdit.Action

Says that the member names in this action are actually member ids.

What EPM Cloud's exported documents use throughout: every thisMbr is a Planning GUID rather than a name. Rarely what you want against Essbase directly.

Overrides:

byMemberId in class EssBatchOutlineEdit.Action

after

public EssBatchOutlineEdit.MemberAction after(String sibling)

Description copied from class: EssBatchOutlineEdit.Action

Puts the member right after the given sibling.

Without it a new member goes first among its parent's children, not last - verified against 21c, where adding Jan, Feb and Mar under Q1 in that order, none of them placed, leaves Mar, Feb, Jan. To add members in order, pass each one the sibling added just before it. Dimensions are the exception: a dimAdd without a sibling did go after the others.

Overrides:

after in class EssBatchOutlineEdit.Action

Parameters:

sibling - the member, under the same parent, that this one should follow

consolidation

public EssBatchOutlineEdit.MemberAction consolidation(EssBatchOutlineEdit.Consolidation consolidation)

dataStorage

public EssBatchOutlineEdit.MemberAction dataStorage(EssBatchOutlineEdit.DataStorage storage)

hierarchyType

public EssBatchOutlineEdit.MemberAction hierarchyType(EssBatchOutlineEdit.HierarchyType type)

timeBalance

public EssBatchOutlineEdit.MemberAction timeBalance(EssBatchOutlineEdit.TimeBalance timeBalance)

skip

public EssBatchOutlineEdit.MemberAction skip(EssBatchOutlineEdit.Skip skip)

solveOrder

public EssBatchOutlineEdit.MemberAction solveOrder(int solveOrder)

formula

public EssBatchOutlineEdit.MemberAction formula(String formula)

comment

public EssBatchOutlineEdit.MemberAction comment(String comment)

formatString

public EssBatchOutlineEdit.MemberAction formatString(String formatString)

prototype

public EssBatchOutlineEdit.MemberAction prototype(String member)

The member this one shares data with. How a shared member is expressed in a non-unique-name outline, where EssBatchOutlineEdit.DataStorage.SHARED is ignored.

alias

public EssBatchOutlineEdit.MemberAction alias(String alias)

An alias in the Default table.

alias

public EssBatchOutlineEdit.MemberAction alias(String aliasTable,
 String alias)

uda

public EssBatchOutlineEdit.MemberAction uda(String uda)

Adds a UDA, replacing whatever the member had.

uda

public EssBatchOutlineEdit.MemberAction uda(String uda,
 boolean replace,
 boolean remove)

Parameters:

replace - whether this replaces the member's existing UDAs

remove - whether to remove this UDA instead; wins over replace if both are set

twoPassCalc

public EssBatchOutlineEdit.MemberAction twoPassCalc(boolean twoPass)

Two-pass calculation, which is an attribute of mbrInfo rather than an element.

expense

public EssBatchOutlineEdit.MemberAction expense(boolean expense)

Expense reporting, for an accounts member.