Interface WebAttribute

    • Method Detail

      • getForms

        WebAttributeForms getForms()
        Returns the list of attribute forms which belong to this attribute.
        Returns:
        A WebAttributeForms collection, containing all forms of the attribute.
      • getForms

        WebAttributeForms getForms​(int webDisplayFormType)
        Returns the list of attribute forms based on the display form type which belong to this attribute.
        Parameters:
        webDisplayFormType - - value from EnumWebDisplayedForms.
        Returns:
        A WebAttributeForms collection, forms of the attribute based on the type.
        Since:
        MicroStrategy Web 8.1.2
      • getBrowseForms

        WebAttributeForms getBrowseForms()
        Returns a list of browse forms which belong to this attribute. Browse forms are those forms which will be used by default when browsing elements of the attribute.
        Returns:
        A WebAttributeForms collection, containing only the browse forms of the attribute.
      • getTemplateForms

        WebAttributeForms getTemplateForms()
        Returns a list of template forms which belong to this attribute. Template forms are those forms which will be used by default when the attribute appears inside a report.
        Returns:
        A WebAttributeForms collection, containing only the template forms of the attribute.
      • getElementSource

        WebElementSource getElementSource()
        Returns an element source which can be used to modify the parameters for element retrieval if this attribute is highlighted.
        Returns:
        A WebElementSource object, which can be used to control element browsing in the event that this attribute is detailed/highlighted.
      • requiresLookupTable

        boolean requiresLookupTable()
        Returns whether this attribute requires a lookup table in order to obtain elements for it. If this is true, then the attribute's elements cannot be browsed using the GetElements call without additional context information.
        Returns:
        True if the attribute cannot be browsed, false otherwise.
        Since:
        MicroStrategy Web 8.0.1
      • isProjectAttribute

        boolean isProjectAttribute()
        Returns whether this attribute is a project attribute.
        Returns:
        False if the attribute comes from a MDX Cube and "ipa" attribute is not set, true otherwise.
        Since:
        MicroStrategy Web 9.0.3