Package com.microstrategy.web.beans
Interface HighlightedObject
-
public interface HighlightedObject
This interface represents an object that a user selects on a Web browser and wants to highlight in the next Web page.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getBlockBegin()
Returns the value of blockBegin for incremental fetch on the highlighted object.int
getBlockCount()
Returns the value of blockCount for incremental fetch on the highlighted object.WebFilter
getFilter()
Returns theWebFilter
being applied on the highlighted object.java.lang.String
getObjectId()
Return the object id of the highlighted object.int
getObjectType()
Returns the object type of the highlighted object.void
setBlockBegin(int blockBegin)
Sets the starting item for incremental fetch.void
setBlockCount(int blockCount)
Sets the number of blocks of items for incemental fetchvoid
setFilter(WebFilter filter)
Sets aWebFilter
on the current highlighted object.
-
-
-
Method Detail
-
getObjectId
java.lang.String getObjectId()
Return the object id of the highlighted object.- Returns:
- the object id of the highlighted object.
-
getObjectType
int getObjectType()
Returns the object type of the highlighted object. The type is from eitherEnumDSSXMLObjectTypes
orEnumWebDependentObjectType
.- Returns:
- the object type of the highlighted object
-
getBlockBegin
int getBlockBegin()
Returns the value of blockBegin for incremental fetch on the highlighted object.- Returns:
- the value of blockBegin
-
getBlockCount
int getBlockCount()
Returns the value of blockCount for incremental fetch on the highlighted object.- Returns:
- the value of blockCount
-
getFilter
WebFilter getFilter()
Returns theWebFilter
being applied on the highlighted object. ForWebAttribute
, the filter is used to browseWebElements
.- Returns:
- the WebFilter being applied on the highlighted object.
-
setBlockBegin
void setBlockBegin(int blockBegin)
Sets the starting item for incremental fetch.- Parameters:
blockBegin
- the starting item to fetch.
-
setBlockCount
void setBlockCount(int blockCount)
Sets the number of blocks of items for incemental fetch- Parameters:
blockCount
- the number of blocks of items to fetch.
-
setFilter
void setFilter(WebFilter filter)
Sets aWebFilter
on the current highlighted object. ForWebAttribute
, the filter is used to browseWebElements
.- Parameters:
filter
- the WebFilter to set.
-
-