Package com.microstrategy.web.objects

Interface WebViewInstance

All Known Subinterfaces:

WebReportInstance

public interface WebViewInstance

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.
• RWObject.getValue() (tentative, and subject to changes). A WebViewInstance is returned if the unit type is EnumRWUnitTypes.RWUNIT_GRIDGRAPH.
• RWGridGraphDef.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.

Since:

MicroStrategy Web 8.0.0

See Also:

WebReportInstance, RWObject.getValue(), RWGridGraphDef.getViewInstance()

Method Summary

Modifier and Type	Method	Description
WebDerivedElements	getDerivedElements(WebAttribute attribute)
WebDrillInstance	getDrillInstance()	Returns the WebDrillInstance associated with this view.
WebGraph	getGraphObject()	Returns the WebGraph associated with this view.
WebGridData	getGridData()	Returns the WebGridData associated with this view.
WebGridWidths	getGridWidths()	Returns a collection describing the various column widths of the underlying grid.
WebExpression	getLimitSummary(int flags)
WebTemplate	getTemplate()	Returns the WebTemplate associated with this view.
WebPropertySet	getTemplatePropertySet(java.lang.String propertySetName)	Returns the WebPropertySet with the given name.
SimpleList	getTemplatePropertySetFilter()	Returns an editable property set filter correponding to main template object properties.
WebPropertyGroup	getTemplatePropertySets()	Returns all the property sets in a WebPropertyGroup corresponding to the main template object.
WebVisualizationSettings	getVisualizationSettings()
WebWorkingSet	getWorkingSet()	Returns the WebWorkingSet associated with this grid/graph object.
boolean	isReadOnly()
void	setDefaultForTemplateProperty(java.lang.String propertySetName, java.lang.String propertyName)	Sets the value for the given property to be the default value for the property.
void	setTemplateProperty(java.lang.String propertySetName, java.lang.String propertyName, java.lang.String propertyValue)	Sets the value of a specific property.
java.lang.Boolean	shouldAppendCSS()	Returns whether the CSS provided in this view's XML was partial and should be appended to the current CSS.

Method Detail

getTemplate

WebTemplate getTemplate()
                 throws WebObjectsException

Returns the WebTemplate associated with this view.

Returns:

the associated template

Throws:

WebObjectsException - if there is a problem retrieving the template

getGridData

WebGridData getGridData()
                 throws WebObjectsException

Returns the WebGridData associated with this view.

Returns:

the associated grid data

Throws:

WebObjectsException - if there is a problem retrieving grid data

getGraphObject

WebGraph getGraphObject()
                 throws WebObjectsException

Returns the WebGraph associated with this view.

Returns:

the associated graph data

Throws:

WebObjectsException - if there is a problem retrieving graph data

getDrillInstance

WebDrillInstance getDrillInstance()
                           throws WebObjectsException

Returns the WebDrillInstance associated with this view.

Returns:

the associated drill data

Throws:

WebObjectsException - if there is a problem retrieving drill data

getWorkingSet

WebWorkingSet getWorkingSet()
                     throws WebObjectsException

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

getTemplatePropertySetFilter

SimpleList getTemplatePropertySetFilter()

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

Returns:

an editable property set filter

getTemplatePropertySets

WebPropertyGroup getTemplatePropertySets()
                                  throws WebObjectsException

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

getTemplatePropertySet

WebPropertySet getTemplatePropertySet(java.lang.String propertySetName)
                               throws WebObjectsException,
                                      java.lang.IllegalArgumentException

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

java.lang.IllegalArgumentException - if the name is empty, or no corresponding WebPropertySet exists

setTemplateProperty

void setTemplateProperty(java.lang.String propertySetName,
                         java.lang.String propertyName,
                         java.lang.String propertyValue)
                  throws WebObjectsException,
                         java.lang.IllegalArgumentException

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

java.lang.IllegalArgumentException - if no property set name or property name is specified, or they don't exist

setDefaultForTemplateProperty

void setDefaultForTemplateProperty(java.lang.String propertySetName,
                                   java.lang.String propertyName)
                            throws java.lang.IllegalArgumentException,
                                   WebObjectsException

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:

java.lang.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

getVisualizationSettings

WebVisualizationSettings getVisualizationSettings()
                                           throws WebObjectsException

Throws:

WebObjectsException

Since:

MicroStrategy Web 8.0.2

getGridWidths

WebGridWidths getGridWidths()
                     throws WebObjectsException

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

isReadOnly

boolean isReadOnly()

getLimitSummary

WebExpression getLimitSummary(int flags)
                       throws WebObjectsException

Throws:

WebObjectsException

Since:

MicroStrategy Web 9.0.0

shouldAppendCSS

java.lang.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

getDerivedElements

WebDerivedElements getDerivedElements(WebAttribute attribute)
                               throws WebObjectsException,
                                      java.lang.UnsupportedOperationException,
                                      java.lang.IllegalArgumentException

Throws:

WebObjectsException

java.lang.UnsupportedOperationException

java.lang.IllegalArgumentException