Package com.microstrategy.web.objects.rw

Interface RWElementSelector

All Superinterfaces:

KeyedObject, RWControl, RWSelectorControl

All Known Subinterfaces:

RWAttributeSelector, RWConditionSelector, RWTransactionSelector

public interface RWElementSelector
extends RWSelectorControl

Represents element selector control.

Since:

MicroStrategy Web 8.1.0

Field Summary

Fields inherited from interface com.microstrategy.web.objects.rw.RWSelectorControl

AUTO_SYNC, NO_AUTO_SYNC

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAlias()	Get selector Alias.
WebAttributeForms	getControlAttributeForms()	Return the custom forms available for this control
java.lang.String	getControlAttributeFormsDelimiter()	Return the delimiter used for custom form display
int	getControlAttributeFormsDisplayType()	Return the way forms should be displayed
int	getDataFilterMode()	REturn the data filter mode for all CGBs surrounding this control's targets
java.lang.String	getDataSourcesXML()	Returns the data sources xml
RWTransactionSelector	getDDICTarget(int i)	Returns i-th DDIC target
int	getDDICTargetCount()	Returns number of DDIC targets
int	getMetricConditionalityType()
WebSorts	getSorts()	Return collection of sorts applied to elements of this selector
WebObjectInfo	getSource()	Returns control source
boolean	isInList()	Return boolean specifying whether the control's element selection is inclusive
void	setControlAttributeForms(java.util.List<WebAttributeForm> forms)	Specify the forms to be used when custom forms are enabled
void	setControlAttributeFormsDelimiter(java.lang.String delimeter)	Specify delimiter for custom form display of control
void	setControlAttributeFormsDisplayType(int type)	Specify the way forms should be displayed for this control
void	setDataFilterMode(int mode)	Sets the data filter mode for all CGBs surrounding this control's targets
void	setIsInList(boolean isInList)	Specify whether this control's element selection should be inclusive
void	setMetricConditionalityType(int metricConditionality)
void	setSource(WebObjectInfo sourceObject)	Sets control source

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.web.objects.rw.RWControl

addDatasetTarget, addDatasetTarget, addPlaceHolderTarget, addTarget, addTarget, canMultiSelect, canUseSubtotals, generateGridControlFormatDelta, getDatasetTargets, getGroupByTargetKeys, getInfoWindowTarget, getKey, getKeyContext, getParent, getPlaceHolderGroupByTargetKeys, getPlaceHolderTargets, getSubtotals, getTarget, getTargetCount, getTargets, getTransactionAction, getType, hasDatasetTarget, hasTarget, hasTargets, isShowAll, isTopMost, isUnset, removeAllDatasetTargets, removeDatasetTarget, removePlaceHolderTarget, removeTarget, setInfoWindowTarget, setShowAll, setTopMost

Methods inherited from interface com.microstrategy.web.objects.rw.RWSelectorControl

createElements, getAutoSyncMode, getCurrentElements, getSduc, getTargetType, getUnsetCount, getUnsetStatus, setAutoSyncMode, setTargetType, setUnsetStatus

Method Detail

setSource

void setSource(WebObjectInfo sourceObject)
        throws WebObjectsException

Sets control source

Parameters:

sourceObject - source object

Throws:

WebObjectsException

getSource

WebObjectInfo getSource()

Returns control source

Returns:

control source

setDataFilterMode

void setDataFilterMode(int mode)

Sets the data filter mode for all CGBs surrounding this control's targets

Parameters:

mode - int from EnumWebControlDataFilterModes

getDataFilterMode

int getDataFilterMode()

REturn the data filter mode for all CGBs surrounding this control's targets

Returns:

int from EnumWebControlDataFilterModes

setIsInList

void setIsInList(boolean isInList)
          throws WebObjectsException

Specify whether this control's element selection should be inclusive

Parameters:

isInList - boolean true=inclusive, false=exclusive

Throws:

WebObjectsException

isInList

boolean isInList()
          throws WebObjectsException

Return boolean specifying whether the control's element selection is inclusive

Returns:

boolean true=inclusive, false=exclusive

Throws:

WebObjectsException

setMetricConditionalityType

void setMetricConditionalityType(int metricConditionality)
                          throws WebObjectsException,
                                 java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.IllegalArgumentException

getMetricConditionalityType

int getMetricConditionalityType()

getDataSourcesXML

java.lang.String getDataSourcesXML()

Returns the data sources xml

Returns:

data sources xml

setControlAttributeFormsDelimiter

void setControlAttributeFormsDelimiter(java.lang.String delimeter)
                                throws WebObjectsException

Specify delimiter for custom form display of control

Parameters:

delimeter - String containing the delimiter

Throws:

WebObjectsException

getControlAttributeFormsDelimiter

java.lang.String getControlAttributeFormsDelimiter()

Return the delimiter used for custom form display

Returns:

String custom form display delimiter

setControlAttributeFormsDisplayType

void setControlAttributeFormsDisplayType(int type)
                                  throws WebObjectsException

Specify the way forms should be displayed for this control

Parameters:

type - int from EnumDSSXMLControlAttributeFormDisplayOption

Throws:

WebObjectsException

getControlAttributeFormsDisplayType

int getControlAttributeFormsDisplayType()

Return the way forms should be displayed

Returns:

int from EnumDSSXMLControlAttributeFormDisplayOption

setControlAttributeForms

void setControlAttributeForms(java.util.List<WebAttributeForm> forms)
                       throws WebObjectsException

Specify the forms to be used when custom forms are enabled

Parameters:

forms - List containing String forms

Throws:

WebObjectsException

getControlAttributeForms

WebAttributeForms getControlAttributeForms()

Return the custom forms available for this control

Returns:

List containing String forms

getSorts

WebSorts getSorts()

Return collection of sorts applied to elements of this selector

Returns:

WebSorts containing WebSort objects

getDDICTargetCount

int getDDICTargetCount()

Returns number of DDIC targets

Returns:

number of DDIC targets

getDDICTarget

RWTransactionSelector getDDICTarget(int i)

Returns i-th DDIC target

Parameters:

i - index

Returns:

i-th DDIC target

getAlias

java.lang.String getAlias()

Get selector Alias. Note that this is for the case that alias of attribute in dataset can be "renamed" with alias. If it happens, the control name which was set to previous alias won't be able to be found anymore. The newly introduced alias property is to serve the purpose

Returns:

alias