001
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
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 List<Role> filterGroupRoles(
064 PermissionChecker permissionChecker, long groupId, List<Role> roles)
065 throws PortalException, SystemException;
066
067 public List<Group> filterGroups(
068 PermissionChecker permissionChecker, List<Group> groups)
069 throws PortalException, SystemException;
070
071 public List<Organization> filterOrganizations(
072 PermissionChecker permissionChecker,
073 List<Organization> organizations)
074 throws PortalException, SystemException;
075
076 public List<Role> filterRoles(
077 PermissionChecker permissionChecker, List<Role> roles);
078
079 public List<UserGroupRole> filterUserGroupRoles(
080 PermissionChecker permissionChecker,
081 List<UserGroupRole> userGroupRoles)
082 throws PortalException, SystemException;
083
084 public List<UserGroup> filterUserGroups(
085 PermissionChecker permissionChecker, List<UserGroup> userGroups);
086
087 public List<Address> getAddresses(ActionRequest actionRequest);
088
089 public List<EmailAddress> getEmailAddresses(ActionRequest actionRequest);
090
091 public OrderByComparator getGroupOrderByComparator(
092 String orderByCol, String orderByType);
093
094 public Long[] getOrganizationIds(List<Organization> organizations);
095
096 public OrderByComparator getOrganizationOrderByComparator(
097 String orderByCol, String orderByType);
098
099 public Tuple getOrganizations(Hits hits)
100 throws PortalException, SystemException;
101
102 public List<OrgLabor> getOrgLabors(ActionRequest actionRequest);
103
104 public List<Phone> getPhones(ActionRequest actionRequest);
105
106 public OrderByComparator getRoleOrderByComparator(
107 String orderByCol, String orderByType);
108
109 public OrderByComparator getUserGroupOrderByComparator(
110 String orderByCol, String orderByType);
111
112 public List<UserGroupRole> getUserGroupRoles(PortletRequest portletRequest)
113 throws PortalException, SystemException;
114
115 public OrderByComparator getUserOrderByComparator(
116 String orderByCol, String orderByType);
117
118 public Tuple getUsers(Hits hits) throws PortalException, SystemException;
119
120 public List<Website> getWebsites(ActionRequest actionRequest);
121
122 public boolean hasUpdateEmailAddress(
123 PermissionChecker permissionChecker, User user)
124 throws PortalException, SystemException;
125
126 public boolean hasUpdateScreenName(
127 PermissionChecker permissionChecker, User user)
128 throws PortalException, SystemException;
129
130 public long[] removeRequiredRoles(long userId, long[] roleIds)
131 throws PortalException, SystemException;
132
133 public long[] removeRequiredRoles(User user, long[] roleIds)
134 throws PortalException, SystemException;
135
136 public void updateAddresses(
137 String className, long classPK, List<Address> addresses)
138 throws PortalException, SystemException;
139
140 public void updateEmailAddresses(
141 String className, long classPK, List<EmailAddress> emailAddresses)
142 throws PortalException, SystemException;
143
144 public void updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
145 throws PortalException, SystemException;
146
147 public void updatePhones(String className, long classPK, List<Phone> phones)
148 throws PortalException, SystemException;
149
150 public void updateWebsites(
151 String className, long classPK, List<Website> websites)
152 throws PortalException, SystemException;
153
154 }