Package com.microstrategy.web.app.beans

Interface SaveObjectAsDialogBean

All Superinterfaces:

AppComponent, Transformable, WebComponent

public interface SaveObjectAsDialogBean
extends AppComponent

Object Management Dialog bean

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
FolderBean	getBrowserBean()	Returns a child project browser bean used to render browsing info for copy, move and create shortcut actions.
java.lang.String	getCloseAfterSaveEvent()	Returns the event URL to be executed if the user tries to save the object when prompted on closing the object page.
ConfirmOverwriteDialogBean	getConfirmOverwriteBean()
OMDCreateFolderBean	getCreateFolderBean()	Returns the Crate Folder bean
java.lang.String	getErrorMessage()	Indicates an error description when processing FormularBar events.
java.lang.String	getFolderId()
java.lang.String	getObjectDescription()	Gets dialog's description field value
java.lang.String	getObjectId()	Returns an ID of the object the action applies to.
java.lang.String	getObjectName()	Returns value of dialog's name field
int	getObjectSubType()
int	getObjectType()	Returns type of the object the action applies to.
WebEvent	getOpenCreateFolderDialogEvent()	Returns the Opend Create Folder Dialog event
ConfirmOverwriteDialogBean	getRejectOverwriteBean()
java.lang.String	getShouldReturn()
java.lang.String	getToFolderId()
void	open()
boolean	saveAs(boolean overwrite)
void	setBrowserFolderId(java.lang.String childId)	Changes the current folder ID of the embedded browser bean.
void	setCloseAfterSaveEvent(java.lang.String url)	Sets the event to be executed if the user tries to save the object when prompted on closing the object page.
void	setErrorMessage(java.lang.String errMssg)	Specify an error description when processing FormularBar events.
void	setFolderId(java.lang.String value)
void	setObjectDescription(java.lang.String value)	Sets dialog's description field value
void	setObjectId(java.lang.String value)	Sets an ID of the object the action applies to.
void	setObjectName(java.lang.String value)	Sets dialog's name field value
void	setObjectSubType(int value)
void	setObjectType(int value)	Sets type of the object the action applies to.
void	setShouldReturn(java.lang.String shouldReturn)

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.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

getObjectId

java.lang.String getObjectId()

Returns an ID of the object the action applies to.

Returns:

an ID of the object the action applies to.

setObjectId

void setObjectId(java.lang.String value)

Sets an ID of the object the action applies to.

Parameters:

value - an ID of the object the action applies to.

getObjectType

int getObjectType()

Returns type of the object the action applies to.

Returns:

type of the object the action applies to.

setObjectType

void setObjectType(int value)

Sets type of the object the action applies to.

Parameters:

value - type of the object the action applies to.

getObjectSubType

int getObjectSubType()

setObjectSubType

void setObjectSubType(int value)

getObjectName

java.lang.String getObjectName()

Returns value of dialog's name field

Returns:

value of dialog's name field

setObjectName

void setObjectName(java.lang.String value)

Sets dialog's name field value

Parameters:

value - value

getObjectDescription

java.lang.String getObjectDescription()

Gets dialog's description field value

Returns:

dialog's description field value

setObjectDescription

void setObjectDescription(java.lang.String value)

Sets dialog's description field value

Parameters:

value - value

getFolderId

java.lang.String getFolderId()

setFolderId

void setFolderId(java.lang.String value)

getBrowserBean

FolderBean getBrowserBean()

Returns a child project browser bean used to render browsing info for copy, move and create shortcut actions.

Returns:

a child project browser bean

getErrorMessage

java.lang.String getErrorMessage()

Indicates an error description when processing FormularBar events.

Returns:

errMssg Localized error message.

setErrorMessage

void setErrorMessage(java.lang.String errMssg)

Specify an error description when processing FormularBar events.

Parameters:

errMssg - Localized error message.

getCreateFolderBean

OMDCreateFolderBean getCreateFolderBean()

Returns the Crate Folder bean

Returns:

the Crate Folder bean

setBrowserFolderId

void setBrowserFolderId(java.lang.String childId)

Changes the current folder ID of the embedded browser bean.

Parameters:

childId - new current folder ID.

getOpenCreateFolderDialogEvent

WebEvent getOpenCreateFolderDialogEvent()

Returns the Opend Create Folder Dialog event

Returns:

the Opend Create Folder Dialog event

getConfirmOverwriteBean

ConfirmOverwriteDialogBean getConfirmOverwriteBean()

getRejectOverwriteBean

ConfirmOverwriteDialogBean getRejectOverwriteBean()

saveAs

boolean saveAs(boolean overwrite)

getToFolderId

java.lang.String getToFolderId()

open

void open()

getShouldReturn

java.lang.String getShouldReturn()

setShouldReturn

void setShouldReturn(java.lang.String shouldReturn)

getCloseAfterSaveEvent

java.lang.String getCloseAfterSaveEvent()

Returns the event URL to be executed if the user tries to save the object when prompted on closing the object page.

Returns:

setCloseAfterSaveEvent

void setCloseAfterSaveEvent(java.lang.String url)

Sets the event to be executed if the user tries to save the object when prompted on closing the object page. The url is stored as a string.

Parameters:

The - event URL string.