001    /**
002     * Copyright (c) 2000-2011 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(
116                            permissionChecker, userGroups);
117            }
118    
119            public static List<Address> getAddresses(ActionRequest actionRequest) {
120                    return getUsersAdmin().getAddresses(actionRequest);
121            }
122    
123            public static List<EmailAddress> getEmailAddresses(
124                    ActionRequest actionRequest) {
125    
126                    return getUsersAdmin().getEmailAddresses(actionRequest);
127            }
128    
129            public static OrderByComparator getGroupOrderByComparator(
130                    String orderByCol, String orderByType) {
131    
132                    return getUsersAdmin().getGroupOrderByComparator(
133                            orderByCol, orderByType);
134            }
135    
136            public static Long[][] getLeftAndRightOrganizationIds(long organizationId)
137                    throws PortalException, SystemException {
138    
139                    return getUsersAdmin().getLeftAndRightOrganizationIds(organizationId);
140            }
141    
142            public static Long[][] getLeftAndRightOrganizationIds(
143                    Organization organization) {
144    
145                    return getUsersAdmin().getLeftAndRightOrganizationIds(organization);
146            }
147    
148            public static Long[][] getLeftAndRightOrganizationIds(
149                    List<Organization> organizations) {
150    
151                    return getUsersAdmin().getLeftAndRightOrganizationIds(organizations);
152            }
153    
154            public static Long[] getOrganizationIds(List<Organization> organizations) {
155                    return getUsersAdmin().getOrganizationIds(organizations);
156            }
157    
158            public static OrderByComparator getOrganizationOrderByComparator(
159                    String orderByCol, String orderByType) {
160    
161                    return getUsersAdmin().getOrganizationOrderByComparator(
162                            orderByCol, orderByType);
163            }
164    
165            public static Tuple getOrganizations(Hits hits)
166                    throws PortalException, SystemException {
167    
168                    return getUsersAdmin().getOrganizations(hits);
169            }
170    
171            public static List<OrgLabor> getOrgLabors(ActionRequest actionRequest) {
172                    return getUsersAdmin().getOrgLabors(actionRequest);
173            }
174    
175            public static List<Phone> getPhones(ActionRequest actionRequest) {
176                    return getUsersAdmin().getPhones(actionRequest);
177            }
178    
179            public static OrderByComparator getRoleOrderByComparator(
180                    String orderByCol, String orderByType) {
181    
182                    return getUsersAdmin().getRoleOrderByComparator(
183                            orderByCol, orderByType);
184            }
185    
186            public static OrderByComparator getUserGroupOrderByComparator(
187                    String orderByCol, String orderByType) {
188    
189                    return getUsersAdmin().getUserGroupOrderByComparator(
190                            orderByCol, orderByType);
191            }
192    
193            public static List<UserGroupRole> getUserGroupRoles(
194                            PortletRequest portletRequest)
195                    throws PortalException, SystemException {
196    
197                    return getUsersAdmin().getUserGroupRoles(portletRequest);
198            }
199    
200            public static OrderByComparator getUserOrderByComparator(
201                    String orderByCol, String orderByType) {
202    
203                    return getUsersAdmin().getUserOrderByComparator(
204                            orderByCol, orderByType);
205            }
206    
207            public static Tuple getUsers(Hits hits)
208                    throws PortalException, SystemException {
209    
210                    return getUsersAdmin().getUsers(hits);
211            }
212    
213            public static List<Website> getWebsites(ActionRequest actionRequest) {
214                    return getUsersAdmin().getWebsites(actionRequest);
215            }
216    
217            public static boolean hasUpdateEmailAddress(
218                            PermissionChecker permissionChecker, User user)
219                    throws PortalException, SystemException {
220    
221                    return getUsersAdmin().hasUpdateEmailAddress(permissionChecker, user);
222            }
223    
224            public static boolean hasUpdateScreenName(
225                            PermissionChecker permissionChecker, User user)
226                    throws PortalException, SystemException {
227    
228                    return getUsersAdmin().hasUpdateScreenName(permissionChecker, user);
229            }
230    
231            public static long[] removeRequiredRoles(long userId, long[] roleIds)
232                    throws PortalException, SystemException {
233    
234                    return getUsersAdmin().removeRequiredRoles(userId, roleIds);
235            }
236    
237            public static long[] removeRequiredRoles(User user, long[] roleIds)
238                    throws PortalException, SystemException {
239    
240                    return getUsersAdmin().removeRequiredRoles(user, roleIds);
241            }
242    
243            public static void updateAddresses(
244                            String className, long classPK, List<Address> addresses)
245                    throws PortalException, SystemException {
246    
247                    getUsersAdmin().updateAddresses(className, classPK, addresses);
248            }
249    
250            public static void updateEmailAddresses(
251                            String className, long classPK, List<EmailAddress> emailAddresses)
252                    throws PortalException, SystemException {
253    
254                    getUsersAdmin().updateEmailAddresses(
255                            className, classPK, emailAddresses);
256            }
257    
258            public static void updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
259                    throws PortalException, SystemException {
260    
261                    getUsersAdmin().updateOrgLabors(classPK, orgLabors);
262            }
263    
264            public static void updatePhones(
265                            String className, long classPK, List<Phone> phones)
266                    throws PortalException, SystemException {
267    
268                    getUsersAdmin().updatePhones(className, classPK, phones);
269            }
270    
271            public static void updateWebsites(
272                            String className, long classPK, List<Website> websites)
273                    throws PortalException, SystemException {
274    
275                    getUsersAdmin().updateWebsites(className, classPK, websites);
276            }
277    
278            public static UsersAdmin getUsersAdmin() {
279                    return _usersAdmin;
280            }
281    
282            public void setUsersAdmin(UsersAdmin usersAdmin) {
283                    _usersAdmin = usersAdmin;
284            }
285    
286            private static UsersAdmin _usersAdmin;
287    
288    }