WebElementsPromptAnswer

implements WebPromptAnswer
com.microstrategy.web.objects.WebElementsPromptAnswer
Class Overview

The WebElementsPromptAnswer interface represents a user answer to WebElementsPrompt.




















Summary


















  [Expand]
  Inherited Constants







  From interface
com.microstrategy.utils.serialization.EnumWebPersistableState

  
  
  
    
    

    
    
        int
        MAXIMAL_STATE_INFO
        Specifies maximal state information to save 
 This type of state (of a component) usually represents the complete definition
 of the component (including all the changes that may have been made to it)
 
    
    
    
    
        int
        MINIMAL_STATE_INFO
        Specifies that only the minimal state information to save 
 
    
    
    
    
        int
        TYPICAL_STATE_INFO
        Specifies typical state information to save 
 This type of state (of a component) usually represents information about its
 initialization and all the changes that have been made to the component.
    
    
    

  































Public Methods



	 
    
        
            abstract
            
            
            
            
            WebElements
        
        
        getAnswer()
        
        Returns the prompt answer to an elements prompt.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setAnswer(WebElements answer)
        
        Sets an elements prompt answer.
  
  













  [Expand]
  Inherited Methods




  
From interface

  com.microstrategy.utils.KeyedObject


  
  
  
    
    


	 
    
        
            abstract
            
            
            
            
            Object
        
        
        _getObKey()
        
  



  









  
From interface

  com.microstrategy.utils.serialization.Persistable


  
  
  
    
    


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        restoreState(String state)
        
        Restores a component based on its saved state.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs)
        
        Restores a component from an embedded XML during a SAX parsing.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        saveState()
        
        Returns a java.lang.String representaion of a component.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        saveState(int howMuchState)
        
        Returns a java.lang.String representaion of a component.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        saveState(StringBuffer buf, int howMuchState)
        
        Saves and stores a component's state into a StringBuffer.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        saveState(StringBuffer buf, int howMuchState, int stateFlag)
        
        Saves and stores a component's state into a StringBuffer.
  
  



  







  
From interface

  com.microstrategy.web.objects.WebDisplayUnit


  
  
  
    
    


	 
    
        
            abstract
            
            
            
            
            void
        
        
        addDetails(boolean details)
        
        This method will add or remove details from the display unit.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
        
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        canHighlight()
        
  


	 
    
        
            abstract
            
            
            
            
            WebDisplayUnits
        
        
        getChildUnits()
        
        Returns the collection of child display units, or null if the object is
 not a collection.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getDisplayName()
        
        Returns the display name associated with this object.
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getDisplayUnitType()
        
        Returns the type of display unit that this object represents.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getID()
        
        Returns the DSS ID of the display unit.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        hasDetails()
        
        Returns whether this display unit currently has details enabled.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        highlightUnit()
        
        Sets this display unit to be highlighted.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        highlightUnit(boolean details)
        
        Sets this display unit to be highlighted.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isHighlighted()
        
        Returns whether this unit is highlighted.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isObjectInfo()
        
        Returns true if underlying Web Object can be cast to WebObjectInfo.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isSelected()
        
        Returns whether this display unit is selected.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setDisplayName(String displayName)
        
        This method will set the value of the display name.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setSelected(boolean selected)
        
        Sets the current unit's selection status.
  
  



  







  
From interface

  com.microstrategy.web.objects.WebFeatures


  
  
  
    
    


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isFeatureAvailable(String feature, Object dependencyObject)
        
        Returns whether the given feature is available or not.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isFeatureAvailable(String feature)
        
        Returns whether the given feature is available or not.
  
  



  







  
