Package com.microstrategy.web.objects.rw

Interface RWActionSelector

All Superinterfaces:

KeyedObject, RWControl, RWSelectorControl

public interface RWActionSelector
extends RWSelectorControl

Represent the action selector being used to submit various transaction operations. Please refer to EnumDSSXMLRWControlActionType

Field Summary

Fields inherited from interface com.microstrategy.web.objects.rw.RWSelectorControl

AUTO_SYNC, NO_AUTO_SYNC

Method Summary

Modifier and Type	Method	Description
int	getAvailableActions()	Get actions this action selector support.
java.lang.String	getConfirmMessage()	Get the message to display to user after submit
java.lang.String	getDisplayText()	Get the displayText for the actionSelector.
WebObjectInfo	getSubsequentActionObject()
int	getSubsequentActions()	Get the subSequesntActions defined on this selector.
void	setAvailableActions(int availableActions)	set the available actions on this control
void	setConfirmMessage(java.lang.String message)	Set the message to displaye to user after submit
void	setDisplayText(java.lang.String displayText)	Set the displayText for the actionSelector
void	setSubmissionOrder(java.lang.String[] targets)	Add the delta of setting submission order.
void	setSubsequentActionObject(WebObjectInfo object)	Set the object to be run after submit if the subsequentAction is {EnumDSSXMLRWControlSubsequentAction.DssXmlRWControlSubsequentActionExecuteNewObject}
void	setSubsequentActions(int subActions)	Set the subsequentActions after submit.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.web.objects.rw.RWControl

addDatasetTarget, addDatasetTarget, addPlaceHolderTarget, addTarget, addTarget, canMultiSelect, canUseSubtotals, generateGridControlFormatDelta, getDatasetTargets, getGroupByTargetKeys, getInfoWindowTarget, getKey, getKeyContext, getParent, getPlaceHolderGroupByTargetKeys, getPlaceHolderTargets, getSubtotals, getTarget, getTargetCount, getTargets, getTransactionAction, getType, hasDatasetTarget, hasTarget, hasTargets, isShowAll, isTopMost, isUnset, removeAllDatasetTargets, removeDatasetTarget, removePlaceHolderTarget, removeTarget, setInfoWindowTarget, setShowAll, setTopMost

Methods inherited from interface com.microstrategy.web.objects.rw.RWSelectorControl

createElements, getAutoSyncMode, getCurrentElements, getSduc, getTargetType, getUnsetCount, getUnsetStatus, setAutoSyncMode, setTargetType, setUnsetStatus

Method Detail

getAvailableActions

int getAvailableActions()

Get actions this action selector support. Refer to @link EnumDSSXMLRWControlActionType

Returns:

the available actions for this control

setAvailableActions

void setAvailableActions(int availableActions)

set the available actions on this control

Parameters:

availableActions - int from EnumDSSXMLRWControlActionType

getSubsequentActions

int getSubsequentActions()

Get the subSequesntActions defined on this selector. It is only meaningful if the action type is {EnumDSSXMLRWControlActionType.DssXmlRWControlActionTypeSubmit}

setSubsequentActions

void setSubsequentActions(int subActions)

Set the subsequentActions after submit.

Parameters:

subActions - int from EnumDSSXMLRWControlSubsequentAction, it could be a combination of various subSequentActions.

setSubsequentActionObject

void setSubsequentActionObject(WebObjectInfo object)

Set the object to be run after submit if the subsequentAction is {EnumDSSXMLRWControlSubsequentAction.DssXmlRWControlSubsequentActionExecuteNewObject}

Parameters:

object - {WebObjectInfo} the object to be executed after submit.

setSubmissionOrder

void setSubmissionOrder(java.lang.String[] targets)

Add the delta of setting submission order.

Parameters:

targets - the targets that need to be set order.

getSubsequentActionObject

WebObjectInfo getSubsequentActionObject()

setConfirmMessage

void setConfirmMessage(java.lang.String message)

Set the message to displaye to user after submit

Parameters:

message - {String}

getConfirmMessage

java.lang.String getConfirmMessage()

Get the message to display to user after submit

Returns:

the

getDisplayText

java.lang.String getDisplayText()

Get the displayText for the actionSelector.

Returns:

the displayText

setDisplayText

void setDisplayText(java.lang.String displayText)

Set the displayText for the actionSelector

Parameters:

displayText - {String}