com.communote.server.web.fe.widgets.users

Class UserListWidget

java.lang.Object

com.communote.server.widgets.AbstractWidget

com.communote.server.widgets.AbstractMultipleResultWidget<I>

com.communote.server.web.fe.widgets.AbstractPagedListWidget<DetailedUserData>

com.communote.server.web.fe.widgets.users.UserListWidget

All Implemented Interfaces:

PagedWidget<DetailedUserData>, Widget

public class UserListWidget
extends AbstractPagedListWidget<DetailedUserData>

Controller for the the Widget to list users.

Author:

Communote GmbH - http://www.communote.com/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UserListWidget.ListUsersWidgetUserListItem UserData with special fields for this widget.

Field Summary

Fields inherited from class com.communote.server.web.fe.widgets.AbstractPagedListWidget

METADATA_KEY_ELEMENTS_CONTAINED, METADATA_KEY_MORE_AVAILABLE, PARAM_PAGING_INTERVAL

Fields inherited from class com.communote.server.widgets.AbstractWidget

METADATA_KEY_NO_CONTENT

Fields inherited from interface com.communote.server.web.fe.widgets.PagedWidget

PAGING_MASSAGE_KEY_PREFIX, PARAM_PAGING_MESSAGE_KEY_SUFFIX

Fields inherited from interface com.communote.server.widgets.Widget

PARAM_WIDGET_ID

Constructor Summary

Constructors

Constructor and Description
UserListWidget()

Method Summary

Modifier and Type	Method and Description
String	getTile(String outputType) Get the tile to be used for rendering
protected PageableList<DetailedUserData>	handleQueryList() hook that actually requests the list on the api

Methods inherited from class com.communote.server.web.fe.widgets.AbstractPagedListWidget

getDefaultPagingMessageKeySuffix, getPageInformation, getParameterDescriptions, getResultSpecification, getSortedResultSpecification, handleRequest, initParameters, setCommonResponseMetadata, setPageInformation, setPageInformation, setPageInformation

Methods inherited from class com.communote.server.widgets.AbstractWidget

determineOutputType, getAttribute, getBooleanParameter, getGroupName, getIntParameter, getIntParameter, getLongArrayParameter, getLongParameter, getLongParameter, getParameter, getParameter, getParameterEscaped, getParameterEscaped, getParameters, getRequest, getResponse, getResponseMetadata, getStringArrayParameter, getViewIdentifier, getWidgetId, isSuccess, setAttribute, setGroupName, setParameter, setRequest, setResponse, setResponseMetadata, setSuccess

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.communote.server.widgets.Widget

getAttribute, getGroupName, getParameter, getParameters, getResponseMetadata, getViewIdentifier, getWidgetId, isSuccess, setGroupName, setParameter, setRequest, setResponse

Constructor Detail

UserListWidget

public UserListWidget()

Method Detail

getTile

public String getTile(String outputType)

Description copied from interface: Widget

Get the tile to be used for rendering

Parameters:

outputType - This parameter is ignored.

Returns:

"core.widget.users.list"

handleQueryList

protected PageableList<DetailedUserData> handleQueryList()

Description copied from class: AbstractPagedListWidget

hook that actually requests the list on the api

Specified by:

handleQueryList in class AbstractPagedListWidget<DetailedUserData>

Returns:

The list of users.