public interface

RWDefinition

com.microstrategy.web.objects.rw.RWDefinition

Class Overview

Represents RW report definition

Summary

Public Methods
abstract boolean canToggleThresholds()
Returns true if thresholds can be toggled.
abstract RWControl findControl(String key)
Finds control for specified control key
abstract RWControl findControl(String key, boolean includeDDIC)
Finds control and data drive input control(DDIC) for specified control key
abstract RWUnitDef findUnit(String key)
Finds a unit with specified key in the hierarchy
abstract RWUnitDef findUnitAnywhere(String key)
Looks for a unit with specified key in hierarchy and in clipboard
abstract RWUnitDef[] findUnits(int type, String name)
This method will attempt to find all units with the given type and name in the definition's node tree.
abstract RWUnitDef[] findUnitsByType(int type)
This method will attempt to find all units with the given type in the definition's node tree.
abstract RWAttributeLinks getAttributeLinks()
Returns attribute links on document
abstract String getAutoKey()
abstract String getAutoKey(String prefix)
Returns a new unique key.
abstract RWClipboard getClipboard()
Returns clipboard
abstract RWUnitDef getContentNode()
abstract RWLayoutSectionDef getCurrentLayout()
abstract RWDataSets getDataSets()
Returns a data set collection
abstract WebFormat getDefaultFormat(int unitType, int formatType)
Retruns a format object for a given unit type and format type
abstract WebFormat getDefaultFormat(int unitType)
Returns a WebFormat object that contains only applicable properties for specified unit type.
abstract RWDocumentViews getDocumentViews()
abstract FilterDetailsFormatting getFilterDetailsFormatting()
abstract int[] getFormatTypes(int unitType)
Returns a list of format types applicable to a given unit type
abstract RWGroupBys getGroupBys()
Returns group by collection
abstract String getID()
Returns the definition object DSS ID
abstract int getKeySeed()
Returns a value that is greater then any existing key in the definition objects hierarchy.
abstract RWLayoutSectionDef getLayout(int i)
Returns a layout infor structure.
abstract int getLayoutCount()
Returns number of layouts in the document
abstract String getName()
Returns the definition object name
abstract int getPlaceHolderIndexSeed()
Returns a value that is greater than any existing place holder index in the definition objects hierarchy.
abstract RWSectionDef getRootSection()
Returns root document definition section.
abstract RWInstance getRwInstance()
Returns parent instance
abstract String getTheme()
Returns the Theme object ID associated with the document
abstract List<TransactionElement> getTransactionElements()
abstract boolean hasEnabledThresholds()
Returns true if document has at least one enabled threshold
abstract boolean hasOfflineTransaction()
abstract boolean hasThresholds()
Returns true if document has thresholds
abstract boolean hasULGroupBys()
abstract boolean isMultiLayout()
abstract void setDefaultFormat(RWUnitDef unit)
Copies unit's format into corresponding control default format
abstract void setThresholdsEnabled(boolean value)
Enables/disables all document threshods
abstract boolean toggleThresholds()
If document has at list enabled threshold all threshold will be enabled, otherwise all thresholds will be disabled

Public Methods

public abstract boolean canToggleThresholds ()

Returns true if thresholds can be toggled.

Returns
  • true if thresholds can be toggled.
Throws
WebObjectsException

public abstract RWControl findControl (String key)

Finds control for specified control key

Parameters
key control key
Returns
  • control

public abstract RWControl findControl (String key, boolean includeDDIC)

Finds control and data drive input control(DDIC) for specified control key

Parameters
key control key
includeDDIC whether to include DDIC
Returns
  • control and

public abstract RWUnitDef findUnit (String key)

Finds a unit with specified key in the hierarchy

Parameters
key unit key
Returns
  • a unit or null

public abstract RWUnitDef findUnitAnywhere (String key)

Looks for a unit with specified key in hierarchy and in clipboard

Parameters
key unit key
Returns
  • a unit or null

public abstract RWUnitDef[] findUnits (int type, String name)

This method will attempt to find all units with the given type and name in the definition's node tree.

