Package com.microstrategy.web.objects

Interface WebAttributeForm

    • Method Detail

      • getUseDescription

        java.lang.String getUseDescription()
        Returns the use description of the form. The use description is the description given by the attribute to the form when it is obtained from an attribute. If the form is not obtained from an attribute, this will be empty.
        Returns:
        The use description of this attribute form.

      • getUseName

        java.lang.String getUseName()
        Returns the use name of the form. The use name is the name given by the attribute to the form when it is obtained from an attribute. If the form is not obtained from an attribute, this will be empty.
        Returns:
        The use name of this attribute form.

      • getBaseAttributeFormType

        int getBaseAttributeFormType()
        Return the base attribute form type, if this attribute form is defined by a base attribute form. If this attribute from is not defined by a base attribute form, -1 will be returned. It is recommended to first check whether this form is defined by a base attribute form by calling hasBaseAttributeForm().
        Returns:
        The base attribute form type EnumDSSXMLBaseFormType. This will be -1 when this attribute form is not defined by a base attribute form.

      • getBaseAttributeFormDataType

        int getBaseAttributeFormDataType()
        Return the data type of base attribute form, if this attribute form is defined by a base attribute form. If this attribute from is not defined by a base attribute form, -1 will be returned. It is recommended to first check whether this form is defined by a base attribute form by calling hasBaseAttributeForm().
        Returns:
        The data type EnumDSSXMLDataType of base attribute form. This will be -1 when this attribute form is not defined by a base attribute form.

      • getBaseAttributeFormID

        int getBaseAttributeFormID()
        Return the id of base attribute form, if this attribute form is defined by a base attribute form. If this attribute from is not defined by a base attribute form, empty string will be returned. It is recommended to first check whether this form is defined by a base attribute form by calling hasBaseAttributeForm().
        Returns:
        A String representing the ID of the base attribute form. This will be empty when this attribute form is not defined by a base attribute form.

      • hasBaseAttributeForm

        boolean hasBaseAttributeForm()
        Returns whether this attribute form object is defined by a base attribute form. If it is not defined by a base attribute form, then it must be either defined by a collection of attribute form objects or it is a first-class attribute form not directly associated with any attribute.
        Returns:
        Return true if this attribute form is defined by a base attribute form, otherwise return false.

      • isIDForm

        boolean isIDForm()
        Returns whether this form is an ID form. This will only be returned in calls to an Intelligence Server 7.2.3 or greater.
        Returns:
        Whether this form is an ID form.
        Since:
        MicroStrategy Web 8.0.0

      • getGeoRole

        int getGeoRole()
        Return the Geo role of the form.
        Returns:
        An Integer representing Geo Role

      • getTimeRole

        int getTimeRole()
        Return the Time role of the form.
        Returns:
        An Integer representing Time Role

      • canBeUsedInReportLimits

        boolean canBeUsedInReportLimits()
        Since:
        MicroStrategy Web 8.0.2

      • isSearchForm

        boolean isSearchForm()

      • getBaseFormFormula

        java.lang.String getBaseFormFormula()
        return the base form formula
        Returns:
        the base form formula

      • isIndexed

        boolean isIndexed()
        Returns:
        true if this attribute form is indexed.

      • setDataType

        void setDataType​(java.lang.String dataType)
        set data type
        Parameters:
        dataType -

      • getBaseFormIndex

        java.lang.String getBaseFormIndex()