DepartmentService.java

/*******************************************************************************
 * Copyright [2015] [Onboard team of SERC, Peking University]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package com.onboard.service.account;

import java.util.List;

import com.onboard.domain.mapper.model.DepartmentExample;
import com.onboard.domain.model.Department;
import com.onboard.domain.model.User;
import com.onboard.domain.model.UserCompany;
import com.onboard.service.base.BaseService;

/**
 * This service is about {@link Department}.
 * 
 * @author xuchen
 * 
 */
public interface DepartmentService extends
		BaseService<Department, DepartmentExample> {

	/**
	 * Move the given user to the given department
	 * 
	 * @param userCompany
	 *            An object contains the informations of both user and company
	 */
	void updateDepartmentOfUser(UserCompany userCompany);

	/**
	 * Update the order of departments according to the given list
	 * 
	 * @param departmentIds
	 *            An list of departmentIds which indicated the new order
	 */
	void sortDepartment(List<Integer> departmentIds);

	/**
	 * Get department by the given user and the given company (Which means this
	 * is the department that the given user belong to in the given company)
	 * 
	 * @param companyId
	 *            The id of the company
	 * @param userId
	 *            The id of the user
	 * @return An object of department which meets the restriction
	 */
	Department getDepartmentByCompanyIdByUserId(int companyId, int userId);

	/**
	 * Get department by the given user and the given company, then set the
	 * departmentId field of the user using this department
	 * 
	 * @param user
	 *            An object of user
	 * @param companyId
	 *            The id of the company
	 */
	void fillUserDepartmentInCompany(User user, int companyId);

	/**
	 * For each user in a given list of users, get department by the user and
	 * the given company, then set the departmentId field of the user using this
	 * department
	 * 
	 * @param users
	 *            A list of user object
	 * @param companyId
	 *            The id of the company
	 */
	void fillUsersDepartmentInCompany(List<User> users, int companyId);

}