public interface

RWManipulation

com.microstrategy.web.objects.rw.RWManipulation

Class Overview

The manipulation object contains manipulation methods that require immediate call to backend. Whenever any of methods on this object called all accumulated deltas (included deltas generated by this call are send to backend.

Summary

Public Methods
abstract void addAttributeForm(String keyContext, String attributeID, String formID, int index)
Add an attribute form to a gridgraph in an RW
abstract RWInstance addControlSort(String keyContext, int sortType, boolean isAscending, int subTotalsPosition, String unitID, int unitType, String formID, boolean applyChanges)
Adds a sort to the specified control
abstract RWInstance addDataSet(String _id, int _type)
Adds data set
abstract RWInstance addDataSet(String[] _id, int _type, boolean _setDefault, boolean applyNow)
Adds data set
abstract RWInstance addDataSet(String _id, int _type, boolean _setDefault)
Adds data set
abstract RWInstance addDataSet(String[] _id, int _type, boolean _setDefault)
Adds data set
abstract RWInstance addDataSetAndTemplate(String _dsId, int _dsType, String _templateKey, int populateOption)
Adds specified data set to document and copies it's template to specified document template
abstract void addDeltaXML(String deltaXml)
Append the DeltaXML to the current manipulator Delta
abstract RWInstance addDerivedAttributeToDataSet(String dataSetId, String name, String formula, Integer bft, Boolean isTokenStream)
add derived attribute to dataset only with id form, you can add other forms by
abstract RWInstance addDerivedAttributeToTemplate(String key, String name, int axisName, int position, String formula, Integer bft, Boolean isTokenStream)
Adds derived attribute to a template inside document
abstract RWInstance addDerivedMetricToDataSet(String id, String formula, String name, boolean aggFromBase)
Adds derived mettic to document data set
abstract RWInstance addDerivedMetricToDataSet(String id, String formula, String name, boolean aggFromBase, boolean isTokenStream)
Adds derived metric to document data set
abstract RWInstance addDerivedMetricToTemplate(String key, String formula, int position, String name, Boolean aggFromBase, Boolean isTokenStream)
Adds derived metric to a template inside document
abstract RWInstance addDerivedMetricToTemplate(String key, String formula, int position, String name, Boolean aggFromBase)
Adds derived mettic to a template inside document
abstract RWInstance addDerivedMetricToTemplate(String key, String formula, int position, String name)
Adds derived mettic to a template inside document
abstract RWInstance addDocumentView(String name, int resolutionX, int resolutionY, int density, int orientation, int index, boolean applyChanges)
Add a new document by duplicating an existing document.
abstract RWInstance addFormToDerivedAttribute(String attributeId, String dataSetId, String formId, String name, Integer index, String formula, Integer bft, boolean applyChanges)
add one attribute form to derived attribute
abstract RWInstance addLayout(String key, String beforeKey, String name)
abstract void addMetric(String keyContext, String unitDisplayName, String unitID, int unitType, int unitPosition)
Add a metric to a gridgraph in an RW
abstract RWInstance addPercentToTotalMetric(String key, WebPercentToTotalMetric metric)
Adds percent-to-total metric to specified grid
abstract RWInstance addQuickCalculationGroup(String key, String deName, String attId, int depth, int[] ordinals, int function, String sliceId)
abstract RWInstance addQuickListGroup(String key, String deName, String attId, int depth, int[] ordinals, String sliceId)
abstract RWInstance addRankMetric(String key, WebRankMetric metric)
Adds new rank metric to specified grid
abstract RWInstance addShortcutMetric(String datasetID, String datasetType, String nodeKey, String treeType, int functionType, int functionType2, List<WebObjectInfo> unitsInfo)
Add shortcut metric to a given dataset and optionally a given template
abstract RWInstance addTemplateFromDataSet(String dataSetId, String key, String parentKey, String name, String left, String top, String width, String height, String zIndex, int displayMode, boolean linked, String styleId, boolean applyToAllViews)
Adds a template unit containing a copy of the data set's template
abstract RWInstance addTemplateFromDataSet(String dataSetId, String key, String parentKey, String name, String left, String top, String width, String height, String zIndex, int displayMode, boolean linked, String styleId)
Adds a template unit containing a copy of the data set's template
abstract RWInstance addTemplateFromDataSet(String dataSetId, String key, String parentKey, String name, String left, String top, String width, String height, String zIndex, int displayMode)
Adds a template unit containing a copy of the data set's template
abstract RWInstance addTransactionReport(String keyContext, String transactionElementID, int transactionElementType, boolean applyChanges)
Associate a transaction report with a rwGridGraph unit or rwFieldGroupUnit
abstract RWInstance advSort(String nodeKey, int treeType, boolean clearSorts, WebSortConfig config, boolean applyNow, boolean isAdvSort)
Apply multiple sort rules to the grid
abstract RWInstance applyAttributeLinking(boolean unlink, String srcAttrID, String srcFormIDs, String tgtAttrIDs, String tgtFormsIDs)
Apply linking or unlinking attributes
abstract RWInstance applyAttributeRemapping(String datasetID, int datasetType, String tarDatasetID, int tarDatasetType, String srcID, String tarID)
Apply or cancel attribute re-mapping
abstract RWInstance applyChanges()
Applys all accumulated changes
abstract RWInstance applyGraphControlAction(String nodeKey, int sliceID, int x, int y)
Sects control selection based on graph area
abstract RWInstance applySegment(String segmentID, String keyContext, boolean applyChanges)
Apply a Segment to the RWInstance
abstract RWInstance applyStyleByID(String key, String id)
Apply a style by style DSSID.
abstract RWInstance applyTheme(String themeID, boolean applyChanges)
Apply theme to this RWInstance
abstract RWInstance applyThemeOnNode(String themeID, RWUnitDef unit, boolean isLink, boolean applyChanges)
Apply theme on specified node
abstract RWInstance cancel(int stateID)
Cancels current updates and resets object to specified state@return
abstract RWInstance cancel(int stateID, boolean rerun)
Cancels current updates and resets object to specified state@return
abstract RWInstance changeDerivedAttributeName(String attributeId, String dataSetId, String name)
change derived attribute name
abstract RWInstance changeDerivedMetric(String metricId, String dataSetId, String formula, String alias)
Changes derived metric
abstract RWInstance changeDerivedMetric(String metricId, String dataSetId, String formula, String alias, Boolean isTokenStream, Boolean aggregateFromBase)
Changes derived metric
abstract RWInstance changeTemplateLinkToDataSet(String key, String dataSetID, boolean linked)
Changes the property of the template from being linked to unlinked or vise-versa
abstract void changeUnitName(String keyContext, String unitID, int unitType, String unitName)
abstract RWInstance clearAllSorts(String nodeKey, int treeType)
abstract RWInstance clearControlSorts(String keyContext, boolean applyChanges)
Clears all sorts for a givent control
abstract void copyToClipboard(String[] keys)
Copies units to clipboard
abstract RWUnitDef copyUnit(String fieldKey, String newKey, String newParentKey, String beforeKey)
Copyes specified unit to specified section
abstract void cutToClipboard(String[] keys)
Cuts units to clipboard
abstract RWInstance drill(String drillKey, String[] drillElements, Map drillProperties)
Drills on the current RW instance using the drill path key and settings passed as arguments.
abstract RWInstance duplicatePanel(RWUnitDef panel, String name)
abstract RWInstance duplicatePanelStacks(String[] keys, String[] names, float offset)
abstract RWInstance editDocumentView(String name, int resolutionX, int resolutionY, int density, int orientation, int index, boolean applyChanges)
Edit a document view@return
abstract RWInstance filterOnSelections(String[] drillElements, Map drillProperties, String nodeKey)
abstract RWInstance forceApplyChanges()
If we have delta on the manipulator, we must force to apply changes
abstract WebPercentToTotalMetric getNewPercentToTotalMetric(String key, WebMetric metric)
Returns a new instance of the WebPercentToTotalMetric object.
abstract WebRankMetric getNewRankMetric(String key, WebMetric metric)
Returns a new instance of the WebRankMetric object.
abstract WebSortConfig getNewSortConfig(int sortType)
abstract RWInstance importDocument(String id, String beforeKey, boolean isTemplate)
abstract RWInstance makeTabular()
Makes all grids within this document tabular.
abstract RWInstance moveLayout(String key, String beforeKey)
abstract RWUnitDef moveUnit(String key, String newParentKey, String beforeKey)
Moves a unit to a new owner
abstract RWUnitDef[] pasteFromClipboard(String newParentKey, String[] newKeys)
Pastes units from clipboard to a subsection
abstract RWInstance performActionOnActionSelector(String keyContext, int action, boolean applyChanges)
Perform and action on an ActionSelector.
abstract void pivotTemplateUnit(String keyContext, String unitID, int unitType, int dAxis, int dPos)
Pivot the template unit specified to a new axis and position
abstract RWInstance populateTemplateFromDataSet(String _dsId, int _dsType, String _templateKey, int _populateOption)
Populates document template unit with data set template
abstract RWInstance redo(int stateID)
abstract RWInstance refresh(String promptAnswerXML)
Uses the prompt answer to refresh the report.
abstract RWInstance refresh(boolean reprompt, boolean rerun)
Refreshes the instance.
abstract RWInstance refresh()
Convenience method.
abstract RWInstance refresh(boolean reprompt, boolean rerun, boolean regenerate)
abstract RWInstance refresh(boolean reprompt, boolean rerun, boolean regenerate, int stateID)
abstract RWInstance refresh(boolean reprompt)
Refreshes the current state of the instance.
abstract RWInstance removeDocumentView(int index, boolean applyChanges)
Remove a document view at specified index
abstract RWInstance removeFormFromDerivedAttribute(String attributeId, String dataSetId, String formId)
remove attribute form from derived attribute
abstract RWInstance removeLayout(String key)
abstract RWInstance removeLayout(String key, boolean isCurrent)
abstract RWInstance removeThemeOnNode(RWUnitDef unit, boolean applyChanges)
remove theme on specified node
abstract RWInstance removeTransactionInfoOnField(String keyContext, String fieldKey, boolean applyChanges)
Clear the transaction information for text fields
abstract RWInstance removeTransactionInfoOnGridObject(String keyContext, String objectID, int objectType, String attributeFormID, boolean applyChanges)
Clear the transaction information for attribute form/metric on a grid
abstract RWInstance removeTransactionReport(String keyContext, boolean applyChanges)
abstract RWUnitDef removeUnit(String key)
Removes a unit with specified key
abstract RWInstance replaceDataSet(String oldDataSetID, String newDataSetID, int oldDSType, int newDSType)
replace the old dataset with the new one
abstract RWInstance replaceDataSet(String oldDataSetID, String newDataSetID, int oldDSType, int newDSType, boolean applyChanges)
replace the old dataset with the new one
abstract RWInstance resetSelections(String keyContext)
Reset document selections
abstract RWInstance setAutomaticTransactionRecordNumber(String keyContext, int recordNumber, boolean applyChanges)
Set the number of rows that will be automatically transacted
abstract RWInstance setAvailableActionTypesForControl(String keyContext, int actionType, boolean applyChanges)
Set the available control types in a control
abstract RWInstance setControlAttributeForms(String keyContext, List<String> formIDs, boolean applyChanges)
Set forms for custom control forms
abstract RWInstance setControlAttributeFormsDelimeter(String keyContext, String delimiter, boolean applyChanges)
Set delimiter for custom control forms
abstract RWInstance setControlAttributeFormsDisplayType(String keyContext, int displayType, boolean applyChanges)
Set display type for control forms
abstract RWInstance setControlCurrentElementStatusToUnset(String keyContext, boolean applyChanges)
Sets the control status to unset
abstract RWInstance setControlDisplayText(String keyContext, String displayText, boolean applyChanges)
Set the display text for the action selector
abstract RWInstance setControlExpression(String keyContext, int controlType, WebExpression expression, boolean applyChanges)
Set the expression for a conditional selector
abstract RWInstance setControlSubsquentAction(String keyContext, int action, boolean applyChanges)
Set the subsequent action in the action control after submit.
abstract RWInstance setControlSubsquentActionObject(String keyContext, int controlType, String objectID, int objectType, String objectName, boolean applyChanges)
Set the subsequent action in the action control after submit.
abstract RWInstance setControlSubsquentDisplayMessage(String keyContext, String displayMessage, boolean applyChanges)
Set message to display after perform the action using action selector.
abstract RWInstance setControlTexts(String keyContext, List<String> texts, boolean applyChanges)
Sets current control's text selections
abstract RWInstance setControlUnsetStatus(String keyContext, int unsetStatus, int unsetCount, boolean applyChanges)
Set the unset status of the control specified by keyContext
abstract RWInstance setCurrentControlElements(String key, List elementIds, boolean isInList, boolean applyChanges)
Sets current control selection.
abstract RWInstance setCurrentControlElements(String key, List elementIds, boolean applyChanges)
Sets current control selection
abstract RWInstance setCurrentDocumentView(int index, boolean applyChanges)
set the current document view with the specified index@return
abstract RWInstance setCurrentGroupByElement(String groupKey, String elementId, int flags, boolean applyChanges)
Sets current group by element.
abstract RWInstance setCurrentGroupByElement(String groupKey, String elementId)
Sets current group by element
abstract RWInstance setCurrentGroupByElement(String groupKey, String elementId, boolean applyChanges)
Sets current group by element.
abstract RWInstance setCurrentGroupByElementByUnitID(String unitID, int unitType, String elementId, boolean applyChanges)
Set the current group-by using unitID
abstract RWInstance setCurrentLayout(int index, boolean applyChanges)
Set the current layout by 0-based index
abstract RWInstance setCurrentLayout(String key)
abstract void setCurrentPanel(String keyContext, String panelKey)
Sets panel stack current panel
abstract void setDisplayMode(String keyContext, int viewMode)
Sets document template unit display mode
abstract RWInstance setGridViewFilter(String unitKey, String filterXML)
abstract RWInstance setNextCurrentGroupByElement(int elementAction)
Movets to another group by element
abstract RWInstance setTemplateUnitProperties(String nodeKey, int treeType, String unitID, int unitType, boolean applyNow)
Apply the changed properties of a template unit@return
abstract RWInstance setTransactionChangeType(String keyContext, int changeType, boolean applyChanges)
Set the transaction change type in the filed group node or gridGraph node.
abstract RWInstance setTransactionInfoOnField(String keyContext, String fieldKey, int mappedColumnIndex, int transactionFlags, String inputControlKey, String inputControlProperties, boolean applyChanges)
Set transaction information for text fields
abstract RWInstance setTransactionInfoOnGridObject(String keyContext, String objectID, int objectType, String attributeFormID, int mappedColumnIndex, int transactionFlags, String inputControlKey, String inputControlProperties, boolean applyChanges)
Set transaction information for attribute form/metric on a grid
abstract RWInstance showAllThresholds(String nodeKey, boolean enable)
Enables/disables report thresholds
abstract void showSubtotals(String keyContext, String unitID, int unitType, String subtotalType, boolean isAdd)
abstract RWInstance sortGrid(String nodeKey, int treeType, boolean clearSorts, WebSortConfig config, boolean applyNow)
abstract RWInstance toggleDataServeMode(String dsid, int type, int mode)
abstract RWInstance undo(int stateID, boolean rerun)
abstract RWInstance undo(int stateID)
abstract RWInstance updateDerivedAttributeForm(String attributeId, String dataSetId, String formId, String name, String formula, Integer bft, Boolean isTokenStream, Boolean isDisplayForm)
update form of derived attribute
abstract void updateTemplateUnits(String keyContext, String unitID, int unitType, int dAxis, int dPos, int actions)
abstract RWInstance updateTransactionData(String changes, boolean applyChanges)
Modify transaction data in the RWInstance
abstract String validateExpression(String tokenStreamXML, boolean isForMetric, int outFlags, int baseFormType)
Check whether the token stream is valid
abstract String validateLocalTransactionExpression(WebTokenStream tokenStream, String ctlKey, String nodeKey)
Check whether the token steam is valid

Public Methods

public abstract void addAttributeForm (String keyContext, String attributeID, String formID, int index)

Add an attribute form to a gridgraph in an RW

Parameters
keyContext String containing the tree id and grid/graph's RW key
attributeID String containing the attribute id for which the form will be added
formID String containing the attribute's form ID
index int specifying the new position of the form relative to the attributes template unit's position (1-starting)

public abstract RWInstance addControlSort (String keyContext, int sortType, boolean isAscending, int subTotalsPosition, String unitID, int unitType, String formID, boolean applyChanges)

Adds a sort to the specified control

Parameters
keyContext String containing tree type, node key, control key
sortType int from EnumDSSXMLSortType
isAscending boolean specifying whether sort is ascending
subTotalsPosition int from EnumDSSXMLSubtotalsPosition
unitID String containing ID of target of sort
unitType int from EnumDSSXMLObjectTypes
formID String containing ID of form to sort on if form is sorted on (null o/w).
applyChanges boolean specifying whether changes should be applied immediately
Returns
  • either current RWInstance or one generated after applied changes

public abstract RWInstance addDataSet (String _id, int _type)

Adds data set

Parameters
_id data set ID
_type data set type
Returns
  • a RW instance representing document after changes

public abstract RWInstance addDataSet (String[] _id, int _type, boolean _setDefault, boolean applyNow)

Adds data set

Parameters
_id Array of data set IDs.
_type data set type from EnumDSSXMLObjectTypes.
_setDefault if this parameter is true a new data set will be set as default.
Returns
  • a RW instance representing document after changes if applyNow is true.
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance addDataSet (String _id, int _type, boolean _setDefault)

Adds data set

Parameters
_id data set ID.
_type data set type from EnumDSSXMLObjectTypes.
_setDefault if this parameter is true a new data set will be set as default.
Returns
  • a RW instance representing document after changes.

public abstract RWInstance addDataSet (String[] _id, int _type, boolean _setDefault)

Adds data set

Parameters
_id Array of data set IDs.
_type data set type from EnumDSSXMLObjectTypes.
_setDefault if this parameter is true a new data set will be set as default.
Returns
  • a RW instance representing document after changes.
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance addDataSetAndTemplate (String _dsId, int _dsType, String _templateKey, int populateOption)

Adds specified data set to document and copies it's template to specified document template

Parameters
_dsId data set ID
_dsType data set type
_templateKey document template unit key
populateOption populate option
Returns
  • RWInstance document instance
Throws
WebObjectsException
WebObjectsException

public abstract void addDeltaXML (String deltaXml)

Append the DeltaXML to the current manipulator Delta

public abstract RWInstance addDerivedAttributeToDataSet (String dataSetId, String name, String formula, Integer bft, Boolean isTokenStream)

add derived attribute to dataset only with id form, you can add other forms by

Parameters
dataSetId dataset id
name new attribute name
formula formula of form to add, not null
bft base form type of form to add, null or 0 means to be determined by AE
isTokenStream flag to indicate whether the formula is a token stream, false or null means not a token stream
Returns
  • document instance

public abstract RWInstance addDerivedAttributeToTemplate (String key, String name, int axisName, int position, String formula, Integer bft, Boolean isTokenStream)

Adds derived attribute to a template inside document

Parameters
key Grid/graph unit key
name visible attribute name
axisName the name of axis the derived attribute added to
position attribute position in the collection
formula formula of form to add, not null
bft base form type of form to add, null or 0 means to be determined by AE
isTokenStream flag to indicate whether the formula is a token stream, false or null means not a token stream
Returns
  • document instance

public abstract RWInstance addDerivedMetricToDataSet (String id, String formula, String name, boolean aggFromBase)

Adds derived mettic to document data set

Parameters
id data set ID
formula derived metric formula
name visible metric name
aggFromBase flag to indicate whether the metric should aggregate from base.
Returns
  • a RW instance representing document after changes

public abstract RWInstance addDerivedMetricToDataSet (String id, String formula, String name, boolean aggFromBase, boolean isTokenStream)

Adds derived metric to document data set

Parameters
id data set ID
formula derived metric formula
name visible metric name
aggFromBase flag to indicate whether the metric should aggregate from base.
isTokenStream flag to indicate whether the formula is a token stream.
Returns
  • a RW instance representing document after changes

public abstract RWInstance addDerivedMetricToTemplate (String key, String formula, int position, String name, Boolean aggFromBase, Boolean isTokenStream)

Adds derived metric to a template inside document

Parameters
key Grid/graph unit key
formula derived metric formula
position metric position in the collection
name visible metric name
aggFromBase flag to indicate whether the metric should aggregate from base.
isTokenStream flag to indicate whether the formula is a token stream
Returns
  • a RW instance representing document after changes

public abstract RWInstance addDerivedMetricToTemplate (String key, String formula, int position, String name, Boolean aggFromBase)

Adds derived mettic to a template inside document

Parameters
key Grid/graph unit key
formula derived metric formula
position metric position in the collection
name visible metric name
aggFromBase flag to indicate whether the metric should aggregate from base.
Returns
  • a RW instance representing document after changes

public abstract RWInstance addDerivedMetricToTemplate (String key, String formula, int position, String name)

Adds derived mettic to a template inside document

Parameters
key Grid/graph unit key
formula derived metric formula
position metric position in the collection
name visible metric name
Returns
  • a RW instance representing document after changes

public abstract RWInstance addDocumentView (String name, int resolutionX, int resolutionY, int density, int orientation, int index, boolean applyChanges)

Add a new document by duplicating an existing document. Specifying the document view's properties and the source view's index.@return

Parameters
name View name
resolutionX X resolution
resolutionY Y resolution
density density
orientation orientation (values in 0, 1, 2)
index Source document view's index
applyChanges apply Changes

public abstract RWInstance addFormToDerivedAttribute (String attributeId, String dataSetId, String formId, String name, Integer index, String formula, Integer bft, boolean applyChanges)

add one attribute form to derived attribute

Parameters
attributeId derived attribute id
dataSetId data set id
formId id of the system form to add, if null, a new managed form to add
name the new managed form name if formId is null
index the position of this added form, 0 or null means added to the back
formula base form formula, not null
bft base form type, 0 or null means to be determined by AE
applyChanges true to apply changes after this manipulation
Returns
  • document instance after change

public abstract RWInstance addLayout (String key, String beforeKey, String name)

public abstract void addMetric (String keyContext, String unitDisplayName, String unitID, int unitType, int unitPosition)

Add a metric to a gridgraph in an RW

Parameters
keyContext String containing the tree id and grid/graph's RW key
unitID String containing the metric's id
unitType int specifying the metric's type (from EnumDSSXMLObjectTypes)
unitPosition int specifying the new position within the metrics collection

public abstract RWInstance addPercentToTotalMetric (String key, WebPercentToTotalMetric metric)

Adds percent-to-total metric to specified grid

Parameters
key Grid/graph node key
metric metric
Returns
  • RWInstance new instance containing added metric
Throws
IllegalArgumentException
WebObjectsException
IllegalArgumentException
WebObjectsException

public abstract RWInstance addQuickCalculationGroup (String key, String deName, String attId, int depth, int[] ordinals, int function, String sliceId)

public abstract RWInstance addQuickListGroup (String key, String deName, String attId, int depth, int[] ordinals, String sliceId)

public abstract RWInstance addRankMetric (String key, WebRankMetric metric)

Adds new rank metric to specified grid

Parameters
key Grid/graph node key
metric metric
Returns
  • RWInstance new instance containing added metric
Throws
IllegalArgumentException
WebObjectsException
IllegalArgumentException
WebObjectsException

public abstract RWInstance addShortcutMetric (String datasetID, String datasetType, String nodeKey, String treeType, int functionType, int functionType2, List<WebObjectInfo> unitsInfo)

Add shortcut metric to a given dataset and optionally a given template

Parameters
functionType the main function type for the manipulation
functionType2 the optional second function type for the manipulation
unitsInfo the WebObjectInfo collection of the units for the manipulation
Returns

public abstract RWInstance addTemplateFromDataSet (String dataSetId, String key, String parentKey, String name, String left, String top, String width, String height, String zIndex, int displayMode, boolean linked, String styleId, boolean applyToAllViews)

Adds a template unit containing a copy of the data set's template

Parameters
dataSetId data set ID
key new node's key
parentKey a key of the section where a new unit will be created
left left position of the new unit. If this parameter is empty corresponding default vaue is used.
top top position of the new unit. If this parameter is empty corresponding default vaue is used.
width width of the new unit. If this parameter is empty corresponding default vaue is used.
height height of the new unit. If this parameter is empty corresponding default vaue is used.
displayMode displayMode of the new unit. Should be a value from the enumeration EnumDSSXMLDisplayMode. If this parameter is -1, then the value is ignored
linked indicates whether the template being created should be linked to the dataset. If so, the template cannot be modified from within the rwInstance
applyToAllViews apply format to all views
Returns
  • RWInstance new instance
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance addTemplateFromDataSet (String dataSetId, String key, String parentKey, String name, String left, String top, String width, String height, String zIndex, int displayMode, boolean linked, String styleId)

Adds a template unit containing a copy of the data set's template

Parameters
dataSetId data set ID
key new node's key
parentKey a key of the section where a new unit will be created
left left position of the new unit. If this parameter is empty corresponding default vaue is used.
top top position of the new unit. If this parameter is empty corresponding default vaue is used.
width width of the new unit. If this parameter is empty corresponding default vaue is used.
height height of the new unit. If this parameter is empty corresponding default vaue is used.
displayMode displayMode of the new unit. Should be a value from the enumeration EnumDSSXMLDisplayMode. If this parameter is -1, then the value is ignored
linked indicates whether the template being created should be linked to the dataset. If so, the template cannot be modified from within the rwInstance
Returns
  • RWInstance new instance
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance addTemplateFromDataSet (String dataSetId, String key, String parentKey, String name, String left, String top, String width, String height, String zIndex, int displayMode)

Adds a template unit containing a copy of the data set's template

Parameters
dataSetId data set ID
key new node's key
parentKey a key of the section where a new unit will be created
left left position of the new unit. If this parameter is empty corresponding default vaue is used.
top top position of the new unit. If this parameter is empty corresponding default vaue is used.
width width of the new unit. If this parameter is empty corresponding default vaue is used.
height height of the new unit. If this parameter is empty corresponding default vaue is used.
displayMode displayMode of the new unit. Should be a value from the enumeration EnumDSSXMLDisplayMode. If this parameter is -1, then the value is ignored
Returns
  • RWInstance new instance
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance addTransactionReport (String keyContext, String transactionElementID, int transactionElementType, boolean applyChanges)

Associate a transaction report with a rwGridGraph unit or rwFieldGroupUnit

Parameters
transactionElementID String transaction element ID
transactionElementType int transaction element Type
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance advSort (String nodeKey, int treeType, boolean clearSorts, WebSortConfig config, boolean applyNow, boolean isAdvSort)

Apply multiple sort rules to the grid

Parameters
nodeKey The nodeKey for the current grid
treeType The tree type
clearSorts Do we need to clear the current sort definitions that are already applied to the grid
config WebSortConfig
applyNow Do we need to apply the changes now
isAdvSort Is this request come from advanced sort editor, if yes, clear both rows and column definitions
Returns
  • The RWInstance

public abstract RWInstance applyAttributeLinking (boolean unlink, String srcAttrID, String srcFormIDs, String tgtAttrIDs, String tgtFormsIDs)

Apply linking or unlinking attributes

Parameters
unlink indicates unlinking attributes
srcAttrID id of the source attribute
srcFormIDs id of the source attribute's forms, separated by ""
tgtAttrIDs id of the target attributes to be linked or unlinked, separated by ""
tgtFormsIDs id of the target attributes's corresponding form, separated by ""

public abstract RWInstance applyAttributeRemapping (String datasetID, int datasetType, String tarDatasetID, int tarDatasetType, String srcID, String tarID)

Apply or cancel attribute re-mapping

Parameters
datasetID id of the source dataset
datasetType type of the source dataset
tarDatasetID id of the target dataset
tarDatasetType type of the target dataset
srcID source attribute id
tarID target attribute id, if empty, this is cancel link manipulation; else, apply link

public abstract RWInstance applyChanges ()

Applys all accumulated changes

Returns
  • a RW instance representing document after changes

public abstract RWInstance applyGraphControlAction (String nodeKey, int sliceID, int x, int y)

Sects control selection based on graph area

Parameters
nodeKey graph key
sliceID slice ID
x x cursor position
y y cursor position
Returns
  • documrnt instance
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance applySegment (String segmentID, String keyContext, boolean applyChanges)

Apply a Segment to the RWInstance

Parameters
segmentID the ID of the segment to be applied
keyContext String
applyChanges specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes
Throws
WebObjectsException
WebException
WebObjectsException

public abstract RWInstance applyStyleByID (String key, String id)

Apply a style by style DSSID.

Parameters
key the GridGraph object key
id the DSSID of the style object to be applied.
Returns
  • A WebReportInstance object with the applied style.
Throws
IllegalArgumentException Thrown when id is null or empty string.
WebObjectsException Singals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.

public abstract RWInstance applyTheme (String themeID, boolean applyChanges)

Apply theme to this RWInstance

Parameters
themeID the ID of the theme to apply
applyChanges whether to call applyChanges
Returns
  • document instance after changes

public abstract RWInstance applyThemeOnNode (String themeID, RWUnitDef unit, boolean isLink, boolean applyChanges)

Apply theme on specified node

Parameters
themeID the ID of the theme to apply
unit the definition of the node
isLink whether to apply a linked theme, false to apply a copied theme
applyChanges whether to call applyChanges
Returns
  • document instance after changes

public abstract RWInstance cancel (int stateID)

Cancels current updates and resets object to specified state@return

public abstract RWInstance cancel (int stateID, boolean rerun)

Cancels current updates and resets object to specified state@return

public abstract RWInstance changeDerivedAttributeName (String attributeId, String dataSetId, String name)

change derived attribute name

Parameters
attributeId derived attribute id
dataSetId dataset id
name new attribute name
Returns
  • document instance after change

public abstract RWInstance changeDerivedMetric (String metricId, String dataSetId, String formula, String alias)

Changes derived metric

Parameters
metricId metric ID
dataSetId data set ID
formula new metric formula
alias new metric alias
Returns
  • document instance

public abstract RWInstance changeDerivedMetric (String metricId, String dataSetId, String formula, String alias, Boolean isTokenStream, Boolean aggregateFromBase)

Changes derived metric

Parameters
metricId metric ID
dataSetId data set ID
formula new metric formula
alias new metric alias
isTokenStream flag to indicate whether the formula is a token stream.
aggregateFromBase new metric aggregateFromBase
Returns
  • document instance

public abstract RWInstance changeTemplateLinkToDataSet (String key, String dataSetID, boolean linked)

Changes the property of the template from being linked to unlinked or vise-versa

Parameters
key the key of the template node
dataSetID the id of the dataset to which it should be linked or from which it should be unlinked
Throws
WebObjectsException
WebObjectsException

public abstract void changeUnitName (String keyContext, String unitID, int unitType, String unitName)

public abstract RWInstance clearAllSorts (String nodeKey, int treeType)

public abstract RWInstance clearControlSorts (String keyContext, boolean applyChanges)

Clears all sorts for a givent control

Parameters
keyContext String containing tree type, node key, control key
applyChanges boolean specifying whether changes should be applied immediately
Returns
  • either current RWInstance or one generated after applied changes

public abstract void copyToClipboard (String[] keys)

Copies units to clipboard

Parameters
keys array of unit keys

public abstract RWUnitDef copyUnit (String fieldKey, String newKey, String newParentKey, String beforeKey)

Copyes specified unit to specified section

Parameters
fieldKey unit key
newKey a key to be assigned to a new unit
newParentKey key of the section where a copy shall be created
beforeKey if not null represents a key of the new parent section child before which a new unit shall be added
Returns
  • new (copyed) unit

public abstract void cutToClipboard (String[] keys)

Cuts units to clipboard

Parameters
keys array of unit keys

public abstract RWInstance drill (String drillKey, String[] drillElements, Map drillProperties)

Drills on the current RW instance using the drill path key and settings passed as arguments.

Parameters
drillKey This is the key to the drill path to be used for drilling. The drill key can be obtained from WebDrillPath#getKey()
drillElements This is a string array of the drill elements representing the user filter. Each drill element is represented by an identifier (String) that can be obtained from WebHeader#getDrillElement()
drillProperties This should be a map of drill settings that the user wants to override while drilling. The keys in the map should be from EnumWebDrillProperties. Based on the type of drill property (int/boolean), following are the object types that can be passed as values in the Map :
[1] For a drill property that can have integer values, an Integer or String object, wrapping the (integer) value, should be set.
[2] For a drill property that can have only boolean values, a Boolean or String object representing the (boolean) value should be set. The String object should have values {"true", "false", "1", "0"} only.
Returns
  • the new instance upon drilling.
Throws
WebObjectsException signal error encountered by IServer while executing the drill.

public abstract RWInstance duplicatePanel (RWUnitDef panel, String name)

public abstract RWInstance duplicatePanelStacks (String[] keys, String[] names, float offset)

public abstract RWInstance editDocumentView (String name, int resolutionX, int resolutionY, int density, int orientation, int index, boolean applyChanges)

Edit a document view@return

Parameters
name View name
resolutionX X resolution
resolutionY Y resolution
density density
orientation Orientation (values in 0, 1, 2)
index Index of the view to be edited
applyChanges apply Changes

public abstract RWInstance filterOnSelections (String[] drillElements, Map drillProperties, String nodeKey)

public abstract RWInstance forceApplyChanges ()

If we have delta on the manipulator, we must force to apply changes

Returns
  • document instance

public abstract WebPercentToTotalMetric getNewPercentToTotalMetric (String key, WebMetric metric)

Returns a new instance of the WebPercentToTotalMetric object. This derived metric is based on the specified metric on the template or working set.

Parameters
metric The WebMetric object used to create the derived metric.
Returns
Throws
IllegalArgumentException thrown if the metric is null or does not exist in the template or in the working set.
WebObjectsException Signals an error when sending the changes to the Intelligence Server.

public abstract WebRankMetric getNewRankMetric (String key, WebMetric metric)

Returns a new instance of the WebRankMetric object. This derived metric is based on the specified metric on the template or working set.

Parameters
metric The WebMetric object used to create the derived metric.
Returns
Throws
IllegalArgumentException thrown if the metric is null or does not exist in the template or in the working set.
WebObjectsException Signals an error when sending the changes to the Intelligence Server.

public abstract WebSortConfig getNewSortConfig (int sortType)

public abstract RWInstance importDocument (String id, String beforeKey, boolean isTemplate)

public abstract RWInstance makeTabular ()

Makes all grids within this document tabular.

Returns
  • document instance
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance moveLayout (String key, String beforeKey)

public abstract RWUnitDef moveUnit (String key, String newParentKey, String beforeKey)

Moves a unit to a new owner

Parameters
key unit key
newParentKey new parent key
beforeKey before key
Returns
  • the moved unit

public abstract RWUnitDef[] pasteFromClipboard (String newParentKey, String[] newKeys)

Pastes units from clipboard to a subsection

Parameters
newParentKey subsection key
newKeys keys to be assigned to newly created units
Returns
  • an array of newly created units, that are copies of units on clipboard.
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance performActionOnActionSelector (String keyContext, int action, boolean applyChanges)

Perform and action on an ActionSelector.

Parameters
keyContext String
action int EnumDSSXMLRWControlSubsequentAction
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract void pivotTemplateUnit (String keyContext, String unitID, int unitType, int dAxis, int dPos)

Pivot the template unit specified to a new axis and position

Parameters
keyContext String containing the tree id and grid/graph's RW key
unitID String containing the template unit's id. Null for metrics
unitType int specifying the template unit's type (from EnumDSSXMLObjectTypes)
dAxis int specifying the new axis name from EnumDSSXMLAxisName
dPos int specifying the new axis position

public abstract RWInstance populateTemplateFromDataSet (String _dsId, int _dsType, String _templateKey, int _populateOption)

Populates document template unit with data set template

Parameters
_dsId data set ID
_dsType data set type
_templateKey document template unit key
_populateOption populate option
Returns
  • RWInstance document instance
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance redo (int stateID)

public abstract RWInstance refresh (String promptAnswerXML)

Uses the prompt answer to refresh the report.

Returns
  • new instance

public abstract RWInstance refresh (boolean reprompt, boolean rerun)

Refreshes the instance.

Parameters
reprompt whether the prompts will be reopened
rerun whether to re-execute the instance
Returns
  • the new instance
Throws
WebObjectsException if a problem occurs when attempting to rerun

public abstract RWInstance refresh ()

Convenience method. Calls refresh(boolean) with false

Returns
  • new instance

public abstract RWInstance refresh (boolean reprompt, boolean rerun, boolean regenerate)

public abstract RWInstance refresh (boolean reprompt, boolean rerun, boolean regenerate, int stateID)

public abstract RWInstance refresh (boolean reprompt)

Refreshes the current state of the instance. All the changes that have been accumulated thus far are going to be applied

Returns
  • new instance

public abstract RWInstance removeDocumentView (int index, boolean applyChanges)

Remove a document view at specified index@return

Parameters
index The index of the document view to be removed
applyChanges apply Changes

public abstract RWInstance removeFormFromDerivedAttribute (String attributeId, String dataSetId, String formId)

remove attribute form from derived attribute

Parameters
attributeId derived attribute id
dataSetId data set id
formId id of the form to remove
Returns
  • document instance after change

public abstract RWInstance removeLayout (String key)

public abstract RWInstance removeLayout (String key, boolean isCurrent)

public abstract RWInstance removeThemeOnNode (RWUnitDef unit, boolean applyChanges)

remove theme on specified node

Parameters
unit the definition of the node
applyChanges whether to call applyChanges
Returns
  • document instance after changes

public abstract RWInstance removeTransactionInfoOnField (String keyContext, String fieldKey, boolean applyChanges)

Clear the transaction information for text fields

Parameters
keyContext String
fieldKey String nodeKey of the textField
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance removeTransactionInfoOnGridObject (String keyContext, String objectID, int objectType, String attributeFormID, boolean applyChanges)

Clear the transaction information for attribute form/metric on a grid

Parameters
keyContext String
objectID String attributeID/metricID
objectType int the dssType of this unit
attributeFormID String the attribute formID if it is for attributeForm
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance removeTransactionReport (String keyContext, boolean applyChanges)

Parameters
keyContext String
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWUnitDef removeUnit (String key)

Removes a unit with specified key

Parameters
key unit key
Returns
  • a removed unit or null

public abstract RWInstance replaceDataSet (String oldDataSetID, String newDataSetID, int oldDSType, int newDSType)

replace the old dataset with the new one

Parameters
oldDataSetID String
newDataSetID String
oldDSType int old data set type from EnumDSSXMLObjectTypes
newDSType int new data set type from EnumDSSXMLObjectTypes
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance replaceDataSet (String oldDataSetID, String newDataSetID, int oldDSType, int newDSType, boolean applyChanges)

replace the old dataset with the new one

Parameters
oldDataSetID String
newDataSetID String
oldDSType int old data set type from EnumDSSXMLObjectTypes
newDSType int new data set type from EnumDSSXMLObjectTypes
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance resetSelections (String keyContext)

Reset document selections

Parameters
keyContext String if keyContext is null, we'll reset the whole document

public abstract RWInstance setAutomaticTransactionRecordNumber (String keyContext, int recordNumber, boolean applyChanges)

Set the number of rows that will be automatically transacted

Parameters
keyContext String
recordNumber int -1 for all rows, 0 for none, and some value > 0 for a specific number of rows
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setAvailableActionTypesForControl (String keyContext, int actionType, boolean applyChanges)

Set the available control types in a control

Parameters
keyContext String
actionType int refer to EnumDSSXMLRWControlActionType
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setControlAttributeForms (String keyContext, List<String> formIDs, boolean applyChanges)

Set forms for custom control forms

Parameters
keyContext String containing tree type, node key, control key
formIDs List containing String of form IDs
applyChanges boolean specifying whether changes should be applied immediately
Returns
  • either current RWInstance or one generated after applied changes

public abstract RWInstance setControlAttributeFormsDelimeter (String keyContext, String delimiter, boolean applyChanges)

Set delimiter for custom control forms

Parameters
keyContext String containing tree type, node key, control key
delimiter String containing delimiter
applyChanges boolean specifying whether changes should be applied immediately
Returns
  • either current RWInstance or one generated after applied changes

public abstract RWInstance setControlAttributeFormsDisplayType (String keyContext, int displayType, boolean applyChanges)

Set display type for control forms

Parameters
keyContext String containing tree type, node key, control key
displayType int from EnumDSSXMLControlAttributeFormDisplayOption
applyChanges boolean specifying whether changes should be applied immediately
Returns
  • either current RWInstance or one generated after applied changes

public abstract RWInstance setControlCurrentElementStatusToUnset (String keyContext, boolean applyChanges)

Sets the control status to unset

Parameters
keyContext String containing treeType, nodeKey, and controlKey
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setControlDisplayText (String keyContext, String displayText, boolean applyChanges)

Set the display text for the action selector

Parameters
keyContext String
displayText String the text to display for the action selector
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setControlExpression (String keyContext, int controlType, WebExpression expression, boolean applyChanges)

Set the expression for a conditional selector

Parameters
keyContext String containing either control key or treeType|nodeKey|controlKey
controlType int from EnumDSSXMLRWControlType
expression WebExpression object containing expression information
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setControlSubsquentAction (String keyContext, int action, boolean applyChanges)

Set the subsequent action in the action control after submit.

Parameters
keyContext String
action int EnumDSSXMLRWControlSubsequentAction
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setControlSubsquentActionObject (String keyContext, int controlType, String objectID, int objectType, String objectName, boolean applyChanges)

Set the subsequent action in the action control after submit.

Parameters
keyContext String
controlType int EnumDSSXMLRWControlType
objectID String the dssID of the object to be executed after submit
objectType int the dssType of the object to be executed after submit
objectName String the name of the object to be executed after submit
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setControlSubsquentDisplayMessage (String keyContext, String displayMessage, boolean applyChanges)

Set message to display after perform the action using action selector.

Parameters
keyContext String
displayMessage String the message to display after perform the action using action selector
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setControlTexts (String keyContext, List<String> texts, boolean applyChanges)

Sets current control's text selections

Parameters
keyContext String containing either control key or treeType|nodeKey|controlKey
texts list of texts
applyChanges if true the changes will be applied immediately
Returns
  • document instance

public abstract RWInstance setControlUnsetStatus (String keyContext, int unsetStatus, int unsetCount, boolean applyChanges)

Set the unset status of the control specified by keyContext

Parameters
keyContext String containing treeType, nodeKey, and controlKey
unsetStatus int from EnumDSSXMLRWSelectorUnsetStatus
unsetCount int number of elements to be retrieved on Default Selection
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setCurrentControlElements (String key, List elementIds, boolean isInList, boolean applyChanges)

Sets current control selection. Does not change the inList state of selector

Parameters
key control key
elementIds list of selected elements
isInList the current isInList state of the control
applyChanges if true the changes will be applied immediately
Returns
  • document instance
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance setCurrentControlElements (String key, List elementIds, boolean applyChanges)

Sets current control selection

Parameters
key control key
elementIds list of selected elements
applyChanges if true the changes will be applied immediately
Returns
  • document instance
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance setCurrentDocumentView (int index, boolean applyChanges)

set the current document view with the specified index@return

Parameters
index The index of the view to be set as the current document view

public abstract RWInstance setCurrentGroupByElement (String groupKey, String elementId, int flags, boolean applyChanges)

Sets current group by element. If the applyChanges parameters is true, applyChanges() is executed and a new RWInstance containing the selected group-by is returned, otherwise the manipulations is only stored in deltas and the same RWInstance is returned.

Parameters
groupKey group by key
elementId element ID
flags flags controlling group by behavior:
0
- apply group by changes only to the current layout;
1
- apply group by changes to all layouts with matching group by paths;
2
- apply group by changes to all layouts containing changed group by units;
applyChanges whether to call applyChanges
Returns
  • an instance containing new group by page
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance setCurrentGroupByElement (String groupKey, String elementId)

Sets current group by element

Parameters
groupKey group by key
elementId element ID
Returns
  • an instance containing new group by page
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance setCurrentGroupByElement (String groupKey, String elementId, boolean applyChanges)

Sets current group by element. If the applyChanges parameters is true, applyChanges() is executed and a new RWInstance containing the selected group-by is returned, otherwise the manipulations is only stored in deltas and the same RWInstance is returned.

Parameters
groupKey group by key
elementId element ID
applyChanges whether to call applyChanges
Returns
  • an instance containing new group by page
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance setCurrentGroupByElementByUnitID (String unitID, int unitType, String elementId, boolean applyChanges)

Set the current group-by using unitID

Parameters
unitID String GUID of unit
unitType int from EnumDSSXMLObjectTypes
applyChanges boolean specifying whether the changes should be applied after the manipulation
Returns
  • RWInstance containing changes if applyChanges is true. Without changes if applyChanges is false

public abstract RWInstance setCurrentLayout (int index, boolean applyChanges)

Set the current layout by 0-based index

Parameters
index int 0-based index of new layout
Returns
  • RWInstance containing changes

public abstract RWInstance setCurrentLayout (String key)

public abstract void setCurrentPanel (String keyContext, String panelKey)

Sets panel stack current panel

Parameters
keyContext panel stak key in server-specific format
panelKey panel key

public abstract void setDisplayMode (String keyContext, int viewMode)

Sets document template unit display mode

Parameters
keyContext template unit key in server-specific format
viewMode view mode (see EnumWebReportViewMode)

public abstract RWInstance setGridViewFilter (String unitKey, String filterXML)

public abstract RWInstance setNextCurrentGroupByElement (int elementAction)

Movets to another group by element

Parameters
elementAction action from EnumDSSXMLCurrentElementAction
Returns
  • a instance containing new group by page
Throws
WebObjectsException
WebObjectsException

public abstract RWInstance setTemplateUnitProperties (String nodeKey, int treeType, String unitID, int unitType, boolean applyNow)

Apply the changed properties of a template unit@return

public abstract RWInstance setTransactionChangeType (String keyContext, int changeType, boolean applyChanges)

Set the transaction change type in the filed group node or gridGraph node.

Parameters
keyContext String
changeType int EnumDSSXMLRWNodeTransactionChangeType
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setTransactionInfoOnField (String keyContext, String fieldKey, int mappedColumnIndex, int transactionFlags, String inputControlKey, String inputControlProperties, boolean applyChanges)

Set transaction information for text fields

Parameters
keyContext String
fieldKey String nodeKey of the textField
mappedColumnIndex int the columnIndex in the transactionReport this object mapped to
transactionFlags int the new transaction flags refer to EnumDSSXMLUnitTransactionFlags
inputControlKey String the controlKey for the inputControl
inputControlProperties String the control format properties for the inputControl
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance setTransactionInfoOnGridObject (String keyContext, String objectID, int objectType, String attributeFormID, int mappedColumnIndex, int transactionFlags, String inputControlKey, String inputControlProperties, boolean applyChanges)

Set transaction information for attribute form/metric on a grid

Parameters
keyContext String
objectID String attributeID/metricID
objectType int the dssType of this unit
attributeFormID String the attribute formID if it is for attributeForm
mappedColumnIndex int the columnIndex in the transactionReport this object mapped to
transactionFlags int the new transaction flags refer to EnumDSSXMLUnitTransactionFlags
inputControlKey String the controlKey for the inputControl
inputControlProperties String the control format properties for the inputControl
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract RWInstance showAllThresholds (String nodeKey, boolean enable)

Enables/disables report thresholds

Parameters
nodeKey Grid/graph node key
enable if true thresholds are enabled, othrerwise they are disabled
Returns
  • a instance with new data
Throws
WebObjectsException
WebObjectsException

public abstract void showSubtotals (String keyContext, String unitID, int unitType, String subtotalType, boolean isAdd)

public abstract RWInstance sortGrid (String nodeKey, int treeType, boolean clearSorts, WebSortConfig config, boolean applyNow)

public abstract RWInstance toggleDataServeMode (String dsid, int type, int mode)

public abstract RWInstance undo (int stateID, boolean rerun)

public abstract RWInstance undo (int stateID)

public abstract RWInstance updateDerivedAttributeForm (String attributeId, String dataSetId, String formId, String name, String formula, Integer bft, Boolean isTokenStream, Boolean isDisplayForm)

update form of derived attribute

Parameters
attributeId derived attribute id
dataSetId data set id
formId id of the form to update
name new name
formula new base form formula
bft new base form type
isTokenStream true to update the formula with token stream
isDisplayForm true to add the form to display forms collection, false to remove the form from display forms collection, null to do nothing
Returns
  • document instance after change

public abstract void updateTemplateUnits (String keyContext, String unitID, int unitType, int dAxis, int dPos, int actions)

public abstract RWInstance updateTransactionData (String changes, boolean applyChanges)

Modify transaction data in the RWInstance

Parameters
changes String
applyChanges boolean specifying whether to apply the changes now
Returns
  • either current RWInstance or the one generated after the applied changes

public abstract String validateExpression (String tokenStreamXML, boolean isForMetric, int outFlags, int baseFormType)

Check whether the token stream is valid

Parameters
tokenStreamXML the token stream to be validated
isForMetric flag to indicate whether the token stream is for metric
outFlags flags from EnumDSSXMLParserOutFlags indicating which part should be returned.
baseFormType if it's greater than 0, iserver needs to check whether the base form type is compatible with the expression.
Returns
  • parsed token stream xml

public abstract String validateLocalTransactionExpression (WebTokenStream tokenStream, String ctlKey, String nodeKey)

Check whether the token steam is valid

Parameters
nodeKey Grid/graph node key
Returns
  • parsed token stream xml