public
interface
SaveObjectAsDialogBean
implements AppComponent| com.microstrategy.web.app.beans.SaveObjectAsDialogBean |
Class Overview
Object Management Dialog bean
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.microstrategy.web.app.beans.AppComponent
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract FolderBean |
getBrowserBean()
Returns a child project browser bean used to render browsing info
for copy, move and create shortcut actions.
| ||||||||||
| abstract String |
getCloseAfterSaveEvent()
Returns the event URL to be executed if the user tries to save the object when prompted on
closing the object page.
| ||||||||||
| abstract ConfirmOverwriteDialogBean | getConfirmOverwriteBean() | ||||||||||
| abstract OMDCreateFolderBean |
getCreateFolderBean()
Returns the Crate Folder bean
| ||||||||||
| abstract String |
getErrorMessage()
Indicates an error description when processing FormularBar events.
| ||||||||||
| abstract String | getFolderId() | ||||||||||
| abstract String |
getObjectDescription()
Gets dialog's description field value
| ||||||||||
| abstract String |
getObjectId()
Returns an ID of the object the action applies to.
| ||||||||||
| abstract String |
getObjectName()
Returns value of dialog's name field
| ||||||||||
| abstract int | getObjectSubType() | ||||||||||
| abstract int |
getObjectType()
Returns type of the object the action applies to.
| ||||||||||
| abstract WebEvent |
getOpenCreateFolderDialogEvent()
Returns the Opend Create Folder Dialog event
| ||||||||||
| abstract ConfirmOverwriteDialogBean | getRejectOverwriteBean() | ||||||||||
| abstract String | getShouldReturn() | ||||||||||
| abstract String | getToFolderId() | ||||||||||
| abstract void | open() | ||||||||||
| abstract boolean | saveAs(boolean overwrite) | ||||||||||
| abstract void |
setBrowserFolderId(String childId)
Changes the current folder ID of the embedded browser bean.
| ||||||||||
| abstract void |
setCloseAfterSaveEvent(String url)
Sets the event to be executed if the user tries to save the object when prompted on
closing the object page.
| ||||||||||
| abstract void |
setErrorMessage(String errMssg)
Specify an error description when processing FormularBar events.
| ||||||||||
| abstract void | setFolderId(String value) | ||||||||||
| abstract void |
setObjectDescription(String value)
Sets dialog's description field value
| ||||||||||
| abstract void |
setObjectId(String value)
Sets an ID of the object the action applies to.
| ||||||||||
| abstract void |
setObjectName(String value)
Sets dialog's name field value
| ||||||||||
| abstract void | setObjectSubType(int value) | ||||||||||
| abstract void |
setObjectType(int value)
Sets type of the object the action applies to.
| ||||||||||
| abstract void | setShouldReturn(String shouldReturn) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.web.app.beans.AppComponent
| |||||||||||
|
From interface
com.microstrategy.web.beans.Transformable
| |||||||||||
|
From interface
com.microstrategy.web.beans.WebComponent
| |||||||||||
Public Methods
public abstract 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
public abstract String getCloseAfterSaveEvent ()
Returns the event URL to be executed if the user tries to save the object when prompted on closing the object page.
public abstract OMDCreateFolderBean getCreateFolderBean ()
Returns the Crate Folder bean
Returns
- the Crate Folder bean
public abstract String getErrorMessage ()
Indicates an error description when processing FormularBar events.
Returns
- errMssg Localized error message.
public abstract String getFolderId ()
public abstract String getObjectDescription ()
Gets dialog's description field value
Returns
- dialog's description field value
public abstract String getObjectId ()
Returns an ID of the object the action applies to.
Returns
- an ID of the object the action applies to.
public abstract String getObjectName ()
Returns value of dialog's name field
Returns
- value of dialog's name field
public abstract int getObjectSubType ()
public abstract int getObjectType ()
Returns type of the object the action applies to.
Returns
- type of the object the action applies to.
public abstract WebEvent getOpenCreateFolderDialogEvent ()
Returns the Opend Create Folder Dialog event
Returns
- the Opend Create Folder Dialog event
public abstract String getShouldReturn ()
public abstract String getToFolderId ()
public abstract void open ()
public abstract boolean saveAs (boolean overwrite)
public abstract void setBrowserFolderId (String childId)
Changes the current folder ID of the embedded browser bean.
Parameters
| childId | new current folder ID. |
|---|
public abstract void setCloseAfterSaveEvent (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.
public abstract void setErrorMessage (String errMssg)
Specify an error description when processing FormularBar events.
Parameters
| errMssg | Localized error message. |
|---|
public abstract void setFolderId (String value)
public abstract void setObjectDescription (String value)
Sets dialog's description field value
Parameters
| value | value |
|---|
public abstract void setObjectId (String value)
Sets an ID of the object the action applies to.
Parameters
| value | an ID of the object the action applies to. |
|---|
public abstract void setObjectName (String value)
Sets dialog's name field value
Parameters
| value | value |
|---|
public abstract void setObjectSubType (int value)
public abstract void setObjectType (int value)
Sets type of the object the action applies to.
Parameters
| value | type of the object the action applies to. |
|---|