public class

UserEntitiesTransform

extends AbstractObjectInfoListTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
           ↳ com.microstrategy.web.app.transforms.UserEntitiesTransform
Known Direct Subclasses

Summary

Nested Classes
class UserEntitiesTransform.Context Extends AbstractAppTransform.Context by providing a link to the current WebObjectInfo
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
UserEntitiesTransform()
Public Methods
boolean canCreate()
boolean canCreateGroup()
boolean canCreateUser()
boolean canDelete(WebObjectInfo object)
boolean canEdit(WebObjectInfo object)
Map getContextMenuAttributes(WebObjectInfo object)
WebEvent getDeleteEvent(WebObjectInfo object)
String getDescription()
WebEvent getEditEvent(WebObjectInfo object)
WebEvent getEvent(WebObjectInfo object)
Generate the event that allows users to request actions on a given object.
int getGoToArgument()
WebEvent getGoToEvent()
WebEvent getNewGroupEvent()
WebEvent getNewUserEvent()
String getObjectAbbreviation(WebObjectInfo object)
Utility method for obtaining the abbreviation of the object being analyzed
List getSortedList()
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

boolean isEmptyList()
boolean isObjectNotNull(WebObjectInfo object)
Convenience method to check object is Null.
void renderDeleteInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
void renderEditInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
Protected Methods
int getBlockPosition()
int getBlockSize()
int getChildCount()
TransformContext getContext()
Returns the instance of TransformContext with context information for this Transform.
ContextMenu getContextMenu(WebObjectInfo object)
UserEntitiesBean getUserEntitiesBean()
TransformContext newContext()
Creates a new instance of a TransformContext.
void renderEmptyCellForActions(MarkupOutput out, boolean renderCellAsText)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public UserEntitiesTransform ()

Public Methods

public boolean canCreate ()

public boolean canCreateGroup ()

public boolean canCreateUser ()

public boolean canDelete (WebObjectInfo object)

public boolean canEdit (WebObjectInfo object)

public Map getContextMenuAttributes (WebObjectInfo object)

public WebEvent getDeleteEvent (WebObjectInfo object)

public String getDescription ()

public WebEvent getEditEvent (WebObjectInfo object)

public WebEvent getEvent (WebObjectInfo object)

Generate the event that allows users to request actions on a given object.

Parameters
object WebObjectInfo base object for a request.
Returns
  • WebEvent instance corresponding to the event enabled for the WebObjectInfo provided. If no possible manipulation on the object is authorized, null will be returned.

public int getGoToArgument ()

Returns
  • the identifier of the argument on the getGoToEvent() event where the element to navigate to will be specified.

public WebEvent getGoToEvent ()

Returns
  • WebEvent instance with the information for handling incremental fetch requests on the list of objects being rendered by this transform. If not supported, it will return null

public WebEvent getNewGroupEvent ()

public WebEvent getNewUserEvent ()

public String getObjectAbbreviation (WebObjectInfo object)

Utility method for obtaining the abbreviation of the object being analyzed

Parameters
object WebObjectInfo instance to be processed.
Returns
  • value of the abbreviation property of the object.

public List getSortedList ()

Returns
  • a List instance with all the elements from the bean to be rendered by this transform. The contents will already be sorted if required.

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public boolean isEmptyList ()

Returns
  • true if the underlying object list is empty.

public boolean isObjectNotNull (WebObjectInfo object)

Convenience method to check object is Null.

Parameters
object WebObjectInfo Object to be checked for null.
Returns
  • true if the object is not null.

public void renderDeleteInfo (MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)

public void renderEditInfo (MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)

Protected Methods

protected int getBlockPosition ()

Returns
  • value of the property indicating the index of the first element currently being viewed as part of the list output. Used for incremental fetch purposes.

protected int getBlockSize ()

Returns
  • value of the property indicating the number of elements included on a single 'page' of the list output. Used for incremental fetch purposes.

protected int getChildCount ()

Returns
  • the total number of elements that are included on the list that could be rendered by this transform. Used for incremental fetch purposes.

protected TransformContext getContext ()

Returns the instance of TransformContext with context information for this Transform.

protected ContextMenu getContextMenu (WebObjectInfo object)

protected UserEntitiesBean getUserEntitiesBean ()

protected TransformContext newContext ()

Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.

protected void renderEmptyCellForActions (MarkupOutput out, boolean renderCellAsText)