public interface

WebViewInstance

com.microstrategy.web.objects.WebViewInstance
Known Indirect Subclasses

Class Overview

The WebViewInstance encapsulates a template, the grid, graph data and properties associated with it.

The WebViewInstance cannot exist on its own accord - only as part of the following objects:

  • WebReportInstance. This interface extends the WebViewInstance since all reports have an underlying template.
  • getValue() (tentative, and subject to changes). A WebViewInstance is returned if the unit type is RWUNIT_GRIDGRAPH.
  • getViewInstance() (tentative, and subject to changes). Unlike the instance returned from the RWObject, the WebViewInstance returned here is tied to the template via the RWDefinition, and contains no grid/graph data. This representation is useful in design mode.

Summary

Public Methods
abstract WebDerivedElements getDerivedElements(WebAttribute attribute)
abstract WebDrillInstance getDrillInstance()

Returns the WebDrillInstance associated with this view.

abstract WebGraph getGraphObject()

Returns the WebGraph associated with this view.

abstract WebGridData getGridData()

Returns the WebGridData associated with this view.

abstract WebGridWidths getGridWidths()

Returns a collection describing the various column widths of the underlying grid.

abstract WebExpression getLimitSummary(int flags)
abstract WebTemplate getTemplate()

Returns the WebTemplate associated with this view.

abstract WebPropertySet getTemplatePropertySet(String propertySetName)

Returns the WebPropertySet with the given name.

abstract SimpleList getTemplatePropertySetFilter()

Returns an editable property set filter correponding to main template object properties.

abstract WebPropertyGroup getTemplatePropertySets()

Returns all the property sets in a WebPropertyGroup corresponding to the main template object.

abstract WebVisualizationSettings getVisualizationSettings()
abstract WebWorkingSet getWorkingSet()

Returns the WebWorkingSet associated with this grid/graph object.

abstract boolean isReadOnly()
abstract void setDefaultForTemplateProperty(String propertySetName, String propertyName)
Sets the value for the given property to be the default value for the property.
abstract void setTemplateProperty(String propertySetName, String propertyName, String propertyValue)

Sets the value of a specific property.

abstract Boolean shouldAppendCSS()
Returns whether the CSS provided in this view's XML was partial and should be appended to the current CSS.

Public Methods

public abstract WebDerivedElements getDerivedElements (WebAttribute attribute)

Throws
IllegalArgumentException
UnsupportedOperationException
WebObjectsException

public abstract WebDrillInstance getDrillInstance ()

Returns the WebDrillInstance associated with this view.

Returns
  • the associated drill data
Throws
WebObjectsException if there is a problem retrieving drill data

public abstract WebGraph getGraphObject ()

Returns the WebGraph associated with this view.

Returns
  • the associated graph data
Throws
WebObjectsException if there is a problem retrieving graph data

public abstract WebGridData getGridData ()

Returns the WebGridData associated with this view.

Returns
  • the associated grid data
Throws
WebObjectsException if there is a problem retrieving grid data

public abstract WebGridWidths getGridWidths ()

Returns a collection describing the various column widths of the underlying grid.

Returns
  • the grid column widths collection
Throws
WebObjectsException if there is a problem retrieving the grid column widths

public abstract WebExpression getLimitSummary (int flags)

public abstract WebTemplate getTemplate ()

Returns the WebTemplate associated with this view.

Returns
  • the associated template
Throws
WebObjectsException if there is a problem retrieving the template

public abstract WebPropertySet getTemplatePropertySet (String propertySetName)

Returns the WebPropertySet with the given name.

Parameters
propertySetName name of the property set to retrieve
Returns
  • the property set matching the given property set name
Throws
WebObjectsException if there is a problem retrieving the property set
IllegalArgumentException if the name is empty, or no corresponding WebPropertySet exists

public abstract SimpleList getTemplatePropertySetFilter ()

Returns an editable property set filter correponding to main template object properties.

Returns
  • an editable property set filter

public abstract WebPropertyGroup getTemplatePropertySets ()

Returns all the property sets in a WebPropertyGroup corresponding to the main template object.

Returns
  • the associated property sets corresponding to the main template object
Throws
WebObjectsException if there is a problem retrieving the property sets

public abstract WebVisualizationSettings getVisualizationSettings ()

public abstract WebWorkingSet getWorkingSet ()

Returns the WebWorkingSet associated with this grid/graph object.

Returns
  • the associated working set
Throws
WebObjectsException if there is a problem retrieving the working set

public abstract boolean isReadOnly ()

public abstract void setDefaultForTemplateProperty (String propertySetName, String propertyName)

Sets the value for the given property to be the default value for the property.

Parameters
propertySetName the name of the property set which contains the property to change
propertyName the name of the property to change
Throws
IllegalArgumentException if the property set name or property name is empty or does not exist
WebObjectsException if an error occurs when setting the property value

public abstract void setTemplateProperty (String propertySetName, String propertyName, String propertyValue)

Sets the value of a specific property.

Parameters
propertySetName the property set name
propertyName the property name
propertyValue the property value
Throws
WebObjectsException if there is a problem setting the new value
IllegalArgumentException if no property set name or property name is specified, or they don't exist

public abstract Boolean shouldAppendCSS ()

Returns whether the CSS provided in this view's XML was partial and should be appended to the current CSS. If no CSS is available, then null is returned.

Returns
  • boolean whether the received CSS should be appended to the current CSS, otherwise null indicates no CSS is available