UserSearchUIService.java

/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Copyright (c) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.
*/
package org.olat.admin.user;

import org.olat.core.gui.UserRequest;
import org.olat.core.gui.control.Controller;
import org.olat.core.gui.control.Event;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.id.Identity;

public interface UserSearchUIService {
	/**
	 * creates a user search workflow
	 * 
	 * @param withCancelButton true, if a cancel button should be offered, false otherwise
	 * @param ureq the userrequest
	 * @param wControl the windowcontrol
	 * @return a usersearch controller
	 */
	public Controller createUserSearch(boolean withCancelButton, UserRequest ureq, WindowControl wControl);

	/**
	 * returns the chosen identity
	 * 
	 * @param event the received event
	 * @return the chosen Identity or null if the workflow was cancelled
	 */
	public Identity getChosenUser(Event event);

}