Interface WebObjectsPrompt

    • Method Detail

      • getAnswer

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

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

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

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

        WebFolder getSuggestedAnswers()
        Returns a folder object containing suggested answers or null.
        Returns:
        a folder object containing suggested answers or null.
      • getSuggestedAnswers

        WebFolder getSuggestedAnswers​(boolean createIfNull)
        Returns the collection of suggested answers. If createIfNull is passed as true, and there exists no collection, then an empty one will be created. If the prompt object refers to a prompt definition, rather than a prompt question, then the collection will be editable.
        Parameters:
        createIfNull - Whether to create a new empty collection if one is not found.
        Returns:
        A WebFolder containing the suggested answers.
        Since:
        MicroStrategy Web 9.0.0
      • getSearchRestriction

        WebSearch getSearchRestriction()
        Returns a search object that shall be used to get a list of possible answers if the suggested answers list is empty.
        Returns:
        a search object that shall be used to get a list of possible answers if the suggested answers list is empty.
      • setSearchRestriction

        void setSearchRestriction​(WebSearch search)
        Sets a search object that shall be used to get a list of possible answers if the suggested answers list is empty.
        Parameters:
        search - a search object that shall be used to get a list of possible answers if the suggested answers list is empty.
      • removeSuggestedAnswers

        void removeSuggestedAnswers()