ContactsBrowserBean (Web API 2021)

All Superinterfaces:

AppComponent, EnumWebPersistableState, Persistable, RequestPersistable, Transformable, WebComponent

All Known Subinterfaces:

SubscriptionContactsBrowserBean, UserContactsBrowserBean
```
public interface ContactsBrowserBean
extends AppComponent, RequestPersistable
```
Since:

MicroStrategy Web 9.0.0

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String CONTACT_SEPARATOR

static java.lang.String CONTACT_SEPARATOR_REGEXP

static java.lang.String SELECTIONS_SEPARATOR
- Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
  COMPONENT_POSITION_NOT_INITIALIZED
- Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
  BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`WebSubscriptionContacts`	`getAvailableContacts()`	Returns a `WebSubscriptionContacts` collection of available contacts.
`int`	`getBlockBegin()`	Returns the current block begin value
`int`	`getBlockCount()`	Returns the current block count value
`java.lang.String`	`getSearchString()`	Returns the current search string.
`void`	`setBlockBegin(int blockBegin)`	Sets the block begin to use while fetching the available contacts
`void`	`setBlockCount(int blockCount)`	Sets the block count to use while fetching the available contacts
`void`	`setSearchPattern(java.lang.String searchPattern)`	Sets the search string/pattern to use while fetching the available contacts.

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

- Field Detail
  - SELECTIONS_SEPARATOR
```
static final java.lang.String SELECTIONS_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - CONTACT_SEPARATOR
```
static final java.lang.String CONTACT_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - CONTACT_SEPARATOR_REGEXP
```
static final java.lang.String CONTACT_SEPARATOR_REGEXP
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getAvailableContacts
```
WebSubscriptionContacts getAvailableContacts()
```
    Returns a WebSubscriptionContacts collection of available contacts.
  - getSearchString
```
java.lang.String getSearchString()
```
    Returns the current search string.
  - getBlockBegin
```
int getBlockBegin()
```
    Returns the current block begin value
  - getBlockCount
```
int getBlockCount()
```
    Returns the current block count value
  - setBlockBegin
```
void setBlockBegin(int blockBegin)
```
    Sets the block begin to use while fetching the available contacts
    
    Parameters:
    
    blockBegin -
  - setBlockCount
```
void setBlockCount(int blockCount)
```
    Sets the block count to use while fetching the available contacts
    
    Parameters:
    
    blockCount -
  - setSearchPattern
```
void setSearchPattern(java.lang.String searchPattern)
```
    Sets the search string/pattern to use while fetching the available contacts.
    
    Parameters:
    
    searchPattern -