public interface

HighlightedObject

com.microstrategy.web.beans.HighlightedObject

Class Overview

This interface represents an object that a user selects on a Web browser and wants to highlight in the next Web page.

Summary

Public Methods
abstract int getBlockBegin()
Returns the value of blockBegin for incremental fetch on the highlighted object.
abstract int getBlockCount()
Returns the value of blockCount for incremental fetch on the highlighted object.
abstract WebFilter getFilter()
Returns the WebFilter being applied on the highlighted object.
abstract String getObjectId()
Return the object id of the highlighted object.
abstract int getObjectType()
Returns the object type of the highlighted object.
abstract void setBlockBegin(int blockBegin)
Sets the starting item for incremental fetch.
abstract void setBlockCount(int blockCount)
Sets the number of blocks of items for incemental fetch
abstract void setFilter(WebFilter filter)
Sets a WebFilter on the current highlighted object.

Public Methods

public abstract int getBlockBegin ()

Returns the value of blockBegin for incremental fetch on the highlighted object.

Returns
  • the value of blockBegin

public abstract int getBlockCount ()

Returns the value of blockCount for incremental fetch on the highlighted object.

Returns
  • the value of blockCount

public abstract WebFilter getFilter ()

Returns the WebFilter being applied on the highlighted object. For WebAttribute, the filter is used to browse WebElements.

Returns
  • the WebFilter being applied on the highlighted object.

public abstract String getObjectId ()

Return the object id of the highlighted object.

Returns
  • the object id of the highlighted object.

public abstract int getObjectType ()

Returns the object type of the highlighted object. The type is from either EnumDSSXMLObjectTypes or EnumWebDependentObjectType.

Returns
  • the object type of the highlighted object

public abstract void setBlockBegin (int blockBegin)

Sets the starting item for incremental fetch.

Parameters
blockBegin the starting item to fetch.

public abstract void setBlockCount (int blockCount)

Sets the number of blocks of items for incemental fetch

Parameters
blockCount the number of blocks of items to fetch.

public abstract void setFilter (WebFilter filter)

Sets a WebFilter on the current highlighted object. For WebAttribute, the filter is used to browse WebElements.

Parameters
filter the WebFilter to set.