com.essbase.api.metadata

Interface IEssVaryingAttributeQuery

All Superinterfaces:

IEssAttributeQuery, IEssBaseObject

public interface IEssVaryingAttributeQuery
extends IEssAttributeQuery

Represents the criteria for querying on varying attributes.

Author:

Balaji Sundaresan

Field Summary

Fields

Modifier and Type	Field and Description
static short	INDEP_MEMBERSET_TYPE_MEMBER_NAME Indicates the Set of Members specified as Member Names.
static short	INDEP_MEMBERSET_TYPE_MEMBER_REF Indicates the Set of Members specified as IEssMember object references.

Fields inherited from interface com.essbase.api.metadata.IEssAttributeQuery

MBR_TYPE_ATTRIBUTE_DIMENSION, MBR_TYPE_ATTRIBUTE_MEMBER, MBR_TYPE_ATTRIBUTED_MEMBER, MBR_TYPE_BASE_DIMENSION, MBR_TYPE_BASE_MEMBER, MBR_TYPE_INVALID_MEMBER, MBR_TYPE_STANDARD_DIMENSION, MBR_TYPE_STANDARD_MEMBER, OP_ALL, OP_EQ, OP_GT, OP_GTE, OP_LT, OP_LTE, OP_NEQ, OP_TYPEOF

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttributeDimension() Returns the Attribute Dimension on which varying attribute query would be based on.
IEssIndepMbrsPerspective	getIndepMbrsPerspective() Returns the perspective (if any) to query varying attributes.
void	setAttributeDimension(IEssMember dimension) Specify the attribute dimension on which varying attribute query must be based on.
void	setAttributeDimension(java.lang.String dimensionName) Specify the attribute dimension on which varying attribute query must be based on.
void	setIndepMbrsPerspective(IEssIndepMbrsPerspective indepMbrsSet) Specify the perspective for querying varying attributes which is a set of Independent Members.

Methods inherited from interface com.essbase.api.metadata.IEssAttributeQuery

getAttributeValue, getInputMember, getInputMemberType, getMaxMemberCount, getOperationType, getOutputMemberType, getStartMemberIndex, set, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setInputMember, setInputMember, setMemberRange

Field Detail

INDEP_MEMBERSET_TYPE_MEMBER_REF

static final short INDEP_MEMBERSET_TYPE_MEMBER_REF

Indicates the Set of Members specified as IEssMember object references.

See Also:

Constant Field Values

INDEP_MEMBERSET_TYPE_MEMBER_NAME

static final short INDEP_MEMBERSET_TYPE_MEMBER_NAME

Indicates the Set of Members specified as Member Names.

See Also:

Constant Field Values

Method Detail

setAttributeDimension

void setAttributeDimension(java.lang.String dimensionName)

Specify the attribute dimension on which varying attribute query must be based on.

Parameters:

dimensionName - Attribute dimension name.

setAttributeDimension

void setAttributeDimension(IEssMember dimension)

Specify the attribute dimension on which varying attribute query must be based on.

Parameters:

dimension - Reference to the Attribute dimension object.

getAttributeDimension

java.lang.Object getAttributeDimension()

Returns the Attribute Dimension on which varying attribute query would be based on.

The attribute dimension object if exists, will be either a instance of IEssMember or String; otherwise, returns null.

Returns:

attribute dimension.

setIndepMbrsPerspective

void setIndepMbrsPerspective(IEssIndepMbrsPerspective indepMbrsSet)

Specify the perspective for querying varying attributes which is a set of Independent Members.

Parameters:

indepMbrsSet - Independent Members Perspective.

getIndepMbrsPerspective

IEssIndepMbrsPerspective getIndepMbrsPerspective()

Returns the perspective (if any) to query varying attributes.

Returns:

Independent Members Perspective.