AttributeBean
implements ObjectBean| com.microstrategy.web.beans.AttributeBean |
Class Overview
This bean is used for browsing attribute elements. By specifying the attribute id or name,
this bean will collect the elements belonging to this attribute. The range of the elements
is controlled by blockBegin and blockCount defined in super interface ObjectBean.
User can further apply restriction about the elements retrieved by setting dimension, filter,
browse path, search pattern through this interface. The elements retrieved are returned in getAttributeElements().
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.microstrategy.utils.serialization.EnumWebPersistableState
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract WebElements | getAttributeElements() | ||||||||||
| abstract WebBrowsePath | getBrowsePath() | ||||||||||
| abstract String[] |
getClientFormPatterns()
Get the Client Form patterns
| ||||||||||
| abstract boolean | getCollectForms() | ||||||||||
| abstract String | getControlKey() | ||||||||||
| abstract String | getDataSetID() | ||||||||||
| abstract String | getDimensionID() | ||||||||||
| abstract int |
getElementSourceFlags()
Get the element source flag which will be used in getElement call.
| ||||||||||
| abstract WebFilter | getFilter() | ||||||||||
| abstract String | getMessageID() | ||||||||||
| abstract String | getRawInput() | ||||||||||
| abstract WebAttributeForm[] | getSearchForms() | ||||||||||
| abstract boolean | getSearchMatchCase() | ||||||||||
| abstract String | getSearchPattern() | ||||||||||
| abstract String | getTemplateNodeKey() | ||||||||||
| abstract boolean |
getUseBrowseForm()
Get the useBrowseForm flag which will be used in getElement call.
| ||||||||||
| abstract boolean |
getUseClientForms()
Get the useClientForms
| ||||||||||
| abstract void |
setClientFormPatterns(String[] clientFormPatterns)
Get the ClientFormPatterns
| ||||||||||
| abstract void | setCollectForms(boolean value) | ||||||||||
| abstract void | setControlKey(String controlKey) | ||||||||||
| abstract void | setDataSetID(String dataSet) | ||||||||||
| abstract void | setDataSources(String dataSources) | ||||||||||
| abstract void | setDimensionID(String dim) | ||||||||||
| abstract void |
setElementSourceFlags(int flags)
The flags is used to control the Element ID Format for getElement call,
if it is set to 1, it will get terse id format.
| ||||||||||
| abstract void | setMessageID(String message) | ||||||||||
| abstract void | setRawInput(String rawInput) | ||||||||||
| abstract void | setSearchForms(WebAttributeForm[] forms) | ||||||||||
| abstract void | setSearchMatchCase(boolean match) | ||||||||||
| abstract void | setSearchPattern(String pattern) | ||||||||||
| abstract void | setTemplateNodeKey(String templateNodeKey) | ||||||||||
| abstract void |
setUseBrowseForm(boolean useBrowseForm)
The useBrowseForm is used to control the Element forms for getElement call,
if it is set to 1, it will get the browse form.
| ||||||||||
| abstract void |
setUseClientForms(boolean useClientForms)
useClientForms is used to control whether we use search forms sending from client rather than populate it from iserver
if it is set to true, it will use client forms
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.serialization.Persistable
| |||||||||||
|
From interface
com.microstrategy.web.beans.ObjectBean
| |||||||||||
|
From interface
com.microstrategy.web.beans.RequestPersistable
| |||||||||||
|
From interface
com.microstrategy.web.beans.Transformable
| |||||||||||
|
From interface
com.microstrategy.web.beans.WebBean
| |||||||||||
|
From interface
com.microstrategy.web.beans.WebComponent
| |||||||||||
Public Methods
public abstract String[] getClientFormPatterns ()
Get the Client Form patterns
public abstract boolean getCollectForms ()
public abstract String getControlKey ()
public abstract String getDataSetID ()
public abstract String getDimensionID ()
public abstract int getElementSourceFlags ()
Get the element source flag which will be used in getElement call.
public abstract String getMessageID ()
public abstract String getRawInput ()
public abstract boolean getSearchMatchCase ()
public abstract String getSearchPattern ()
public abstract String getTemplateNodeKey ()
public abstract boolean getUseBrowseForm ()
Get the useBrowseForm flag which will be used in getElement call.
public abstract boolean getUseClientForms ()
Get the useClientForms
public abstract void setClientFormPatterns (String[] clientFormPatterns)
Get the ClientFormPatterns
public abstract void setCollectForms (boolean value)
public abstract void setControlKey (String controlKey)
public abstract void setDataSetID (String dataSet)
public abstract void setDataSources (String dataSources)
public abstract void setDimensionID (String dim)
public abstract void setElementSourceFlags (int flags)
The flags is used to control the Element ID Format for getElement call, if it is set to 1, it will get terse id format.
Parameters
| flags | value is false or true. |
|---|
public abstract void setMessageID (String message)
public abstract void setRawInput (String rawInput)
public abstract void setSearchMatchCase (boolean match)
public abstract void setSearchPattern (String pattern)
public abstract void setTemplateNodeKey (String templateNodeKey)
public abstract void setUseBrowseForm (boolean useBrowseForm)
The useBrowseForm is used to control the Element forms for getElement call, if it is set to 1, it will get the browse form.
Parameters
| useBrowseForm | value is false or true. |
|---|
public abstract void setUseClientForms (boolean useClientForms)
useClientForms is used to control whether we use search forms sending from client rather than populate it from iserver if it is set to true, it will use client forms