From interface

  com.microstrategy.web.objects.WebObjectInfo


  
  
  
    
    


	 
    
        
            abstract
            
            
            
            
            void
        
        
        buildShortObjectAttributes(WebXMLBuilder builder)
        
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        buildShortXML(WebXMLBuilder builder)
        
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getAbbreviation()
        
        Returns the abbreviation of this object.
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getAccessGranted()
        
        Returns the current access granted on this object, if available.
  
  


	 
    
        
            abstract
            
            
            
            
            SimpleList
        
        
        getAncestors()
        
        Returns a SimpleList containing the ancestors of this object, if they exist
 in the object XML.
  
  


	 
    
        
            abstract
            
            
            
            
            String[]
        
        
        getComments()
        
        Returns an array of strings, each of which represent a 'comment', that is saved as the long description
 of the object.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getContainerDid()
        
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getContainerType()
        
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getCreationTime()
        
        Returns the creation time of this object, if that information is available.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getDataSources()
        
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getDescription()
        
        Returns the description of the object.
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getExtendedType()
        
        The current extended type
  
  


	 
    
        
            abstract
            
            
            
            
            WebObjectsFactory
        
        
        getFactory()
        
        Returns WebObjectsFactory
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getFlags()
        
        Returns the flags which determine what data to populate upon calling populate.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getID()
        
        Returns the DSS ID of the object, if one exists.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getIconPath()
        
        Return the icon path for the object
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getModificationTime()
        
        Returns the last modification time of the object, if that information is available.
  
  


	 
    
        
            abstract
            
            
            
            
            long
        
        
        getModificationTimeStamp()
        
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getName()
        
        Returns the name of this object.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        getNonSchedulable()
        
        Get flag of whether the object is not schedulable
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getOtherNameTransCount()
        
        Returns the count of name translations for locales other than the current effective locale.
  
  


	 
    
        
            abstract
            
            
            
            
            WebObjectInfo
        
        
        getOwner()
        
        Returns a WebObjectInfo object which corresponds to the owner of this object.
  
  


	 
    
        
            abstract
            
            
            
            
            WebFolder
        
        
        getParent()
        
        Returns the parent folder of the current object, if it exists.
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getPropertyFlags()
        
        Retrieve the current property flags
  
  


	 
    
        
            abstract
            
            
            
            
            SimpleList
        
        
        getPropertySetFilter()
        
        Returns an editable SimpleList where you can specify the list
 of propertySets that the getPropertySets call should be limited to
 Note that this filter is not retained in the state.
  
  


	 
    
        
            abstract
            
            
            
            
            WebPropertyGroup
        
        
        getPropertySets()
        
        Returns the property sets associated with this object.
  
  


	 
    
        
            abstract
            
            
            
            
            WebObjectSecurity
        
        
        getSecurity()
        
        Returns the WebObjectSecurity object associated with this WebObjectInfo object.
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getState()
        
        Returns the state of the object.
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getSubType()
        
        Returns the subtype of the object.
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getType()
        
        Returns the type of this object.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getVersionID()
        
        Returns the Version ID of the object, if one exists.
  
  


	 
    
        
            abstract
            
            
            
            
            WebViewMediaSettings
        
        
        getViewMediaSettings()
        
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getVisualizationViewMode()
        
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getXML(boolean encode)
        
        Returns the XML representation of this object.
  
  


	 
    
        
            abstract
            
            
            
            
            String
        
        
        getXML()
        
        Returns the XML representation of this object.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        hasOwner()
        
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isAncestorNamedFolder(int folderName)
        
        Returns whether the named folder is this object's ancestor.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isDirty()
        
        Returns whether this object has been modified to be different from the object in metadata.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isEmbedded()
        
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isHidden()
        
        Returns whether the object is a hidden object.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isNew()
        
        Returns whether this object is newly created at client side, which is not in the metadata.
  
  


	 
    
        
            abstract
            
            
            
            
            boolean
        
        
        isPopulated()
        
        Returns true if this object has been populated with its' definition from the Intelligence
 Server, false if it has not been populated.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        populate()
        
        Populates the fields on this object by asking the Intelligence Server for
 the object definition.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        populate(String xml)
        
        Populates the fields on this object by loading the given object definition XML.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setAbbreviation(String abbreviation)
        
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setComments(String[] comments)
        
        Set the long description of the object as an array of strings.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setDataSources(String dataSourcesXML)
        
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setDescription(String description)
        
        Sets the description of the object.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setExtendedType(int extendedType)
        
        Set the current extended type
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setFlags(int flags)
        
        Sets the flags which determine what data to populate upon calling populate.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setHidden(boolean hidden)
        
        Sets whether the object is a hidden object.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setIconPath(String iconPath)
        
        Set the icon path for the object 
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setName(String _name)
        
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setNonSchedulable(boolean nonSchedulable)
        
        Set flag of whether the object is not schedulable

  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setPropertyFlags(int flags)
        
        Set the current property flags
  
  



  







  
From interface

  com.microstrategy.web.objects.WebPromptAnswer


  
  
  
    
    


	 
    
        
            abstract
            
            
            
            
            WebPrompt
        
        
        getPrompt()
        
        Returns the prompt question object to which this prompt answer is trying
 to answer.
  
  


	 
    
        
            abstract
            
            
            
            
            int
        
        
        getReuse()
        
        Returns a value from the enumeration EnumDSSXMLPromptAnswerReuse.
  
  


	 
    
        
            abstract
            
            
            
            
            void
        
        
        setReuse(int _reuse)
        
        Sets the reuse property, from EnumDSSXMLPromptAnswerReuse
  
  



  







  
From interface

  com.microstrategy.web.objects.WebPromptSite


  
  
  
    
    


	 
    
        
            abstract
            
            
            
            
            WebPromptInstances
        
        
        getPromptInstances()
        
        Returns a collection of prompt instances from this prompt site.
  
  



  










































Public Methods





 
    
      
        public 
         
         
        abstract 
         
        WebElements
      
      getAnswer
      ()
    
      
        


        
  

      
    
      
  Returns the prompt answer to an elements prompt. 
  
      Returns
      the prompt answer to an elements prompt.

  

    





 
    
      
        public 
         
         
        abstract 
         
        void
      
      setAnswer
      (WebElements answer)
    
      
        


        
  

      
    
      
  Sets an elements prompt answer. An elements prompt question object must be
 set before calling this method to set a promp answer.  
  
      Parameters
      
        
          answer
          the prompt answer to an elements prompt.
        
      
  
  
      Throws
        
        
            WebObjectsException
            thrown if the answer is invalid.

        
      
  

    














Generated by Doclava.
Interfaces

Classes

Enums

Exceptions

WebElementsPromptAnswer

Class Overview

Summary

Public Methods

public abstract WebElements getAnswer ()

Returns

public abstract void setAnswer (WebElements answer)

Parameters

Throws

Public Methods
abstract WebElements	getAnswer() Returns the prompt answer to an elements prompt.
abstract void	setAnswer(WebElements answer) Sets an elements prompt answer.