Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

InboxBean

implements WebBean

com.microstrategy.web.beans.InboxBean

Class Overview

The InboxBean interface allows the users to manage their History List. The main functionalities it provides in this interface are:

Save a message into Inbox. A message might be saved into Inbox in its specific state.
Remove a message from Inbox.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract void	cancelRename() Cancels the message ID and name set via `setRenameEditable(String)`
abstract int	getInboxFlags() Returns a flag of `EnumDSSXMLInboxFlags` indicating how much details to include in the returned Inbox messages, as well as those details about removing and saving Inbox messages.
abstract String	getRenameEditable()
abstract int	getSortField() Returns the sorting field of the Inbox messages.
abstract WebMessages	getWebMessages() Returns the Inbox messages in a `WebMessages` instance.
abstract boolean	isSavedInInbox(String messageID) Returns true if the specified message has already been saved in the Inbox.
abstract boolean	isSortAscending() Returns true if the sorting is in ascending order.
abstract void	removeInboxMessage(String messageID) Removes a single message from the Inbox.
abstract void	rename(String name) Sets the new message name for `getRenameEditable()`.
abstract void	saveToInbox(String messageID, int stateID) Saves a message along with its specific state into Inbox.
abstract void	saveToInbox(String messageID) Saves a message with its latest state into Inbox.
abstract void	setInboxFlags(int flags) Sets the flag of `EnumDSSXMLInboxFlags` indicating how much details to include in the returned Inbox messages, as well as those details about removing and saving Inbox messages.
abstract void	setRenameEditable(String messageID) Marks a message for renaming.
abstract void	setSortAscending(boolean asc) Sets the Inbox message sorting order.
abstract void	setSortField(int sortField) Sets the sorting field of the Inbox messages.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.serialization.Persistable

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

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Public Methods

public abstract void cancelRename ()

Cancels the message ID and name set via setRenameEditable(String)

public abstract int getInboxFlags ()

Returns a flag of EnumDSSXMLInboxFlags indicating how much details to include in the returned Inbox messages, as well as those details about removing and saving Inbox messages.

Returns

a flag indicating how much details to return. The default value is DssXmlInboxBrowsingInfo.

public abstract String getRenameEditable ()

Returns

the rename editable message ID.

public abstract int getSortField ()

Returns the sorting field of the Inbox messages.

Returns

the sorting field specified in EnumWebMessageSortByField. The default value is WebMessageSortByCreationTime.WebMessageSortByCreationTime

public abstract WebMessages getWebMessages ()

Returns the Inbox messages in a WebMessages instance. This method is affected by the Inbox flags which instructs the Intelligence Server how much details to bring back.

Returns

the Inbox messages

Throws

WebBeanException	thrown if the Inbox messages can not be retrieved.

public abstract boolean isSavedInInbox (String messageID)

Returns true if the specified message has already been saved in the Inbox.

Parameters

messageID	the message ID of an message.

Returns

true if the specified message is saved.

Throws

WebBeanException	thrown if this information can not be retrieved from backend.

public abstract boolean isSortAscending ()

Returns true if the sorting is in ascending order.

Returns

true if the sorting if in ascending order.

public abstract void removeInboxMessage (String messageID)

Removes a single message from the Inbox.

Parameters

messageID	the message ID of an Inbox message.

Throws

WebBeanException	thrown if the message can not be removed from the Inbox.

public abstract void rename (String name)

Sets the new message name for getRenameEditable().

Parameters

name	new name.

Throws

WebBeanException

public abstract void saveToInbox (String messageID, int stateID)

Saves a message along with its specific state into Inbox. The Inbox flags is used in this method to specify what to keep in the saved Inbox message.

Parameters

messageID	the message ID of an message
stateID	the state id of an message. The default state id is -1, meaning the latest state.

Throws

WebBeanException	thrown if the message can not be saved to the Inbox.

public abstract void saveToInbox (String messageID)

Saves a message with its latest state into Inbox. The Inbox flags is used in this method to specify what to keep in the saved Inbox message.

Parameters

messageID	the message id of an message.

Throws

WebBeanException	thrown if the message can not be saved to the Inbox.

public abstract void setInboxFlags (int flags)

Sets the flag of EnumDSSXMLInboxFlags indicating how much details to include in the returned Inbox messages, as well as those details about removing and saving Inbox messages.

Parameters

flags	a flag indicating how much details.

public abstract void setRenameEditable (String messageID)

Marks a message for renaming.

Parameters

messageID	message marked for renaming.

public abstract void setSortAscending (boolean asc)

Sets the Inbox message sorting order.

Parameters

asc	true if the sorting order is ascending.

public abstract void setSortField (int sortField)

Sets the sorting field of the Inbox messages.

Parameters

sortField	the sorting field specified in `EnumWebMessageSortByField`.

Interfaces

Classes

Exceptions

InboxBean

Class Overview

Summary

Public Methods

public abstract void cancelRename ()

public abstract int getInboxFlags ()

Returns

public abstract String getRenameEditable ()

Returns

See Also

public abstract int getSortField ()

Returns

public abstract WebMessages getWebMessages ()

Returns

Throws

public abstract boolean isSavedInInbox (String messageID)

Parameters

Returns

Throws

public abstract boolean isSortAscending ()

Returns

public abstract void removeInboxMessage (String messageID)

Parameters

Throws

public abstract void rename (String name)

Parameters

Throws

public abstract void saveToInbox (String messageID, int stateID)

Parameters

Throws

public abstract void saveToInbox (String messageID)

Parameters

Throws

public abstract void setInboxFlags (int flags)

Parameters

public abstract void setRenameEditable (String messageID)

Parameters

public abstract void setSortAscending (boolean asc)

Parameters

public abstract void setSortField (int sortField)

Parameters