public interface

RWElementSelector

implements RWSelectorControl
com.microstrategy.web.objects.rw.RWElementSelector
Known Indirect Subclasses

Class Overview

Represents element selector control.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.objects.rw.RWSelectorControl
Public Methods
abstract WebAttributeForms getControlAttributeForms()
Return the custom forms available for this control
abstract String getControlAttributeFormsDelimiter()
Return the delimiter used for custom form display
abstract int getControlAttributeFormsDisplayType()
Return the way forms should be displayed
abstract RWTransactionSelector getDDICTarget(int i)
Returns i-th DDIC target
abstract int getDDICTargetCount()
Returns number of DDIC targets
abstract int getDataFilterMode()
REturn the data filter mode for all CGBs surrounding this control's targets
abstract String getDataSourcesXML()
Returns the data sources xml
abstract int getMetricConditionalityType()
abstract WebSorts getSorts()
Return collection of sorts applied to elements of this selector
abstract WebObjectInfo getSource()
Returns control source
abstract boolean isInList()
Return boolean specifying whether the control's element selection is inclusive
abstract void setControlAttributeForms(List<WebAttributeForm> forms)
Specify the forms to be used when custom forms are enabled
abstract void setControlAttributeFormsDelimiter(String delimeter)
Specify delimiter for custom form display of control
abstract void setControlAttributeFormsDisplayType(int type)
Specify the way forms should be displayed for this control
abstract void setDataFilterMode(int mode)
Sets the data filter mode for all CGBs surrounding this control's targets
abstract void setIsInList(boolean isInList)
Specify whether this control's element selection should be inclusive
abstract void setMetricConditionalityType(int metricConditionality)
abstract void setSource(WebObjectInfo sourceObject)
Sets control source
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.rw.RWControl
From interface com.microstrategy.web.objects.rw.RWSelectorControl

Public Methods

public abstract WebAttributeForms getControlAttributeForms ()

Return the custom forms available for this control

Returns
  • List containing String forms

public abstract String getControlAttributeFormsDelimiter ()

Return the delimiter used for custom form display

Returns
  • String custom form display delimiter

public abstract int getControlAttributeFormsDisplayType ()

Return the way forms should be displayed

public abstract RWTransactionSelector getDDICTarget (int i)

Returns i-th DDIC target

Parameters
i index
Returns
  • i-th DDIC target

public abstract int getDDICTargetCount ()

Returns number of DDIC targets

Returns
  • number of DDIC targets

public abstract int getDataFilterMode ()

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

public abstract String getDataSourcesXML ()

Returns the data sources xml

Returns
  • data sources xml

public abstract int getMetricConditionalityType ()

public abstract WebSorts getSorts ()

Return collection of sorts applied to elements of this selector

Returns

public abstract WebObjectInfo getSource ()

Returns control source

Returns
  • control source

public abstract boolean isInList ()

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

Returns
  • boolean true=inclusive, false=exclusive

public abstract void setControlAttributeForms (List<WebAttributeForm> forms)

Specify the forms to be used when custom forms are enabled

Parameters
forms List containing String forms

public abstract void setControlAttributeFormsDelimiter (String delimeter)

Specify delimiter for custom form display of control

Parameters
delimeter String containing the delimiter

public abstract void setControlAttributeFormsDisplayType (int type)

Specify the way forms should be displayed for this control

public abstract void setDataFilterMode (int mode)

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

Parameters
mode int from EnumWebControlDataFilterModes

public abstract void setIsInList (boolean isInList)

Specify whether this control's element selection should be inclusive

Parameters
isInList boolean true=inclusive, false=exclusive

public abstract void setMetricConditionalityType (int metricConditionality)

Throws
IllegalArgumentException
WebObjectsException

public abstract void setSource (WebObjectInfo sourceObject)

Sets control source

Parameters
sourceObject source object