001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.usersadmin.util;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.search.Hits;
020    import com.liferay.portal.kernel.util.OrderByComparator;
021    import com.liferay.portal.kernel.util.Tuple;
022    import com.liferay.portal.model.Address;
023    import com.liferay.portal.model.EmailAddress;
024    import com.liferay.portal.model.Group;
025    import com.liferay.portal.model.OrgLabor;
026    import com.liferay.portal.model.Organization;
027    import com.liferay.portal.model.Phone;
028    import com.liferay.portal.model.Role;
029    import com.liferay.portal.model.User;
030    import com.liferay.portal.model.UserGroup;
031    import com.liferay.portal.model.UserGroupRole;
032    import com.liferay.portal.model.Website;
033    import com.liferay.portal.security.permission.PermissionChecker;
034    
035    import java.util.List;
036    
037    import javax.portlet.ActionRequest;
038    import javax.portlet.PortletRequest;
039    import javax.portlet.RenderResponse;
040    
041    import javax.servlet.http.HttpServletRequest;
042    
043    /**
044     * @author Brian Wing Shun Chan
045     * @author Jorge Ferrer
046     * @author Julio Camarero
047     */
048    public class UsersAdminUtil {
049    
050            public static final String CUSTOM_QUESTION = "write-my-own-question";
051    
052            public static void addPortletBreadcrumbEntries(
053                            Organization organization, HttpServletRequest request,
054                            RenderResponse renderResponse)
055                    throws Exception {
056    
057                    getUsersAdmin().addPortletBreadcrumbEntries(
058                            organization, request, renderResponse);
059            }
060    
061            public static long[] addRequiredRoles(long userId, long[] roleIds)
062                    throws PortalException, SystemException {
063    
064                    return getUsersAdmin().addRequiredRoles(userId, roleIds);
065            }
066    
067            public static long[] addRequiredRoles(User user, long[] roleIds)
068                    throws PortalException, SystemException {
069    
070                    return getUsersAdmin().addRequiredRoles(user, roleIds);
071            }
072    
073            public static List<Role> filterGroupRoles(
074                            PermissionChecker permissionChecker, long groupId, List<Role> roles)
075                    throws PortalException, SystemException {
076    
077                    return getUsersAdmin().filterGroupRoles(
078                            permissionChecker, groupId, roles);
079            }
080    
081            public static List<Group> filterGroups(
082                            PermissionChecker permissionChecker, List<Group> groups)
083                    throws PortalException, SystemException {
084    
085                    return getUsersAdmin().filterGroups(permissionChecker, groups);
086            }
087    
088            public static List<Organization> filterOrganizations(
089                            PermissionChecker permissionChecker,
090                            List<Organization> organizations)
091                    throws PortalException, SystemException {
092    
093                    return getUsersAdmin().filterOrganizations(
094                            permissionChecker, organizations);
095            }
096    
097            public static List<Role> filterRoles(
098                    PermissionChecker permissionChecker, List<Role> roles) {
099    
100                    return getUsersAdmin().filterRoles(permissionChecker, roles);
101            }
102    
103            public static List<UserGroupRole> filterUserGroupRoles(
104                            PermissionChecker permissionChecker,
105                            List<UserGroupRole> userGroupRoles)
106                    throws PortalException, SystemException {
107    
108                    return getUsersAdmin().filterUserGroupRoles(
109                            permissionChecker, userGroupRoles);
110            }
111    
112            public static List<UserGroup> filterUserGroups(
113                    PermissionChecker permissionChecker, List<UserGroup> userGroups) {
114    
115                    return getUsersAdmin().filterUserGroups(permissionChecker, userGroups);
116            }
117    
118            public static List<Address> getAddresses(ActionRequest actionRequest) {
119                    return getUsersAdmin().getAddresses(actionRequest);
120            }
121    
122            public static List<EmailAddress> getEmailAddresses(
123                    ActionRequest actionRequest) {
124    
125                    return getUsersAdmin().getEmailAddresses(actionRequest);
126            }
127    
128            public static OrderByComparator getGroupOrderByComparator(
129                    String orderByCol, String orderByType) {
130    
131                    return getUsersAdmin().getGroupOrderByComparator(
132                            orderByCol, orderByType);
133            }
134    
135            public static Long[] getOrganizationIds(List<Organization> organizations) {
136                    return getUsersAdmin().getOrganizationIds(organizations);
137            }
138    
139            public static OrderByComparator getOrganizationOrderByComparator(
140                    String orderByCol, String orderByType) {
141    
142                    return getUsersAdmin().getOrganizationOrderByComparator(
143                            orderByCol, orderByType);
144            }
145    
146            public static Tuple getOrganizations(Hits hits)
147                    throws PortalException, SystemException {
148    
149                    return getUsersAdmin().getOrganizations(hits);
150            }
151    
152            public static List<OrgLabor> getOrgLabors(ActionRequest actionRequest) {
153                    return getUsersAdmin().getOrgLabors(actionRequest);
154            }
155    
156            public static List<Phone> getPhones(ActionRequest actionRequest) {
157                    return getUsersAdmin().getPhones(actionRequest);
158            }
159    
160            public static OrderByComparator getRoleOrderByComparator(
161                    String orderByCol, String orderByType) {
162    
163                    return getUsersAdmin().getRoleOrderByComparator(
164                            orderByCol, orderByType);
165            }
166    
167            public static OrderByComparator getUserGroupOrderByComparator(
168                    String orderByCol, String orderByType) {
169    
170                    return getUsersAdmin().getUserGroupOrderByComparator(
171                            orderByCol, orderByType);
172            }
173    
174            public static List<UserGroupRole> getUserGroupRoles(
175                            PortletRequest portletRequest)
176                    throws PortalException, SystemException {
177    
178                    return getUsersAdmin().getUserGroupRoles(portletRequest);
179            }
180    
181            public static OrderByComparator getUserOrderByComparator(
182                    String orderByCol, String orderByType) {
183    
184                    return getUsersAdmin().getUserOrderByComparator(
185                            orderByCol, orderByType);
186            }
187    
188            public static Tuple getUsers(Hits hits)
189                    throws PortalException, SystemException {
190    
191                    return getUsersAdmin().getUsers(hits);
192            }
193    
194            public static List<Website> getWebsites(ActionRequest actionRequest) {
195                    return getUsersAdmin().getWebsites(actionRequest);
196            }
197    
198            public static boolean hasUpdateEmailAddress(
199                            PermissionChecker permissionChecker, User user)
200                    throws PortalException, SystemException {
201    
202                    return getUsersAdmin().hasUpdateEmailAddress(permissionChecker, user);
203            }
204    
205            public static boolean hasUpdateScreenName(
206                            PermissionChecker permissionChecker, User user)
207                    throws PortalException, SystemException {
208    
209                    return getUsersAdmin().hasUpdateScreenName(permissionChecker, user);
210            }
211    
212            public static long[] removeRequiredRoles(long userId, long[] roleIds)
213                    throws PortalException, SystemException {
214    
215                    return getUsersAdmin().removeRequiredRoles(userId, roleIds);
216            }
217    
218            public static long[] removeRequiredRoles(User user, long[] roleIds)
219                    throws PortalException, SystemException {
220    
221                    return getUsersAdmin().removeRequiredRoles(user, roleIds);
222            }
223    
224            public static void updateAddresses(
225                            String className, long classPK, List<Address> addresses)
226                    throws PortalException, SystemException {
227    
228                    getUsersAdmin().updateAddresses(className, classPK, addresses);
229            }
230    
231            public static void updateEmailAddresses(
232                            String className, long classPK, List<EmailAddress> emailAddresses)
233                    throws PortalException, SystemException {
234    
235                    getUsersAdmin().updateEmailAddresses(
236                            className, classPK, emailAddresses);
237            }
238    
239            public static void updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
240                    throws PortalException, SystemException {
241    
242                    getUsersAdmin().updateOrgLabors(classPK, orgLabors);
243            }
244    
245            public static void updatePhones(
246                            String className, long classPK, List<Phone> phones)
247                    throws PortalException, SystemException {
248    
249                    getUsersAdmin().updatePhones(className, classPK, phones);
250            }
251    
252            public static void updateWebsites(
253                            String className, long classPK, List<Website> websites)
254                    throws PortalException, SystemException {
255    
256                    getUsersAdmin().updateWebsites(className, classPK, websites);
257            }
258    
259            public static UsersAdmin getUsersAdmin() {
260                    return _usersAdmin;
261            }
262    
263            public void setUsersAdmin(UsersAdmin usersAdmin) {
264                    _usersAdmin = usersAdmin;
265            }
266    
267            private static UsersAdmin _usersAdmin;
268    
269    }