org.olat.admin.user
Class UserSearchController

java.lang.Object
  org.olat.core.gui.control.DefaultController
      org.olat.admin.user.UserSearchController

All Implemented Interfaces:

Controller, ControllerEventListener, Disposable

Direct Known Subclasses:

DeletableUserSearchController

public class UserSearchController
extends DefaultController
implements ControllerEventListener

Initial Date: Jul 29, 2003

Author:

Felix Jost, Florian Gnaegi

 Comment:  
 Subworkflow that allows the user to search for a user and choose the user from 
 the list of users that match the search criteria. Users can be searched by
 

 

 Username
 

 First name
 

 Last name
 

 Email address
 
 
 

Events:
Fires a SingleIdentityChoosenEvent when an identity has been chosen which contains the choosen identity
Fires a MultiIdentityChoosenEvent when multiples identities have been chosen which contains the choosen identities

Optionally set the useMultiSelect boolean to true which allows to select multiple identities from within the search results.

Field Summary

static java.lang.String	ACTION_KEY_CHOOSE
static java.lang.String	ACTION_KEY_CHOOSE_FINISH

Constructor Summary

UserSearchController(UserRequest ureq, WindowControl wControl, boolean cancelbutton)

UserSearchController(UserRequest ureq, WindowControl wControl, boolean cancelbutton, boolean userMultiSelect, boolean statusEnabled)

UserSearchController(UserRequest ureq, WindowControl windowControl, boolean cancelbutton, boolean userMultiSelect, boolean statusEnabled, java.lang.String actionKeyChooseFinish)

Method Summary

void	event(UserRequest ureq, Component source, Event event) abstract event method for subclasses.
void	event(UserRequest ureq, Controller source, Event event) the only method of the interface controllereventlistener.

Methods inherited from class org.olat.core.gui.control.DefaultController

addControllerListener, addLoggingResourceable, dispatchEvent, dispatchEvent, dispose, getControllerCount, getInitialComponent, getUserActivityLogger, getWindowControlForDebug, isDisposed, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.olat.core.gui.control.ControllerEventListener

dispatchEvent

Field Detail

ACTION_KEY_CHOOSE

public static final java.lang.String ACTION_KEY_CHOOSE

See Also:

Constant Field Values

ACTION_KEY_CHOOSE_FINISH

public static final java.lang.String ACTION_KEY_CHOOSE_FINISH

See Also:

Constant Field Values

Constructor Detail

UserSearchController

public UserSearchController(UserRequest ureq,
                            WindowControl wControl,
                            boolean cancelbutton)

Parameters:

ureq -

wControl -

cancelbutton -

UserSearchController

public UserSearchController(UserRequest ureq,
                            WindowControl windowControl,
                            boolean cancelbutton,
                            boolean userMultiSelect,
                            boolean statusEnabled,
                            java.lang.String actionKeyChooseFinish)

Parameters:

ureq -

windowControl -

cancelbutton -

userMultiSelect -

statusEnabled -

actionKeyChooseFinish -

UserSearchController

public UserSearchController(UserRequest ureq,
                            WindowControl wControl,
                            boolean cancelbutton,
                            boolean userMultiSelect,
                            boolean statusEnabled)

Parameters:

ureq -

wControl -

cancelbutton -

userMultiSelect -

statusEnabled -

Method Detail

event

public void event(UserRequest ureq,
                  Component source,
                  Event event)

Description copied from class: DefaultController

abstract event method for subclasses. the event received from the component we are listening to are always rerouted to this method here, except when the component has been disposed, in which case the events are simply ignored.

See Also:

DefaultController.event(org.olat.core.gui.UserRequest, org.olat.core.gui.components.Component, org.olat.core.gui.control.Event)

event

public void event(UserRequest ureq,
                  Controller source,
                  Event event)

Description copied from class: DefaultController

the only method of the interface controllereventlistener. always gets called when a controller we 'subscribed' to fires an event. we provide a default implementation here since there are many controllers which are standalone and need no subcontrollers

See Also:

DefaultController.event(org.olat.core.gui.UserRequest, org.olat.core.gui.control.Controller, org.olat.core.gui.control.Event)