java.lang.Object
- org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController
- - org.silverpeas.web.selection.control.SelectionPeasWrapperSessionController

All Implemented Interfaces:

Serializable, ComponentSessionController, SessionCloseable
```
public class SelectionPeasWrapperSessionController
extends AbstractComponentSessionController
```
A simple wrapper to the userpanel.

Author:

Didier Wenzek

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController
  context

Constructor Summary

Constructors
Constructor	Description
`SelectionPeasWrapperSessionController(MainSessionController mainSessionCtrl, ComponentContext componentContext)`	Standard Session Controller Constructeur

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDomainIdFilter()`	Gets the identifier of the domain on which the user selection must be filtered.
`String`	`getElementId()`	Returns the HTML input where the selected user id must be set.
`String`	`getElementName()`	Returns the HTML input where the selected user name must be set.
`String`	`getFormName()`	Returns the HTML form name whose user element must be set.
`String`	`getResourceIdFilter()`	Gets the identifier of a resource in a given application instance on which the user selection must be filtered.
`Group`	`getSelectedGroup()`	Returns the selected group (if any).
`Group[]`	`getSelectedGroups()`	Returns the selected groups (if any).
`UserDetail`	`getSelectedUser()`	Returns the selected user (if any).
`UserDetail[]`	`getSelectedUsers()`	Returns the selected user (if any).
`void`	`getSelectionPeasSelection()`	Reads the selection made with the user panel.
`String`	`initSelectionPeas(boolean multiple, String instanceId, org.silverpeas.kernel.util.Pair<List<String>,Boolean> roles, boolean includeRemovedUsers, boolean showDeactivated, boolean selectedUserLimit)`	Init the user panel.
`boolean`	`isGroupSelectable()`
`boolean`	`isUserSelectable()`
`void`	`setDomainIdFilter(String domainIdFilter)`	Sets the identifier of the domain in order to filter user selection on it.
`void`	`setElementId(String elementId)`	Set the HTML input where the selected user id must be set.
`void`	`setElementName(String elementName)`	Set the HTML input where the selected user name must be set.
`void`	`setFormName(String formName)`	Set the HTML form name whose user element must be set.
`void`	`setResourceIdFilter(String resourceIdFilter)`	Sets the identifier of a resource in a given application instance in order to filter user selection on it.
`void`	`setSelectable(int selectable)`
`void`	`setSelectable(String selectable)`
`void`	`setSelectedGroupId(String selectedId)`
`void`	`setSelectedGroupIds(String selectedIds)`
`void`	`setSelectedUserId(String selectedUserId)`	Set the selected user (if any).
`void`	`setSelectedUserIds(String selectedUserIds)`

Methods inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController
addClipboardSelection, clipboardPasteDone, close, getClipboardErrorMessage, getClipboardExceptionError, getClipboardObjects, getClipboardSelectedObjects, getClipboardSize, getComponentAccessController, getComponentId, getComponentLabel, getComponentName, getComponentParameterValue, getComponentParameterValue, getComponentRootName, getComponentUrl, getHighestSilverpeasUserRole, getIcon, getLanguage, getLook, getMultilang, getOrganisationController, getPersonalization, getRSSUrl, getSelection, getSettings, getSilverpeasUserRoles, getSpaceId, getSpaceLabel, getString, getSubscriptionContext, getUrlEncodedParameter, getUserAccessLevel, getUserAvailComponentIds, getUserDetail, getUserDetail, getUserId, getUserManageableGroupIds, getUserManageableSpaceIds, getUserRoles, getZoneId, isAppInMaintenance, isGroupManager, isPasswordChangeAllowed, isSpaceInMaintenance, removeClipboardElement, setAppModeMaintenance, setClipboardSelectedElement, setComponentRootName, setSpaceModeMaintenance

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SelectionPeasWrapperSessionController
```
public SelectionPeasWrapperSessionController(MainSessionController mainSessionCtrl,
                                             ComponentContext componentContext)
