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 interface UsersAdmin {
049    
050            public static final String CUSTOM_QUESTION = "write-my-own-question";
051    
052            public void addPortletBreadcrumbEntries(
053                            Organization organization, HttpServletRequest request,
054                            RenderResponse renderResponse)
055                    throws Exception;
056    
057            public long[] addRequiredRoles(long userId, long[] roleIds)
058                    throws PortalException, SystemException;
059    
060            public long[] addRequiredRoles(User user, long[] roleIds)
061                    throws PortalException, SystemException;
062    
063            public long[] filterDeleteGroupRoleUserIds(
064                            PermissionChecker permissionChecker, long groupId, long roleId,
065                            long[] userIds)
066                    throws PortalException, SystemException;
067    
068            public List<Role> filterGroupRoles(
069                            PermissionChecker permissionChecker, long groupId, List<Role> roles)
070                    throws PortalException, SystemException;
071    
072            public List<Group> filterGroups(
073                            PermissionChecker permissionChecker, List<Group> groups)
074                    throws PortalException, SystemException;
075    
076            public List<Organization> filterOrganizations(
077                            PermissionChecker permissionChecker,
078                            List<Organization> organizations)
079                    throws PortalException, SystemException;
080    
081            public List<Role> filterRoles(
082                    PermissionChecker permissionChecker, List<Role> roles);
083    
084            public long[] filterUnsetGroupUserIds(
085                            PermissionChecker permissionChecker, long groupId, long[] userIds)
086                    throws PortalException, SystemException;
087    
088            public List<UserGroupRole> filterUserGroupRoles(
089                            PermissionChecker permissionChecker,
090                            List<UserGroupRole> userGroupRoles)
091                    throws PortalException, SystemException;
092    
093            public List<UserGroup> filterUserGroups(
094                    PermissionChecker permissionChecker, List<UserGroup> userGroups);
095    
096            public List<Address> getAddresses(ActionRequest actionRequest);
097    
098            public List<Address> getAddresses(
099                    ActionRequest actionRequest, List<Address> defaultAddresses);
100    
101            public List<EmailAddress> getEmailAddresses(ActionRequest actionRequest);
102    
103            public List<EmailAddress> getEmailAddresses(
104                    ActionRequest actionRequest, List<EmailAddress> defaultEmailAddresses);
105    
106            public OrderByComparator getGroupOrderByComparator(
107                    String orderByCol, String orderByType);
108    
109            public Long[] getOrganizationIds(List<Organization> organizations);
110    
111            public OrderByComparator getOrganizationOrderByComparator(
112                    String orderByCol, String orderByType);
113    
114            public Tuple getOrganizations(Hits hits)
115                    throws PortalException, SystemException;
116    
117            public List<OrgLabor> getOrgLabors(ActionRequest actionRequest);
118    
119            public List<Phone> getPhones(ActionRequest actionRequest);
120    
121            public List<Phone> getPhones(
122                    ActionRequest actionRequest, List<Phone> defaultPhones);
123    
124            public OrderByComparator getRoleOrderByComparator(
125                    String orderByCol, String orderByType);
126    
127            public OrderByComparator getUserGroupOrderByComparator(
128                    String orderByCol, String orderByType);
129    
130            public List<UserGroupRole> getUserGroupRoles(PortletRequest portletRequest)
131                    throws PortalException, SystemException;
132    
133            public Tuple getUserGroups(Hits hits)
134                    throws PortalException, SystemException;
135    
136            public OrderByComparator getUserOrderByComparator(
137                    String orderByCol, String orderByType);
138    
139            public Tuple getUsers(Hits hits) throws PortalException, SystemException;
140    
141            public List<Website> getWebsites(ActionRequest actionRequest);
142    
143            public List<Website> getWebsites(
144                    ActionRequest actionRequest, List<Website> defaultWebsites);
145    
146            public boolean hasUpdateEmailAddress(
147                            PermissionChecker permissionChecker, User user)
148                    throws PortalException, SystemException;
149    
150            public boolean hasUpdateScreenName(
151                            PermissionChecker permissionChecker, User user)
152                    throws PortalException, SystemException;
153    
154            public long[] removeRequiredRoles(long userId, long[] roleIds)
155                    throws PortalException, SystemException;
156    
157            public long[] removeRequiredRoles(User user, long[] roleIds)
158                    throws PortalException, SystemException;
159    
160            public void updateAddresses(
161                            String className, long classPK, List<Address> addresses)
162                    throws PortalException, SystemException;
163    
164            public void updateEmailAddresses(
165                            String className, long classPK, List<EmailAddress> emailAddresses)
166                    throws PortalException, SystemException;
167    
168            public void updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
169                    throws PortalException, SystemException;
170    
171            public void updatePhones(String className, long classPK, List<Phone> phones)
172                    throws PortalException, SystemException;
173    
174            public void updateWebsites(
175                            String className, long classPK, List<Website> websites)
176                    throws PortalException, SystemException;
177    
178    }