Package com.microstrategy.web.objects.rw

Interface RWDefinition

  • public interface RWDefinition
    Represents RW report definition
    Since:
    MicroStrategy Web 8.0.0

    • Method Detail

      • getRwInstance

        RWInstance getRwInstance()
        Returns parent instance
        Returns:
        parent instance

      • getRootSection

        RWSectionDef getRootSection()
        Returns root document definition section.
        Returns:
        root document definition section

      • findUnit

        RWUnitDef findUnit​(java.lang.String key)
        Finds a unit with specified key in the hierarchy
        Parameters:
        key - unit key
        Returns:
        a unit or null

      • findUnitAnywhere

        RWUnitDef findUnitAnywhere​(java.lang.String key)
        Looks for a unit with specified key in hierarchy and in clipboard
        Parameters:
        key - unit key
        Returns:
        a unit or null
        Since:
        MicroStrategy Web 8.1.0

      • getDefaultFormat

        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.

      • getFormatTypes

        int[] getFormatTypes​(int unitType)
        Returns a list of format types applicable to a given unit type
        Parameters:
        unitType - unit type
        Returns:
        format types
        Since:
        MicroStrategy Web 8.1.0

      • getDefaultFormat

        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
        Since:
        MicroStrategy Web 8.1.0

      • getGroupBys

        RWGroupBys getGroupBys()
        Returns group by collection
        Returns:
        group by collection

      • getDataSets

        RWDataSets getDataSets()
        Returns a data set collection
        Returns:
        a data set collection

      • getID

        java.lang.String getID()
        Returns the definition object DSS ID
        Returns:
        the definition object DSS ID

      • getName

        java.lang.String getName()
        Returns the definition object name
        Returns:
        the definition object name

      • getKeySeed

        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.

      • getPlaceHolderIndexSeed

        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.

      • setDefaultFormat

        void setDefaultFormat​(RWUnitDef unit)
        Copies unit's format into corresponding control default format
        Parameters:
        unit - unit whose format will be copied

      • getClipboard

        RWClipboard getClipboard()
        Returns clipboard
        Returns:
        clipboard

      • hasEnabledThresholds

        boolean hasEnabledThresholds()
                      throws WebObjectsException
        Returns true if document has at least one enabled threshold
        Returns:
        true if document has at least one enabled threshold
        Throws:
        WebObjectsException

      • setThresholdsEnabled

        void setThresholdsEnabled​(boolean value)
                   throws WebObjectsException
        Enables/disables all document threshods
        Parameters:
        value - indicaste whether thresholds shall be anabled or disabled
        Throws:
        WebObjectsException

      • toggleThresholds

        boolean toggleThresholds()
                  throws WebObjectsException
        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

      • canToggleThresholds

        boolean canToggleThresholds()
                     throws WebObjectsException
        Returns true if thresholds can be toggled.
        Returns:
        true if thresholds can be toggled.
        Throws:
        WebObjectsException

      • findUnitsByType

        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.
        Since:
        MicroStrategy Web 8.0.1

      • findUnits

        RWUnitDef[] findUnits​(int type,
                      java.lang.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.
        Since:
        MicroStrategy Web 8.1.1

      • findControl

        RWControl findControl​(java.lang.String key)
        Finds control for specified control key
        Parameters:
        key - control key
        Returns:
        control
        Since:
        MicroStrategy Web 8.1.0

      • isMultiLayout

        boolean isMultiLayout()
        Since:
        MicroStrategy Web 9.0.0

      • getLayoutCount

        int getLayoutCount()
        Returns number of layouts in the document
        Returns:
        int
        Since:
        MicroStrategy Web 9.0.0

      • getLayout

        RWLayoutSectionDef getLayout​(int i)
        Returns a layout infor structure.
        Parameters:
        i - layout index
        Returns:
        layout info structure
        Since:
        MicroStrategy Web 9.0.0

      • getAutoKey

        java.lang.String getAutoKey()
        Since:
        MicroStrategy Web 9.0.0

      • getAutoKey

        java.lang.String getAutoKey​(java.lang.String prefix)
        Returns a new unique key.
        Parameters:
        prefix - This argument is added to the key as a prefix.
        Returns:
        A new unique key.

      • getContentNode

        RWUnitDef getContentNode()
        Since:
        MicroStrategy Web 9.0.0

      • hasULGroupBys

        boolean hasULGroupBys()
        Since:
        MicroStrategy Web 9.0.1

      • getTransactionElements

        java.util.List<TransactionElement> getTransactionElements()
        Returns:
        a list of transaction elements associated with this document

      • findControl

        RWControl findControl​(java.lang.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

      • hasOfflineTransaction

        boolean hasOfflineTransaction()

      • getAttributeLinks

        RWAttributeLinks getAttributeLinks()
        Returns attribute links on document
        Returns:
        attribute links on document, or null if this document contains no attribute links
        Since:
        MicroStrategy Web Polaris

      • getTheme

        java.lang.String getTheme()
        Returns the Theme object ID associated with the document
        Since:
        MicroStrategy 10.2