Package com.microstrategy.web.beans
Interface InboxBean
-
- All Superinterfaces:
EnumWebPersistableState
,Persistable
,RequestPersistable
,Transformable
,WebBean
,WebComponent
public interface InboxBean extends WebBean
TheInboxBean
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.
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
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 void
cancelRename()
Cancels the message ID and name set viasetRenameEditable(String)
int
getInboxFlags()
Returns a flag ofEnumDSSXMLInboxFlags
indicating how much details to include in the returned Inbox messages, as well as those details about removing and saving Inbox messages.java.lang.String
getRenameEditable()
int
getSortField()
Returns the sorting field of the Inbox messages.WebMessages
getWebMessages()
Returns the Inbox messages in aWebMessages
instance.boolean
isSavedInInbox(java.lang.String messageID)
Returns true if the specified message has already been saved in the Inbox.boolean
isSortAscending()
Returns true if the sorting is in ascending order.void
removeInboxMessage(java.lang.String messageID)
Removes a single message from the Inbox.void
rename(java.lang.String name)
Sets the new message name forgetRenameEditable()
.void
saveToInbox(java.lang.String messageID)
Saves a message with its latest state into Inbox.void
saveToInbox(java.lang.String messageID, int stateID)
Saves a message along with its specific state into Inbox.void
setInboxFlags(int flags)
Sets the flag ofEnumDSSXMLInboxFlags
indicating how much details to include in the returned Inbox messages, as well as those details about removing and saving Inbox messages.void
setRenameEditable(java.lang.String messageID)
Marks a message for renaming.void
setSortAscending(boolean asc)
Sets the Inbox message sorting order.void
setSortField(int sortField)
Sets the sorting field of the Inbox messages.-
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.WebBean
getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale
-
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
-
-
-
-
Method Detail
-
getWebMessages
WebMessages getWebMessages() throws WebBeanException
Returns the Inbox messages in aWebMessages
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.
-
getInboxFlags
int getInboxFlags()
Returns a flag ofEnumDSSXMLInboxFlags
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.
-
setInboxFlags
void setInboxFlags(int flags)
Sets the flag ofEnumDSSXMLInboxFlags
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.
-
removeInboxMessage
void removeInboxMessage(java.lang.String messageID) throws WebBeanException
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.
-
saveToInbox
void saveToInbox(java.lang.String messageID, int stateID) throws WebBeanException
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 messagestateID
- 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.
-
saveToInbox
void saveToInbox(java.lang.String messageID) throws WebBeanException
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.
-
isSavedInInbox
boolean isSavedInInbox(java.lang.String messageID) throws WebBeanException
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.
-
getSortField
int getSortField()
Returns the sorting field of the Inbox messages.- Returns:
- the sorting field specified in
EnumWebMessageSortByField
. The default value is WebMessageSortByCreationTime.WebMessageSortByCreationTime
-
setSortField
void setSortField(int sortField)
Sets the sorting field of the Inbox messages.- Parameters:
sortField
- the sorting field specified inEnumWebMessageSortByField
.
-
isSortAscending
boolean isSortAscending()
Returns true if the sorting is in ascending order.- Returns:
- true if the sorting if in ascending order.
-
setSortAscending
void setSortAscending(boolean asc)
Sets the Inbox message sorting order.- Parameters:
asc
- true if the sorting order is ascending.
-
rename
void rename(java.lang.String name) throws WebBeanException
Sets the new message name forgetRenameEditable()
.- Parameters:
name
- new name.- Throws:
WebBeanException
- Since:
- MicroStrategy Web 9.0.0
-
setRenameEditable
void setRenameEditable(java.lang.String messageID)
Marks a message for renaming.- Parameters:
messageID
- message marked for renaming.- Since:
- MicroStrategy Web 9.0.0
-
getRenameEditable
java.lang.String getRenameEditable()
- Returns:
- the rename editable message ID.
- Since:
- MicroStrategy Web 9.0.0
- See Also:
setRenameEditable(String)
-
cancelRename
void cancelRename()
Cancels the message ID and name set viasetRenameEditable(String)
- Since:
- MicroStrategy Web 9.0.0
-
-