public interface

WebAttributeForm

implements WebObjectInfo
com.microstrategy.web.objects.WebAttributeForm

Class Overview

This interface represents an attribute form, which is a first class object. This interface has methods to obtain information specific to an attribute form.

Summary

Public Methods
abstract boolean canBeUsedInReportLimits()
abstract int getBaseAttributeFormDataType()
Return the data type of base attribute form, if this attribute form is defined by a base attribute form.
abstract int getBaseAttributeFormID()
Return the id of base attribute form, if this attribute form is defined by a base attribute form.
abstract int getBaseAttributeFormType()
Return the base attribute form type, if this attribute form is defined by a base attribute form.
abstract String getBaseFormFormula()
return the base form formula
abstract int getGeoRole()
Return the Geo role of the form.
abstract int getTimeRole()
Return the Time role of the form.
abstract String getUseDescription()
Returns the use description of the form.
abstract String getUseName()
Returns the use name of the form.
abstract boolean hasBaseAttributeForm()
Returns whether this attribute form object is defined by a base attribute form.
abstract boolean isIDForm()
Returns whether this form is an ID form.
abstract boolean isIndexed()
abstract boolean isSearchForm()
abstract void setDataType(String dataType)
set data type
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract boolean canBeUsedInReportLimits ()

public abstract 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.

public abstract 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.

public abstract 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.

public abstract String getBaseFormFormula ()

return the base form formula

Returns
  • the base form formula

public abstract int getGeoRole ()

Return the Geo role of the form.

Returns
  • An Integer representing Geo Role

public abstract int getTimeRole ()

Return the Time role of the form.

Returns
  • An Integer representing Time Role

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract boolean isIndexed ()

Returns
  • true if this attribute form is indexed.

public abstract boolean isSearchForm ()

public abstract void setDataType (String dataType)

set data type