public interface

RWDataSet

implements RWDataSetInfo
com.microstrategy.web.objects.rw.RWDataSet

Class Overview

Represents data set for a RW document

Summary

Public Methods
abstract KeyedList<RWDataSetItem> getAllUnits()
abstract int getDatasetMode()
Gets the dataset mode.
abstract WebFilter getFilter(boolean populate)
Returns a WebExpression object, which can be used to modify the report's view filter.
abstract WebFilter getFilter()
Returns the current state of the view filter object, according to the Intelligence Server.
abstract String getID()
abstract int getReportType()
Gets the report type.
abstract List<WebTable> getTables()
abstract KeyedList<RWUnitInfo> getUnitInfos()
get the UnitInfo list of this dataset
abstract RWUserAttributes getUserAttributes()
Returns a collection of user attributes(drived attribute)
abstract RWUserDEObjects getUserDEObjects()
abstract RWUserMetrics getUserMetrics()
Returns a collection of user metrics
abstract WebWorkingSet getWorkingSet()
Returns a WebWorkingSet object, which can be used to get the working set objects, the base filter of a report instance, or perform other operations relating to the working set of the report.
abstract boolean isAvaliableUCTarget()
Returns a flag to inform whether this data set can be UC target
abstract boolean isManaged()
Specify if current dataset is a managed dataset.
abstract boolean isRemappable()
Specify if current dataset is remappable Not Mappable = {ROLAP report} or {view report} or {user does not have Write access}
abstract void setJoinPrimary(boolean value)
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.RWDataSetInfo

Public Methods

public abstract KeyedList<RWDataSetItem> getAllUnits ()

public abstract int getDatasetMode ()

Gets the dataset mode.

public abstract WebFilter getFilter (boolean populate)

Returns a WebExpression object, which can be used to modify the report's view filter. The populate argument will tell whether or not the returned WebFilter should be populated with XML from the Intelligence server. If populate is false, then an empty WebFilter object should be returned instead.

Parameters
populate True if the returned filter should be populated, false if it should not be populated before returning.
Returns
  • A WebFilter object, which can be used to modify the view filter.
Throws
WebObjectsException Signals an error occurred while obtaining the view filter XML from the Intelligence Server.

public abstract WebFilter getFilter ()

Returns the current state of the view filter object, according to the Intelligence Server.

Returns
  • A WebFilter object, which represents the current state of the view filter. This can be used to modify the view filter.
Throws
WebObjectsException Signals an error occurred while obtaining the view filter XML from the Intelligence Server.

public abstract String getID ()

public abstract int getReportType ()

Gets the report type.

public abstract List<WebTable> getTables ()

public abstract KeyedList<RWUnitInfo> getUnitInfos ()

get the UnitInfo list of this dataset

public abstract RWUserAttributes getUserAttributes ()

Returns a collection of user attributes(drived attribute)

Returns
  • a collection of user attributes(drived attribute)

public abstract RWUserDEObjects getUserDEObjects ()

public abstract RWUserMetrics getUserMetrics ()

Returns a collection of user metrics

Returns
  • a collection of user metrics

public abstract WebWorkingSet getWorkingSet ()

Returns a WebWorkingSet object, which can be used to get the working set objects, the base filter of a report instance, or perform other operations relating to the working set of the report.

Returns
  • A WebWorkingSet object which gives access to working set functionality.
Throws
WebObjectsException Thrown if the working set XML is not cached in the report instance, and an error occurs when retrieving it from the Intelligence Server.

public abstract boolean isAvaliableUCTarget ()

Returns a flag to inform whether this data set can be UC target

public abstract boolean isManaged ()

Specify if current dataset is a managed dataset.

public abstract boolean isRemappable ()

Specify if current dataset is remappable Not Mappable = {ROLAP report} or {view report} or {user does not have Write access}

public abstract void setJoinPrimary (boolean value)