com.communote.server.web.fe.widgets.management.user

Class UserManagementListWidget

java.lang.Object

com.communote.server.widgets.AbstractWidget

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

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

com.communote.server.web.fe.widgets.management.user.UserManagementListWidget

All Implemented Interfaces:

PagedWidget<UserManagementListItem>, Widget

public class UserManagementListWidget
extends AbstractPagedListWidget<UserManagementListItem>

The Class UserManagementListWidget implements a user list with management functions.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_USER_ROLE_FILTER The Constant PARAM_USER_ROLE_FILTER defines the parameter for the user role filter.
static String	PARAM_USER_STATUS_FILTER The Constant PARAM_USER_STATUS_FILTER defines the parameter for the user status filter.

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
UserManagementListWidget()

Method Summary

Modifier and Type	Method and Description
String	getDefaultPagingMessageKeySuffix() returns 'user'
String	getTile(String outputType) Get the tile to be used for rendering
protected PageableList<UserManagementListItem>	handleQueryList() hook that actually requests the list on the api
protected void	initParameters() abstract method hook that initializes the widget's parameters

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

getPageInformation, getParameterDescriptions, getResultSpecification, getSortedResultSpecification, handleRequest, 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

Field Detail

PARAM_USER_STATUS_FILTER

public static final String PARAM_USER_STATUS_FILTER

The Constant PARAM_USER_STATUS_FILTER defines the parameter for the user status filter.

See Also:

Constant Field Values

PARAM_USER_ROLE_FILTER

public static final String PARAM_USER_ROLE_FILTER

The Constant PARAM_USER_ROLE_FILTER defines the parameter for the user role filter.

See Also:

Constant Field Values

Constructor Detail

UserManagementListWidget

public UserManagementListWidget()

Method Detail

getDefaultPagingMessageKeySuffix

public String getDefaultPagingMessageKeySuffix()

returns 'user'

Specified by:

getDefaultPagingMessageKeySuffix in interface PagedWidget<UserManagementListItem>

Overrides:

getDefaultPagingMessageKeySuffix in class AbstractPagedListWidget<UserManagementListItem>

Returns:

the message key suffix

See Also:

PagedWidget.getDefaultPagingMessageKeySuffix()

getTile

public String getTile(String outputType)

Description copied from interface: Widget

Get the tile to be used for rendering

Parameters:

outputType - the output type (rss, dhtml ...) without any '.'

Returns:

The tile to show

handleQueryList

protected PageableList<UserManagementListItem> handleQueryList()

hook that actually requests the list on the api

Specified by:

handleQueryList in class AbstractPagedListWidget<UserManagementListItem>

Returns:

list of items

See Also:

AbstractPagedListWidget.handleQueryList()

initParameters

protected void initParameters()

abstract method hook that initializes the widget's parameters

Overrides:

initParameters in class AbstractPagedListWidget<UserManagementListItem>

See Also:

AbstractPagedListWidget.initParameters()