Interface WebDimtyPrompt

    • Method Detail

      • getAnswer

        WebDimty getAnswer()
        Returns the current prompt answer
        Returns:
        the current prompt answer
      • setAnswer

        WebDimty setAnswer​(WebDimty 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

        WebDimty getDefaultAnswer()
        Returns the default prompt answer
        Returns:
        the default prompt answer
      • getPreviousAnswer

        WebDimty getPreviousAnswer()
        Returns the previous prompt answer
        Returns:
        the previous prompt answer
      • getSuggestedAnswers

        WebFolder getSuggestedAnswers()
        Returns a read-only folder containing suggested answer objects or null if no suggested answers are defined. This list will be used in building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()).
        Returns:
        a read-only folder containing suggested answer objects or null
      • getSuggestedAnswers

        WebFolder getSuggestedAnswers​(boolean createIfNull)
        Since:
        MicroStrategy Web 9.0.0
      • getSearchRestriction

        WebSearch getSearchRestriction()
        Returns the search restriction for building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()). If the predefined list of suggested answers is not empty (see getSuggestedAnswers) and no search restriction is defined, then this method will return null. If neither suggested answers list nor search restriction is defined this method will return a default search restriction that will search for all objects of type dimension and attribute in the project.
        Returns:
        the search restriction object or null.
      • setSearchRestriction

        void setSearchRestriction​(WebSearch search)
        Sets the search restriction for building available answers collection (see WebDisplayHelper.getAvailableDisplayUnits()). The search restriction must return only objects of type dimension and attribute
        Parameters:
        search - a search restriction.