Package com.microstrategy.web.objects.rw

Interface RWDataSet

  • All Superinterfaces:
    RWDataSetInfo
    public interface RWDataSet
extends RWDataSetInfo
    Represents data set for a RW document
    Since:
    MicroStrategy Web 8.0.0

    • Method Detail

      • getFilter

        WebFilter getFilter()
             throws WebObjectsException
        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.

      • getFilter

        WebFilter getFilter​(boolean populate)
             throws WebObjectsException
        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.

      • getWorkingSet

        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.

      • getUserMetrics

        RWUserMetrics getUserMetrics()
        Returns a collection of user metrics
        Returns:
        a collection of user metrics

      • setJoinPrimary

        void setJoinPrimary​(boolean value)
        Since:
        MicroStrategy Web 9.0.0

      • isAvaliableUCTarget

        boolean isAvaliableUCTarget()
        Returns a flag to inform whether this data set can be UC target

      • isRemappable

        boolean isRemappable()
        Specify if current dataset is remappable Not Mappable = {ROLAP report} or {view report} or {user does not have Write access}
        Since:
        MicroStrategy Web 9.3.1

      • isManaged

        boolean isManaged()
        Specify if current dataset is a managed dataset.
        Returns:

      • getUserAttributes

        RWUserAttributes getUserAttributes()
        Returns a collection of user attributes(drived attribute)
        Returns:
        a collection of user attributes(drived attribute)

      • getDatasetMode

        int getDatasetMode()
        Gets the dataset mode.
        Returns:
        Since:
        Polaris

      • getTables

        java.util.List<WebTable> getTables()

      • getID

        java.lang.String getID()