public interface

UserGroupBean

implements UserEntityBean Scrollable
com.microstrategy.web.beans.UserGroupBean

Class Overview

This interface represents a group user. Besides the basic funtionalities in UserEntityBean, it has the funtionalities of retrieving its children users and expand/collapse itself.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.beans.UserEntityBean
From interface com.microstrategy.web.objects.Scrollable
Public Methods
abstract UserEntitiesBean getChildren()
Returns the children collection.
abstract boolean isExpanded()
Returns whether current bean is expanded or not.
abstract void setExpanded(boolean expanded)
Expands or Collapses this bean.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.EditableBean
From interface com.microstrategy.web.beans.EditableObjectBean
From interface com.microstrategy.web.beans.ObjectBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.UserEntityBean
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent
From interface com.microstrategy.web.objects.Scrollable

Public Methods

public abstract UserEntitiesBean getChildren ()

Returns the children collection.

Returns
  • UserEntitiesBean The collection of children.
Throws
WebBeanException Thrown when error occurs.

public abstract boolean isExpanded ()

Returns whether current bean is expanded or not.

Returns
  • boolean true when this group bean is expanded. Otherwise, false returned.
Throws
WebBeanException Thrown if error occurs.

public abstract void setExpanded (boolean expanded)

Expands or Collapses this bean.

Parameters
expanded boolean true passed to expand this bean, false to collapse this bean.
Throws
WebBeanException Thrown when error occurs.