Package com.microstrategy.web.app.beans

Interface SubscriptionContactsBrowserBean

All Superinterfaces:

AppComponent, ContactsBrowserBean, EnumWebPersistableState, Persistable, RequestPersistable, Transformable, WebComponent

public interface SubscriptionContactsBrowserBean
extends ContactsBrowserBean

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	DISPLAY_MODE_PERSONAL_DIRECTORY
static int	DISPLAY_MODE_SHARED_DIRECTORY

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.web.app.beans.ContactsBrowserBean

CONTACT_SEPARATOR, CONTACT_SEPARATOR_REGEXP, SELECTIONS_SEPARATOR

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
int	getDisplayMode()	Returns the display mode of the contact browser bean.
java.lang.String	getEditorErrorMessage()	Returns any error message that may have occured during the editor's event processing
SimpleList	getPersonalLocations()	Returns a SimpleList collection of WebSubscriptionAddress objects that are available for the current subscriber
SimpleList	getSelectedContactElements()
SimpleList	getSelectedContactElements(int destType)	Returns a SimpleList collection of ContactCartElement objects for a given destination type
SubscriptionBean	getSubscriptionBean()	returns the associated subscription bean.
boolean	isContactBrowserOpen()	returns true if the editing mode is contact browsing.
void	setDisplayMode(int mode)	Sets the display mode for this bean.
void	setSubscriptionBeanName(java.lang.String beanName)	Sets the name of the SubscriptionBean whose WebSubscription is currently being modified/edited.

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.web.app.beans.ContactsBrowserBean

getAvailableContacts, getBlockBegin, getBlockCount, getSearchString, setBlockBegin, setBlockCount, setSearchPattern

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

DISPLAY_MODE_SHARED_DIRECTORY

static final int DISPLAY_MODE_SHARED_DIRECTORY

See Also:

Constant Field Values

DISPLAY_MODE_PERSONAL_DIRECTORY

static final int DISPLAY_MODE_PERSONAL_DIRECTORY

See Also:

Constant Field Values

Method Detail

getPersonalLocations

SimpleList getPersonalLocations()
                         throws WebObjectsException

Returns a SimpleList collection of WebSubscriptionAddress objects that are available for the current subscriber

Returns:

a SimpleList collection

Throws:

WebObjectsException

getSelectedContactElements

SimpleList getSelectedContactElements(int destType)

Returns a SimpleList collection of ContactCartElement objects for a given destination type

Parameters:

destType - from EnumDSSXMLNCSEmailDestinationType

Returns:

a SimpleList collection

getSelectedContactElements

SimpleList getSelectedContactElements()

getSubscriptionBean

SubscriptionBean getSubscriptionBean()
                              throws WebBeanException

returns the associated subscription bean.

Throws:

WebBeanException

isContactBrowserOpen

boolean isContactBrowserOpen()

returns true if the editing mode is contact browsing.

setSubscriptionBeanName

void setSubscriptionBeanName(java.lang.String beanName)

Sets the name of the SubscriptionBean whose WebSubscription is currently being modified/edited.

getEditorErrorMessage

java.lang.String getEditorErrorMessage()

Returns any error message that may have occured during the editor's event processing

getDisplayMode

int getDisplayMode()

Returns the display mode of the contact browser bean. The possible values of the displayMode are: DISPLAY_MODE_PERSONAL_DIRECTORY and DISPLAY_MODE_SHARED_DIRECTORY

Returns:

an int representing the display mode

setDisplayMode

void setDisplayMode(int mode)

Sets the display mode for this bean. The possible values of the displayMode are: DISPLAY_MODE_PERSONAL_DIRECTORY and DISPLAY_MODE_SHARED_DIRECTORY

Parameters:

mode -