com.liferay.portlet.usersadmin.util.UsersAdmin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
There is a newer version: 7.0.0-nightly
Show newest version
/**
 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portlet.usersadmin.util;

import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.search.Hits;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.Tuple;
import com.liferay.portal.model.Address;
import com.liferay.portal.model.EmailAddress;
import com.liferay.portal.model.Group;
import com.liferay.portal.model.OrgLabor;
import com.liferay.portal.model.Organization;
import com.liferay.portal.model.Phone;
import com.liferay.portal.model.Role;
import com.liferay.portal.model.User;
import com.liferay.portal.model.UserGroup;
import com.liferay.portal.model.UserGroupRole;
import com.liferay.portal.model.Website;
import com.liferay.portal.security.permission.PermissionChecker;

import java.util.List;

import javax.portlet.ActionRequest;
import javax.portlet.PortletRequest;
import javax.portlet.RenderResponse;

import javax.servlet.http.HttpServletRequest;

/**
 * @author Brian Wing Shun Chan
 * @author Jorge Ferrer
 * @author Julio Camarero
 */
public interface UsersAdmin {

	public static final String CUSTOM_QUESTION = "write-my-own-question";

	public void addPortletBreadcrumbEntries(
			Organization organization, HttpServletRequest request,
			RenderResponse renderResponse)
		throws Exception;

	public long[] addRequiredRoles(long userId, long[] roleIds)
		throws PortalException, SystemException;

	public long[] addRequiredRoles(User user, long[] roleIds)
		throws PortalException, SystemException;

	public List filterGroupRoles(
			PermissionChecker permissionChecker, long groupId, List roles)
		throws PortalException, SystemException;

	public List filterGroups(
			PermissionChecker permissionChecker, List groups)
		throws PortalException, SystemException;

	public List filterOrganizations(
			PermissionChecker permissionChecker,
			List organizations)
		throws PortalException, SystemException;

	public List filterRoles(
		PermissionChecker permissionChecker, List roles);

	public long[] filterUnsetGroupUserIds(
			PermissionChecker permissionChecker, long groupId, long[] userIds)
		throws PortalException, SystemException;

	public long[] filterUnsetOrganizationUserIds(
			PermissionChecker permissionChecker, long organizationId,
			long[] userIds)
		throws PortalException, SystemException;

	public List filterUserGroupRoles(
			PermissionChecker permissionChecker,
			List userGroupRoles)
		throws PortalException, SystemException;

	public List filterUserGroups(
		PermissionChecker permissionChecker, List userGroups);

	public List getAddresses(ActionRequest actionRequest);

	public List getAddresses(
		ActionRequest actionRequest, List defaultAddresses);

	public List getEmailAddresses(ActionRequest actionRequest);

	public List getEmailAddresses(
		ActionRequest actionRequest, List defaultEmailAddresses);

	public OrderByComparator getGroupOrderByComparator(
		String orderByCol, String orderByType);

	public Long[] getOrganizationIds(List organizations);

	public OrderByComparator getOrganizationOrderByComparator(
		String orderByCol, String orderByType);

	public Tuple getOrganizations(Hits hits)
		throws PortalException, SystemException;

	public List getOrgLabors(ActionRequest actionRequest);

	public List getPhones(ActionRequest actionRequest);

	public List getPhones(
		ActionRequest actionRequest, List defaultPhones);

	public OrderByComparator getRoleOrderByComparator(
		String orderByCol, String orderByType);

	public OrderByComparator getUserGroupOrderByComparator(
		String orderByCol, String orderByType);

	public List getUserGroupRoles(PortletRequest portletRequest)
		throws PortalException, SystemException;

	public Tuple getUserGroups(Hits hits)
		throws PortalException, SystemException;

	public OrderByComparator getUserOrderByComparator(
		String orderByCol, String orderByType);

	public Tuple getUsers(Hits hits) throws PortalException, SystemException;

	public List getWebsites(ActionRequest actionRequest);

	public List getWebsites(
		ActionRequest actionRequest, List defaultWebsites);

	/**
	 * @deprecated As of 6.2.0, replaced by {@link
	 *             #hasUpdateFieldPermission(User, String)}
	 */
	public boolean hasUpdateEmailAddress(
			PermissionChecker permissionChecker, User user)
		throws PortalException, SystemException;

	public boolean hasUpdateFieldPermission(User user, String field)
		throws PortalException, SystemException;

	/**
	 * @deprecated As of 6.2.0, replaced by {@link
	 *             #hasUpdateFieldPermission(User, String)}
	 */
	public boolean hasUpdateScreenName(
			PermissionChecker permissionChecker, User user)
		throws PortalException, SystemException;

	public long[] removeRequiredRoles(long userId, long[] roleIds)
		throws PortalException, SystemException;

	public long[] removeRequiredRoles(User user, long[] roleIds)
		throws PortalException, SystemException;

	public void updateAddresses(
			String className, long classPK, List addresses)
		throws PortalException, SystemException;

	public void updateEmailAddresses(
			String className, long classPK, List emailAddresses)
		throws PortalException, SystemException;

	public void updateOrgLabors(long classPK, List orgLabors)
		throws PortalException, SystemException;

	public void updatePhones(String className, long classPK, List phones)
		throws PortalException, SystemException;

	public void updateWebsites(
			String className, long classPK, List websites)
		throws PortalException, SystemException;

}