Package com.microstrategy.web.app.beans

Interface ConfirmOverwriteDialogBean

All Superinterfaces:

AppComponent, Transformable, ViewBeanParserBean, WebComponent

public interface ConfirmOverwriteDialogBean
extends ViewBeanParserBean

Since:

MicroStrategy Web 9.0.0

Field Summary

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

COMPONENT_POSITION_NOT_INITIALIZED

Method Summary

Modifier and Type	Method	Description
boolean	getCanOverwrite()	Returns whether the current dialog should allow overwriting.
java.lang.String	getConfirmMessageId()	Returns the confirmation message ID.
java.lang.String	getMessage()	Deprecated. message could be retrieved from getConfirmMessageId() and getRejectMessageId() and it should be part of transform as it can by styled.
java.lang.String	getRejectMessageId()	Returns the rejection message ID.
SaveObjectAsDialogBean	getSaveAsBean()
void	setCanOverwrite(boolean canOver)	Sets whether the dialog will let user confirm overwriting or warn user that it can not overwriting.
void	setConfirmMessageId(java.lang.String msg)	Sets the Confirmation Message ID to show in this dialog.
void	setRejectMessageId(java.lang.String msg)	Sets the Rejection Message ID to show in this dialog.

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.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.app.beans.ViewBeanParserBean

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey

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

getSaveAsBean

SaveObjectAsDialogBean getSaveAsBean()

setConfirmMessageId

void setConfirmMessageId(java.lang.String msg)

Sets the Confirmation Message ID to show in this dialog. If nothing set, internal pre-set message will be shown. When property canOverwrite is true, this message will be shown.

Parameters:

msg - The String to shown in the dialog to confirm whether user would like to perform the overwrite.

setRejectMessageId

void setRejectMessageId(java.lang.String msg)

Sets the Rejection Message ID to show in this dialog. If nothing set, internal pre-set message will be shown. When property canOverwrite is false, this message will be used.

Parameters:

msg - The String to shown in the dialog when an overwrite will not be allowed to perform.

getConfirmMessageId

java.lang.String getConfirmMessageId()

Returns the confirmation message ID. If user has not set any message, it will return the internal pre-set message id.

Returns:

The confirmation message.

See Also:

setConfirmMessageId(String)

getRejectMessageId

java.lang.String getRejectMessageId()

Returns the rejection message ID. If user has not set any message, it will return the internal pre-set message ID.

Returns:

The rejection message.

See Also:

setRejectMessageId(String)

setCanOverwrite

void setCanOverwrite(boolean canOver)

Sets whether the dialog will let user confirm overwriting or warn user that it can not overwriting.

Parameters:

canOver - Whether the message shown as a warning message or confirmation message.

getCanOverwrite

boolean getCanOverwrite()

Returns whether the current dialog should allow overwriting.

Returns:

true if this dialog should allow overwriting. Otherwise, return false

See Also:

setCanOverwrite(boolean)

getMessage

@Deprecated
java.lang.String getMessage()

Deprecated.

message could be retrieved from getConfirmMessageId() and getRejectMessageId() and it should be part of transform as it can by styled.

Returns the message for this dialog. When property canOverwrite is true, the confirmation message corresponding to the confirm message ID will be shown; When property canOverwrite is false, the rejection message corresponding to the reject message ID will be shown

Returns:

The message.