Package com.microstrategy.web.objects
Interface WebDisplayUnit
-
- All Superinterfaces:
KeyedObject
- All Known Subinterfaces:
RWMessage
,WebAttribute
,WebAttributeForm
,WebBlob
,WebBrowseHierarchyItem
,WebChangeJournalSearch
,WebCommandManagerScript
,WebConstantPrompt
,WebConstantPromptAnswer
,WebCustomGroup
,WebDBConnection
,WebDBLogin
,WebDBMS
,WebDBRole
,WebDerivedElement
,WebDevice
,WebDimension
,WebDimensionAttribute
,WebDimtyPrompt
,WebDimtyPromptAnswer
,WebDimtyUnit
,WebDocumentMessage
,WebElement
,WebElementsPrompt
,WebElementsPromptAnswer
,WebExpressionPrompt
,WebExpressionPromptAnswer
,WebFilter
,WebFilterBase
,WebFolder
,WebFormat
,WebFunction
,WebIServerSubscriptionDevice
,WebIServerSubscriptionTrigger
,WebLink
,WebLocaleObjectInfo
,WebMDSecurityFilter
,WebMDXCatalog
,WebMDXCube
,WebMDXDisplayUnit
,WebMDXSource
,WebMessage
,WebMetric
,WebMonitor
,WebObjectInfo
,WebObjectsPrompt
,WebObjectsPromptAnswer
,WebPalette
,WebPerformanceMonitor
,WebProject
,WebPrompt
,WebPromptAnswer
,WebPropertySet
,WebReportMessage
,WebReusableThresholds
,WebScheduleEvent
,WebScheduleTrigger
,WebScheduleTriggerEvent
,WebScheduleTriggerTime
,WebScheduleTriggerTimeDaily
,WebScheduleTriggerTimeMonthly
,WebScheduleTriggerTimeWeekly
,WebScheduleTriggerTimeYearly
,WebSearch
,WebSecurityRole
,WebServerDef
,WebShortcut
,WebTable
,WebTableSource
,WebTemplate
,WebTheme
,WebTimePrompt
,WebTransmitter
,WebUser
,WebUserEntity
,WebUserGroup
- All Known Implementing Classes:
WebBlobImpl
,WebChangeJournalSearchImpl
,WebDBMSImpl
,WebDerivedElementsHelper
,WebDossierPersonalViewShortcutImpl
,WebEmailDeviceImpl
,WebEmailTransmitterImpl
,WebFileDeviceImpl
,WebFTPDeviceImpl
,WebMobileDeviceImpl
,WebPrinterDeviceImpl
,WebReportDefinitionImpl
,WebReusableThresholdsImpl
,WebSyncRecommendationFolder
,WebSyncSearchFolder
,WebTransmitterImpl
public interface WebDisplayUnit extends KeyedObject
The WebDisplayUnit interface represents an object which can have display XML generated for it.There are several states which a display unit can be in:
- highlighted - If an object is highlighted, then it will have an attribute highlight set to 1 in the generated display XML.
- selected - If an object is selected, then it will have an attribute selected set to 1 in the generated display XML.
- has details(detailed) - If an object has details, then it will have more information about it in the display XML. For a dimension, this will retrieve it's attributes; for a folder, the objects it contains; for an attribute, its forms and elements.
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addDetails(boolean details)
This method will add or remove details from the display unit.void
applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
boolean
canHighlight()
WebDisplayUnits
getChildUnits()
Returns the collection of child display units, or null if the object is not a collection.java.lang.String
getDisplayName()
Returns the display name associated with this object.int
getDisplayUnitType()
Returns the type of display unit that this object represents.java.lang.String
getID()
Returns the DSS ID of the display unit.boolean
hasDetails()
Returns whether this display unit currently has details enabled.void
highlightUnit()
Sets this display unit to be highlighted.void
highlightUnit(boolean details)
Sets this display unit to be highlighted.boolean
isHighlighted()
Returns whether this unit is highlighted.boolean
isObjectInfo()
Returns true if underlying Web Object can be cast toWebObjectInfo
.boolean
isSelected()
Returns whether this display unit is selected.void
setDisplayName(java.lang.String displayName)
This method will set the value of the display name.void
setSelected(boolean selected)
Sets the current unit's selection status.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
-
-
-
Method Detail
-
getDisplayUnitType
int getDisplayUnitType()
Returns the type of display unit that this object represents. If this display unit represents a first-class object, then this method will return a value fromEnumDSSXMLObjectTypes
; otherwise, it will return a value fromEnumWebDependentObjectType
.- Returns:
- The display unit type, from
EnumDSSXMLObjectTypes
orEnumWebDependentObjectType
.
-
getID
java.lang.String getID()
Returns the DSS ID of the display unit.- Returns:
- The ID of the display unit.
-
hasDetails
boolean hasDetails()
Returns whether this display unit currently has details enabled.- Returns:
- True if details are enabled, false otherwise.
-
addDetails
void addDetails(boolean details) throws WebObjectsException
This method will add or remove details from the display unit. Note that this call may generate a call to the Intelligence Server if the details are not already present for the display unit.- Parameters:
details
- The desired state of details for the display unit.- Throws:
WebObjectsException
- Thrown if the details cannot be retrieved from the Intelligence Server.
-
isHighlighted
boolean isHighlighted()
Returns whether this unit is highlighted.- Returns:
- True if the display unit is highlighted, false otherwise.
-
highlightUnit
void highlightUnit()
Sets this display unit to be highlighted. This call will ensure that details are not present for the highlighted unit.
-
highlightUnit
void highlightUnit(boolean details) throws WebObjectsException
Sets this display unit to be highlighted. The details value will determine whether it should include details as well.- Parameters:
details
- Whether the highlighted unit should include details.- Throws:
WebObjectsException
- Thrown if the details for a highlighted unit cannot be retrieved from the Intelligence Server.
-
isSelected
boolean isSelected()
Returns whether this display unit is selected.- Returns:
- True if the unit is selected, false otherwise.
-
setSelected
void setSelected(boolean selected)
Sets the current unit's selection status.- Parameters:
selected
- Whether the unit should be set to be selected or not.
-
getDisplayName
java.lang.String getDisplayName()
Returns the display name associated with this object. If this was not set by the user or found in the object XML, then this will be equivalent to the name property of the underlying object.- Returns:
- The display name associated with the display unit object.
- See Also:
setDisplayName(java.lang.String)
,WebObjectInfo.getName()
-
setDisplayName
void setDisplayName(java.lang.String displayName)
This method will set the value of the display name. This name will be used to identify the object in display XML. Setting this value will have no affect on the actual name of the object.- Parameters:
displayName
- The display name to associate with the object.- See Also:
getDisplayName()
,WebObjectInfo.getName()
-
isObjectInfo
boolean isObjectInfo()
Returns true if underlying Web Object can be cast toWebObjectInfo
. If an object can be cast toWebObjectInfo
, then it is a first class object.- Returns:
- true if underlying Web Object can be cast to
WebObjectInfo
.
-
getChildUnits
WebDisplayUnits getChildUnits() throws WebObjectsException
Returns the collection of child display units, or null if the object is not a collection. Note that several display units are actually collections of display units as well.- Returns:
- The collection of child display units of this instance, or null if this object is not a collection.
- Throws:
WebObjectsException
-
applyVisitor
void applyVisitor(DisplayUnitsVisitor visitor, boolean deep) throws WebObjectsException
- Throws:
WebObjectsException
-
canHighlight
boolean canHighlight()
- Since:
- MicroStrategy Web 8.0.0
-
-