Package com.microstrategy.web.app.beans

Interface ObjectManipulationDialogBean

All Superinterfaces:

AppComponent, FolderObjectExplorerBean, ObjectExplorerBean, Transformable, WebComponent

public interface ObjectManipulationDialogBean
extends FolderObjectExplorerBean

Object Management Dialog bean

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	ACT_COPY	Action code constant
static int	ACT_CREATE_SHORTCUT	Action code constant
static int	ACT_EXPORT_LINK	Action code constant
static int	ACT_MOVE	Action code constant
static int	ACT_PROPERTIES	Action code constant
static int	ACT_RENAME	Action code constant
static int	ACT_SHOW_ERROR

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

COMPONENT_POSITION_NOT_INITIALIZED

Method Summary

Modifier and Type	Method	Description
int	getAction()	Retuns action code.
FolderBean	getBrowserBean()	Returns a child project browser bean used to render browsing info for copy, move and create shortcut actions.
boolean	getCertified()	Gets dialog's certified filed value
OMDCreateFolderBean	getCreateFolderBean()	Returns the Crate Folder bean
java.lang.String	getDescriptionField()	Gets dialog's description field value
java.lang.String	getErrorMessage()	Indicates an error description when processing FormularBar events.
FolderBean	getFolderBean()	Returns target folder bean
java.lang.String	getIconField()
java.lang.String	getNameField()	Returns value of dialog's name field
WebObjectInfo	getObject()	Returns the object the action applies to.
java.lang.String	getObjectId()	Returns an ID of the object the action applies to.
int	getObjectType()	Returns type of the object the action applies to.
WebEvent	getOpenCreateFolderDialogEvent()	Returns the Opend Create Folder Dialog event
RWProjectBrowserTabBean	getProjectBrowserBean()	Deprecated. The bean is now associated witha second folder bean for project browsing.
java.lang.String	getRootObjectID()
boolean	getShowTarget()
WebObjectInfo	getTargetObject()	We need this method to deal correctly with shortcut object.
boolean	isCopyNameTrans()
void	onOpen(int action, java.lang.String objectId, int objectType)	Initialozes bin when it's open
void	setAction(int value)	Sets action code.
void	setBrowserFolderId(java.lang.String childId)	Changes the current folder ID of the embedded browser bean.
void	setCertified(boolean value)	Sets dialog's certified filed value
void	setCopyNameTrans(boolean value)	Sets dialog's copyNameTranslations check box value
void	setDescriptionField(java.lang.String value)	Sets dialog's description field value
void	setErrorMessage(java.lang.String errMssg)	Specify an error description when processing FormularBar events.
void	setIconField(java.lang.String value)	Sets dialog's icon field value
void	setNameField(java.lang.String value)	Sets dialog's name field value
void	setObjectId(java.lang.String value)	Sets an ID of the object the action applies to.
void	setObjectType(int value)	Sets type of the object the action applies to.
void	toggleShowTarget()	Toggle the value of the show target property

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

getConfiguredRootFolderID, getContextID, getLinksContextID, getRenderRoot, getRootFolderID, getTrimedAncestors, isExcludeShortcut, isQuickSearch, resetFolderBean, setContextID, setExcludeShortcut, setQuickSearch, setRenderRoot

Methods inherited from interface com.microstrategy.web.app.beans.ObjectExplorerBean

getAncestors, getBlockBegin, getBlockCount, getContents, getContents, getCurrentUnit, getLinks, getObjectCount, getSearchName, getTotalObjectCount, getTypeRestriction, setBlockBegin, setBlockCount, setTypeRestriction

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

Field Detail

ACT_RENAME

static final int ACT_RENAME

Action code constant

See Also:

Constant Field Values

ACT_MOVE

static final int ACT_MOVE

Action code constant

See Also:

Constant Field Values

ACT_COPY

static final int ACT_COPY

Action code constant

See Also:

Constant Field Values

ACT_PROPERTIES

static final int ACT_PROPERTIES

Action code constant

See Also:

Constant Field Values

ACT_EXPORT_LINK

static final int ACT_EXPORT_LINK

Action code constant

See Also:

Constant Field Values

ACT_CREATE_SHORTCUT

static final int ACT_CREATE_SHORTCUT

Action code constant

See Also:

Constant Field Values

ACT_SHOW_ERROR

static final int ACT_SHOW_ERROR

See Also:

Constant Field Values

Method Detail

getAction

int getAction()

Retuns action code.

Returns:

action code.

setAction

void setAction(int value)

Sets action code.

Parameters:

value - action code.

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.

getObject

WebObjectInfo getObject()

Returns the object the action applies to.

Returns:

the object the action applies to.

getTargetObject

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.

getFolderBean

FolderBean getFolderBean()

Returns target folder bean

Specified by:

getFolderBean in interface FolderObjectExplorerBean

Returns:

target folder bean

getProjectBrowserBean

RWProjectBrowserTabBean getProjectBrowserBean()

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

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

Since:

MicroStrategy Web 8.0.1

getErrorMessage

java.lang.String getErrorMessage()

Indicates an error description when processing FormularBar events.

Specified by:

getErrorMessage in interface ObjectExplorerBean

Returns:

errMssg Localized error message.

setErrorMessage

void setErrorMessage(java.lang.String errMssg)

Specify an error description when processing FormularBar events.

Specified by:

setErrorMessage in interface ObjectExplorerBean

Parameters:

errMssg - Localized error message.

onOpen

void onOpen(int action,
            java.lang.String objectId,
            int objectType)

Initialozes bin when it's open

Parameters:

action - action code

objectId - object ID

objectType - object type

getNameField

java.lang.String getNameField()

Returns value of dialog's name field

Returns:

value of dialog's name field

setNameField

void setNameField(java.lang.String value)

Sets dialog's name field value

Parameters:

value - value

getDescriptionField

java.lang.String getDescriptionField()

Gets dialog's description field value

Returns:

dialog's description field value

setDescriptionField

void setDescriptionField(java.lang.String value)

Sets dialog's description field value

Parameters:

value - value

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

getShowTarget

boolean getShowTarget()

Returns:

boolean value indicating the value of the show target property

toggleShowTarget

void toggleShowTarget()

Toggle the value of the show target property

getRootObjectID

java.lang.String getRootObjectID()

Since:

MicroStrategy Web 9.0.0

getIconField

java.lang.String getIconField()

Returns:

the icon path of the object

setIconField

void setIconField(java.lang.String value)

Sets dialog's icon field value

Parameters:

value - value

isCopyNameTrans

boolean isCopyNameTrans()

Returns:

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

setCopyNameTrans

void setCopyNameTrans(boolean value)

Sets dialog's copyNameTranslations check box value

Parameters:

value - value

setCertified

void setCertified(boolean value)

Sets dialog's certified filed value

Parameters:

value - value

getCertified

boolean getCertified()

Gets dialog's certified filed value

Parameters:

value - value