public interface

SubscriptionContactsBrowserBean

implements ContactsBrowserBean
com.microstrategy.web.app.beans.SubscriptionContactsBrowserBean

Summary

Constants
int DISPLAY_MODE_PERSONAL_DIRECTORY
int DISPLAY_MODE_SHARED_DIRECTORY
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.ContactsBrowserBean
Public Methods
abstract int getDisplayMode()
Returns the display mode of the contact browser bean.
abstract String getEditorErrorMessage()
Returns any error message that may have occured during the editor's event processing
abstract SimpleList getPersonalLocations()
Returns a SimpleList collection of WebSubscriptionAddress objects that are available for the current subscriber
abstract SimpleList getSelectedContactElements()
abstract SimpleList getSelectedContactElements(int destType)
Returns a SimpleList collection of ContactCartElement objects for a given destination type
abstract SubscriptionBean getSubscriptionBean()
returns the associated subscription bean.
abstract boolean isContactBrowserOpen()
returns true if the editing mode is contact browsing.
abstract void setDisplayMode(int mode)
Sets the display mode for this bean.
abstract void setSubscriptionBeanName(String beanName)
Sets the name of the SubscriptionBean whose WebSubscription is currently being modified/edited.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.ContactsBrowserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int DISPLAY_MODE_PERSONAL_DIRECTORY

Constant Value: 1 (0x00000001)

public static final int DISPLAY_MODE_SHARED_DIRECTORY

Constant Value: 0 (0x00000000)

Public Methods

public abstract 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

public abstract String getEditorErrorMessage ()

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

public abstract SimpleList getPersonalLocations ()

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

Returns

public abstract SimpleList getSelectedContactElements ()

public abstract SimpleList getSelectedContactElements (int destType)

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

Parameters
destType from EnumDSSXMLNCSEmailDestinationType
Returns

public abstract SubscriptionBean getSubscriptionBean ()

returns the associated subscription bean.

public abstract boolean isContactBrowserOpen ()

returns true if the editing mode is contact browsing.

public abstract 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

public abstract void setSubscriptionBeanName (String beanName)

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