Parameters
type The type of units to find, from EnumRWUnitTypes.
name The name of the unit to find.
Returns
  • An array of the units with the given type. If there exist no units with the given type, this will be an empty array.

public abstract RWUnitDef[] findUnitsByType (int type)

This method will attempt to find all units with the given type in the definition's node tree.

Parameters
type The type of units to find, from EnumRWUnitTypes.
Returns
  • An array of the units with the given type. If there exist no units with the given type, this will be an empty array.

public abstract RWAttributeLinks getAttributeLinks ()

Returns attribute links on document

Returns
  • attribute links on document, or null if this document contains no attribute links

public abstract String getAutoKey ()

public abstract String getAutoKey (String prefix)

Returns a new unique key.

Parameters
prefix This argument is added to the key as a prefix.
Returns
  • A new unique key.

public abstract RWClipboard getClipboard ()

Returns clipboard

Returns
  • clipboard

public abstract RWUnitDef getContentNode ()

public abstract RWLayoutSectionDef getCurrentLayout ()

public abstract RWDataSets getDataSets ()

Returns a data set collection

Returns
  • a data set collection

public abstract WebFormat getDefaultFormat (int unitType, int formatType)

Retruns a format object for a given unit type and format type

Parameters
unitType unit type
formatType format type
Returns
  • format object

public abstract WebFormat getDefaultFormat (int unitType)

Returns a WebFormat object that contains only applicable properties for specified unit type. This object shall be used only for checking which properties are applicable. The property values in this object have no meaning.

Parameters
unitType a unit type
Returns
  • a copyable format object.

public abstract RWDocumentViews getDocumentViews ()

public abstract FilterDetailsFormatting getFilterDetailsFormatting ()

public abstract int[] getFormatTypes (int unitType)

Returns a list of format types applicable to a given unit type

Parameters
unitType unit type
Returns
  • format types

public abstract RWGroupBys getGroupBys ()

Returns group by collection

Returns
  • group by collection

public abstract String getID ()

Returns the definition object DSS ID

Returns
  • the definition object DSS ID

public abstract int getKeySeed ()

Returns a value that is greater then any existing key in the definition objects hierarchy.

Returns
  • a value that is greater then any existing key in the definition objects hierarchy.

public abstract RWLayoutSectionDef getLayout (int i)

Returns a layout infor structure.

Parameters
i layout index
Returns
  • layout info structure

public abstract int getLayoutCount ()

Returns number of layouts in the document

Returns
  • int

public abstract String getName ()

Returns the definition object name

Returns
  • the definition object name

public abstract int getPlaceHolderIndexSeed ()

Returns a value that is greater than any existing place holder index in the definition objects hierarchy.

Returns
  • a value that is greater than any existing place holder index in the definition objects hierarchy.

public abstract RWSectionDef getRootSection ()

Returns root document definition section.

Returns
  • root document definition section

public abstract RWInstance getRwInstance ()

Returns parent instance

Returns
  • parent instance

public abstract String getTheme ()

Returns the Theme object ID associated with the document

public abstract List<TransactionElement> getTransactionElements ()

Returns
  • a list of transaction elements associated with this document

public abstract boolean hasEnabledThresholds ()

Returns true if document has at least one enabled threshold

Returns
  • true if document has at least one enabled threshold
Throws
WebObjectsException

public abstract boolean hasOfflineTransaction ()

public abstract boolean hasThresholds ()

Returns true if document has thresholds

Returns
  • true if document has thresholds
Throws
WebObjectsException

public abstract boolean hasULGroupBys ()

public abstract boolean isMultiLayout ()

public abstract void setDefaultFormat (RWUnitDef unit)

Copies unit's format into corresponding control default format

Parameters
unit unit whose format will be copied

public abstract void setThresholdsEnabled (boolean value)

Enables/disables all document threshods

Parameters
value indicaste whether thresholds shall be anabled or disabled
Throws
WebObjectsException

public abstract boolean toggleThresholds ()

If document has at list enabled threshold all threshold will be enabled, otherwise all thresholds will be disabled

Returns
  • true if all thresholds are enabled, false otherwise.
Throws
WebObjectsException