public interface

ObjectManipulationDialogBean

implements FolderObjectExplorerBean
com.microstrategy.web.app.beans.ObjectManipulationDialogBean

Class Overview

Object Management Dialog bean

Summary

Constants
int ACT_COPY Action code constant
int ACT_CREATE_SHORTCUT Action code constant
int ACT_EXPORT_LINK Action code constant
int ACT_MOVE Action code constant
int ACT_PROPERTIES Action code constant
int ACT_RENAME Action code constant
int ACT_SHOW_ERROR
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract int getAction()
Retuns action code.
abstract FolderBean getBrowserBean()
Returns a child project browser bean used to render browsing info for copy, move and create shortcut actions.
abstract OMDCreateFolderBean getCreateFolderBean()
Returns the Crate Folder bean
abstract String getDescriptionField()
Gets dialog's description field value
abstract String getErrorMessage()
Indicates an error description when processing FormularBar events.
abstract FolderBean getFolderBean()
Returns target folder bean
abstract String getIconField()
abstract String getNameField()
Returns value of dialog's name field
abstract WebObjectInfo getObject()
Returns the object the action applies to.
abstract String getObjectId()
Returns an ID of the object the action applies to.
abstract int getObjectType()
Returns type of the object the action applies to.
abstract WebEvent getOpenCreateFolderDialogEvent()
Returns the Opend Create Folder Dialog event
abstract RWProjectBrowserTabBean getProjectBrowserBean()
This method is deprecated. The bean is now associated witha second folder bean for project browsing. Use getBrowserBean instead.
abstract String getRootObjectID()
abstract boolean getShowTarget()
abstract WebObjectInfo getTargetObject()
We need this method to deal correctly with shortcut object.
abstract boolean isCopyNameTrans()
abstract void onOpen(int action, String objectId, int objectType)
Initialozes bin when it's open
abstract void setAction(int value)
Sets action code.
abstract void setBrowserFolderId(String childId)
Changes the current folder ID of the embedded browser bean.
abstract void setCopyNameTrans(boolean value)
Sets dialog's copyNameTranslations check box value
abstract void setDescriptionField(String value)
Sets dialog's description field value
abstract void setErrorMessage(String errMssg)
Specify an error description when processing FormularBar events.
abstract void setIconField(String value)
Sets dialog's icon field value
abstract void setNameField(String value)
Sets dialog's name field value
abstract void setObjectId(String value)
Sets an ID of the object the action applies to.
abstract void setObjectType(int value)
Sets type of the object the action applies to.
abstract void toggleShowTarget()
Toggle the value of the show target property
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FolderObjectExplorerBean
From interface com.microstrategy.web.app.beans.ObjectExplorerBean
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int ACT_COPY

Action code constant

Constant Value: 3 (0x00000003)

public static final int ACT_CREATE_SHORTCUT

Action code constant

Constant Value: 8 (0x00000008)

public static final int ACT_EXPORT_LINK

Action code constant

Constant Value: 7 (0x00000007)

public static final int ACT_MOVE

Action code constant

Constant Value: 2 (0x00000002)

public static final int ACT_PROPERTIES

Action code constant

Constant Value: 6 (0x00000006)

public static final int ACT_RENAME

Action code constant

Constant Value: 1 (0x00000001)

public static final int ACT_SHOW_ERROR

Constant Value: 9 (0x00000009)

Public Methods

public abstract int getAction ()

Retuns action code.

Returns
  • action code.

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 OMDCreateFolderBean getCreateFolderBean ()

Returns the Crate Folder bean

Returns
  • the Crate Folder bean

public abstract String getDescriptionField ()

Gets dialog's description field value

Returns
  • dialog's description field value

public abstract String getErrorMessage ()

Indicates an error description when processing FormularBar events.

Returns
  • errMssg Localized error message.

public abstract FolderBean getFolderBean ()

Returns target folder bean

Returns
  • target folder bean

public abstract String getIconField ()

Returns
  • the icon path of the object

public abstract String getNameField ()

Returns value of dialog's name field

Returns
  • value of dialog's name field

public abstract WebObjectInfo getObject ()

Returns the object the action applies to.

Returns
  • the object the action applies to.

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 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 RWProjectBrowserTabBean getProjectBrowserBean ()

This method is deprecated.
The bean is now associated witha second folder bean for project browsing. Use getBrowserBean instead.

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 getRootObjectID ()

public abstract boolean getShowTarget ()

Returns
  • boolean value indicating the value of the show target property

public abstract WebObjectInfo getTargetObject ()

We need this method to deal correctly with shortcut object. When user performs certain aciotns on shortcut objects thosw actions really apply to the shortcut's target object.

Returns
  • If the current object is not a shortcut this method always returns this object. For shortcuts the result depends on the action code. For Properties and Create Shortcut actions this method returns shortcut's target. For all other actions the object itself is returned.

public abstract boolean isCopyNameTrans ()

Returns
  • boolean value indicating whether to copy the non-primary name translations

public abstract void onOpen (int action, String objectId, int objectType)

Initialozes bin when it's open

Parameters
action action code
objectId object ID
objectType object type

public abstract void setAction (int value)

Sets action code.

Parameters
value action code.

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 setCopyNameTrans (boolean value)

Sets dialog's copyNameTranslations check box value

Parameters
value value

public abstract void setDescriptionField (String value)

Sets dialog's description field value

Parameters
value value

public abstract void setErrorMessage (String errMssg)

Specify an error description when processing FormularBar events.

Parameters
errMssg Localized error message.

public abstract void setIconField (String value)

Sets dialog's icon field value

Parameters
value value

public abstract void setNameField (String value)

Sets dialog's name 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 setObjectType (int value)

Sets type of the object the action applies to.

Parameters
value type of the object the action applies to.

public abstract void toggleShowTarget ()

Toggle the value of the show target property