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

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.

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.