Package com.microstrategy.web.objects
Interface WebAttribute
-
- All Superinterfaces:
KeyedObject
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPromptSite
public interface WebAttribute extends WebObjectInfo
The WebAttribute interface represents an attribute, which is a first class object. This interface allows retrieval of the forms of an attribute.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebAttributeForms
getBrowseForms()
Returns a list of browse forms which belong to this attribute.WebDimensionAttribute
getDimensionAttribute()
Returns theWebDimensionAttribute
which is associated with this attribute.WebElementSource
getElementSource()
Returns an element source which can be used to modify the parameters for element retrieval if this attribute is highlighted.WebAttributeForms
getForms()
Returns the list of attribute forms which belong to this attribute.WebAttributeForms
getForms(int webDisplayFormType)
Returns the list of attribute forms based on the display form type which belong to this attribute.WebAttributeForms
getTemplateForms()
Returns a list of template forms which belong to this attribute.boolean
isProjectAttribute()
Returns whether this attribute is a project attribute.boolean
requiresLookupTable()
Returns whether this attribute requires a lookup table in order to obtain elements for it.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable
-
Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags
-
Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances
-
-
-
-
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 fromEnumWebDisplayedForms
.- 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.
-
getDimensionAttribute
WebDimensionAttribute getDimensionAttribute() throws WebObjectsException
Returns theWebDimensionAttribute
which is associated with this attribute. Note that every attribute belongs to a dimension; if the attribute did not come from a dimension object, then the attribute is presumed to come from the system dimension.- Returns:
- The
WebDimensionAttribute
associated with the attribute. - Throws:
WebObjectsException
- Thrown if the dimension attribute cannot be determined.
-
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
-
-