```
    Standard Session Controller Constructeur
    
    Parameters:
    
    mainSessionCtrl - The full work session.
    
    componentContext - The context of this component session.
- Method Detail
  - getFormName
```
public String getFormName()
```
    Returns the HTML form name whose user element must be set.
  - setFormName
```
public void setFormName(String formName)
```
    Set the HTML form name whose user element must be set.
  - getElementId
```
public String getElementId()
```
    Returns the HTML input where the selected user id must be set.
  - setElementId
```
public void setElementId(String elementId)
```
    Set the HTML input where the selected user id must be set.
  - getElementName
```
public String getElementName()
```
    Returns the HTML input where the selected user name must be set.
  - setElementName
```
public void setElementName(String elementName)
```
    Set the HTML input where the selected user name must be set.
  - getSelectedUser
```
public UserDetail getSelectedUser()
```
    Returns the selected user (if any).
  - getSelectedUsers
```
public UserDetail[] getSelectedUsers()
```
    Returns the selected user (if any).
  - getSelectedGroup
```
public Group getSelectedGroup()
```
    Returns the selected group (if any).
  - getSelectedGroups
```
public Group[] getSelectedGroups()
```
    Returns the selected groups (if any).
  - setSelectedUserId
```
public void setSelectedUserId(String selectedUserId)
```
    Set the selected user (if any).
  - setSelectedUserIds
```
public void setSelectedUserIds(String selectedUserIds)
```
  - getDomainIdFilter
```
public String getDomainIdFilter()
```
    Gets the identifier of the domain on which the user selection must be filtered.
    
    Returns:
    
    an identifier of domain as string, empty if none.
  - setDomainIdFilter
```
public void setDomainIdFilter(String domainIdFilter)
```
    Sets the identifier of the domain in order to filter user selection on it.
    
    Parameters:
    
    domainIdFilter - the identifier of domain as string.
  - getResourceIdFilter
```
public String getResourceIdFilter()
```
    Gets the identifier of a resource in a given application instance on which the user selection must be filtered.
    
    Returns:
    
    an identifier of the resource as string, empty if none. It is a concat of the resource type and of the resource identifier.
  - setResourceIdFilter
```
public void setResourceIdFilter(String resourceIdFilter)
```
    Sets the identifier of a resource in a given application instance in order to filter user selection on it.
    
    Parameters:
    
    resourceIdFilter - the identifier of the resource as string. It should be a concat of the resource type and of the resource identifier.
  - initSelectionPeas
```
public String initSelectionPeas(boolean multiple,
                                String instanceId,
                                org.silverpeas.kernel.util.Pair<List<String>,Boolean> roles,
                                boolean includeRemovedUsers,
                                boolean showDeactivated,
                                boolean selectedUserLimit)
```
    Init the user panel.
  - getSelectionPeasSelection
```
public void getSelectionPeasSelection()
```
    Reads the selection made with the user panel.
  - setSelectable
```
public void setSelectable(int selectable)
```
  - setSelectable
```
public void setSelectable(String selectable)
```
  - isUserSelectable
```
public boolean isUserSelectable()
```
  - isGroupSelectable
```
public boolean isGroupSelectable()
```
  - setSelectedGroupId
```
public void setSelectedGroupId(String selectedId)
```
  - setSelectedGroupIds
```
public void setSelectedGroupIds(String selectedIds)
```

Class SelectionPeasWrapperSessionController

Field Summary

Fields inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

Constructor Summary

Method Summary

Methods inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

Methods inherited from class java.lang.Object

Constructor Detail

SelectionPeasWrapperSessionController

Method Detail

getFormName

setFormName

getElementId

setElementId

getElementName

setElementName

getSelectedUser

getSelectedUsers

getSelectedGroup

getSelectedGroups

setSelectedUserId

setSelectedUserIds

getDomainIdFilter

setDomainIdFilter

getResourceIdFilter

setResourceIdFilter

initSelectionPeas

getSelectionPeasSelection

setSelectable

setSelectable

isUserSelectable

isGroupSelectable

setSelectedGroupId

setSelectedGroupIds