001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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[] getOrganizationIds(List<Organization> organizations) {
137                    return getUsersAdmin().getOrganizationIds(organizations);
138            }
139    
140            public static OrderByComparator getOrganizationOrderByComparator(
141                    String orderByCol, String orderByType) {
142    
143                    return getUsersAdmin().getOrganizationOrderByComparator(
144                            orderByCol, orderByType);
145            }
146    
147            public static Tuple getOrganizations(Hits hits)
148                    throws PortalException, SystemException {
149    
150                    return getUsersAdmin().getOrganizations(hits);
151            }
152    
153            public static List<OrgLabor> getOrgLabors(ActionRequest actionRequest) {
154                    return getUsersAdmin().getOrgLabors(actionRequest);
155            }
156    
157            public static List<Phone> getPhones(ActionRequest actionRequest) {
158                    return getUsersAdmin().getPhones(actionRequest);
159            }
160    
161            public static OrderByComparator getRoleOrderByComparator(
162                    String orderByCol, String orderByType) {
163    
164                    return getUsersAdmin().getRoleOrderByComparator(
165                            orderByCol, orderByType);
166            }
167    
168            public static OrderByComparator getUserGroupOrderByComparator(
169                    String orderByCol, String orderByType) {
170    
171                    return getUsersAdmin().getUserGroupOrderByComparator(
172                            orderByCol, orderByType);
173            }
174    
175            public static List<UserGroupRole> getUserGroupRoles(
176                            PortletRequest portletRequest)
177                    throws PortalException, SystemException {
178    
179                    return getUsersAdmin().getUserGroupRoles(portletRequest);
180            }
181    
182            public static OrderByComparator getUserOrderByComparator(
183                    String orderByCol, String orderByType) {
184    
185                    return getUsersAdmin().getUserOrderByComparator(
186                            orderByCol, orderByType);
187            }
188    
189            public static Tuple getUsers(Hits hits)
190                    throws PortalException, SystemException {
191    
192                    return getUsersAdmin().getUsers(hits);
193            }
194    
195            public static List<Website> getWebsites(ActionRequest actionRequest) {
196                    return getUsersAdmin().getWebsites(actionRequest);
197            }
198    
199            public static boolean hasUpdateEmailAddress(
200                            PermissionChecker permissionChecker, User user)
201                    throws PortalException, SystemException {
202    
203                    return getUsersAdmin().hasUpdateEmailAddress(permissionChecker, user);
204            }
205    
206            public static boolean hasUpdateScreenName(
207                            PermissionChecker permissionChecker, User user)
208                    throws PortalException, SystemException {
209    
210                    return getUsersAdmin().hasUpdateScreenName(permissionChecker, user);
211            }
212    
213            public static long[] removeRequiredRoles(long userId, long[] roleIds)
214                    throws PortalException, SystemException {
215    
216                    return getUsersAdmin().removeRequiredRoles(userId, roleIds);
217            }
218    
219            public static long[] removeRequiredRoles(User user, long[] roleIds)
220                    throws PortalException, SystemException {
221    
222                    return getUsersAdmin().removeRequiredRoles(user, roleIds);
223            }
224    
225            public static void updateAddresses(
226                            String className, long classPK, List<Address> addresses)
227                    throws PortalException, SystemException {
228    
229                    getUsersAdmin().updateAddresses(className, classPK, addresses);
230            }
231    
232            public static void updateEmailAddresses(
233                            String className, long classPK, List<EmailAddress> emailAddresses)
234                    throws PortalException, SystemException {
235    
236                    getUsersAdmin().updateEmailAddresses(
237                            className, classPK, emailAddresses);
238            }
239    
240            public static void updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
241                    throws PortalException, SystemException {
242    
243                    getUsersAdmin().updateOrgLabors(classPK, orgLabors);
244            }
245    
246            public static void updatePhones(
247                            String className, long classPK, List<Phone> phones)
248                    throws PortalException, SystemException {
249    
250                    getUsersAdmin().updatePhones(className, classPK, phones);
251            }
252    
253            public static void updateWebsites(
254                            String className, long classPK, List<Website> websites)
255                    throws PortalException, SystemException {
256    
257                    getUsersAdmin().updateWebsites(className, classPK, websites);
258            }
259    
260            public static UsersAdmin getUsersAdmin() {
261                    return _usersAdmin;
262            }
263    
264            public void setUsersAdmin(UsersAdmin usersAdmin) {
265                    _usersAdmin = usersAdmin;
266            }
267    
268            private static UsersAdmin _usersAdmin;
269    
270    }