Package com.microstrategy.web.objects

Interface WebElementsPrompt

    • Method Detail

      • getAnswer

        WebElements getAnswer()
        Returns the current prompt answer. If there is no answer available, an empty WebElements is returned, which can be used to build answer.
        Returns:
        the current prompt answer

      • setAnswer

        WebElements setAnswer​(WebElements answer)
        Sets the current prompt answer. Internally this method creates a new copy of the answer object and stores it as the current answer. (If the answer object is the same as the current answer no copy is created).
        Parameters:
        answer - a prompt answer
        Returns:
        a current answer that is a newly created copy of the answer object.

      • getDefaultAnswer

        WebElements getDefaultAnswer()
        Returns the default prompt answer
        Returns:
        the default prompt answer

      • getPreviousAnswer

        WebElements getPreviousAnswer()
        Returns the previous prompt answer
        Returns:
        the previous prompt answer

      • getOrigin

        WebAttribute getOrigin()
        Returns a source attribute for the prompt.
        Returns:
        a source attribute for the prompt.

      • setOrigin

        void setOrigin​(WebAttribute attr)
        Sets the source attribute for the prompt.
        Parameters:
        attr - The source attribute to be used.
        Since:
        MicroStrategy Web 9.0.0

      • getSuggestedAnswers

        WebElements getSuggestedAnswers()
        Returns the collection of suggested answer elements or null if no suggested answers are defined. This list will be used in building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()).
        Returns:
        A collection of suggested answer elements or null

      • getSuggestedAnswers

        WebElements getSuggestedAnswers​(boolean createIfNull)
        Returns a collection of suggested answer elements. If createIfNull is true, then a new collection will be created if one does not already exists.
        Parameters:
        createIfNull - Whether to create if null.
        Returns:
        A WebElements collection.
        Since:
        MicroStrategy Web 9.0.0

      • setFilterRestriction

        void setFilterRestriction​(WebFilter filter)
        Sets the filter restriction for building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()). Note that this only affects the temporary filter restriction - i.e. the one used immediately for retrieving elements. If editing a prompt definition, then setFilterRestriction will set the filter expression to be used as the filter in the prompt definition.
        Parameters:
        filter - the filter restriction object or null.

      • getDefinitionFilter

        WebFilter getDefinitionFilter()
        Returns the filter restriction that is used for building the available answers restriction, absent any changes made as a result of user-entered searches.
        Returns:
        A WebFilter object representing the filter defined on the prompt.
        Since:
        MicroStrategy Web 9.0.0

      • setDefinitionFilter

        void setDefinitionFilter​(WebFilter filter)
                  throws WebObjectsException
        Sets the filter restriction used for building the available answers restriction, absent any changes made as a result of user-entered searches. Note that calling this method with null as the argument will cause the filter to be cleared.
        Parameters:
        filter - The WebFilter that is to be used as the filter restriction on the definition.
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 9.0.0

      • setBlockBegin

        void setBlockBegin​(int val)
        Sets the blockBegin setting, which is used for incremental fetch of elements. This value tells the index of the first element in the collection to be retrieved. This value is usually used in conjunction with blockCount.
        Parameters:
        val - The blockBegin setting to be used upon populating the elements collection from the Intelligence Server.

      • getBlockBegin

        int getBlockBegin()
        Returns the current blockBegin setting, which is used for incremental fetch of attribute elements. This value tells the index of the first element in the collection to be retrieved. This value is usually used in conjunction with blockCount.
        Returns:
        The current blockBegin setting.

      • setBlockCount

        void setBlockCount​(int val)
        Sets the blockCount setting, which is used for incremental fetch of elements. This value tells the number of elements to be retrieved. This value is usually used in conjunction with blockBegin.
        Parameters:
        val - The blockCount setting to be used upon populating the collection from the Intelligence Server.

      • getBlockCount

        int getBlockCount()
        Returns the current blockCount setting, which is used for incremental fetch of elements. This value tells the number of objects to be retrieved. This value is usually used in conjunction with blockBegin .
        Returns:
        The current blockCount setting.