1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   *
12   *
13   */
14  
15  package com.liferay.portlet.enterpriseadmin.util;
16  
17  import com.liferay.portal.PortalException;
18  import com.liferay.portal.SystemException;
19  import com.liferay.portal.kernel.util.OrderByComparator;
20  import com.liferay.portal.model.Address;
21  import com.liferay.portal.model.EmailAddress;
22  import com.liferay.portal.model.Group;
23  import com.liferay.portal.model.OrgLabor;
24  import com.liferay.portal.model.Organization;
25  import com.liferay.portal.model.Phone;
26  import com.liferay.portal.model.Role;
27  import com.liferay.portal.model.User;
28  import com.liferay.portal.model.UserGroup;
29  import com.liferay.portal.model.UserGroupRole;
30  import com.liferay.portal.model.Website;
31  import com.liferay.portal.security.permission.PermissionChecker;
32  
33  import java.util.List;
34  
35  import javax.portlet.ActionRequest;
36  import javax.portlet.PortletRequest;
37  
38  /**
39   * <a href="EnterpriseAdmin.java.html"><b><i>View Source</i></b></a>
40   *
41   * @author Brian Wing Shun Chan
42   * @author Jorge Ferrer
43   * @author Julio Camarero
44   */
45  public interface EnterpriseAdmin {
46  
47      public String getCssClassName(Role role);
48  
49      public long[] addRequiredRoles(long userId, long[] roleIds)
50          throws PortalException, SystemException;
51  
52      public long[] addRequiredRoles(User user, long[] roleIds)
53          throws PortalException, SystemException;
54  
55      public List<Role> filterGroupRoles(
56              PermissionChecker permissionChecker, long groupId,
57              List<Role> roles)
58          throws PortalException, SystemException;
59  
60      public List<Group> filterGroups(
61              PermissionChecker permissionChecker, List<Group> groups)
62          throws PortalException, SystemException;
63  
64      public List<Organization> filterOrganizations(
65              PermissionChecker permissionChecker,
66              List<Organization> organizations)
67          throws PortalException, SystemException;
68  
69      public List<Role> filterRoles(
70          PermissionChecker permissionChecker, List<Role> roles);
71  
72      public List<UserGroupRole> filterUserGroupRoles(
73              PermissionChecker permissionChecker,
74              List<UserGroupRole> userGroupRoles)
75          throws PortalException, SystemException;
76  
77      public List<UserGroup> filterUserGroups(
78          PermissionChecker permissionChecker, List<UserGroup> userGroups);
79  
80      public List<Address> getAddresses(ActionRequest actionRequest);
81  
82      public List<EmailAddress> getEmailAddresses(ActionRequest actionRequest);
83  
84      public OrderByComparator getGroupOrderByComparator(
85          String orderByCol, String orderByType);
86  
87      public Long[][] getLeftAndRightOrganizationIds(long organizationId)
88          throws PortalException, SystemException;
89  
90      public Long[][] getLeftAndRightOrganizationIds(Organization organization);
91  
92      public Long[][] getLeftAndRightOrganizationIds(
93          List<Organization> organizations);
94  
95      public Long[] getOrganizationIds(List<Organization> organizations);
96  
97      public OrderByComparator getOrganizationOrderByComparator(
98          String orderByCol, String orderByType);
99  
100     public List<OrgLabor> getOrgLabors(ActionRequest actionRequest);
101 
102     public OrderByComparator getPasswordPolicyOrderByComparator(
103         String orderByCol, String orderByType);
104 
105     public List<Phone> getPhones(ActionRequest actionRequest);
106 
107     public OrderByComparator getRoleOrderByComparator(
108         String orderByCol, String orderByType);
109 
110     public OrderByComparator getUserGroupOrderByComparator(
111         String orderByCol, String orderByType);
112 
113     public List<UserGroupRole> getUserGroupRoles(PortletRequest portletRequest)
114         throws SystemException, PortalException;
115 
116     public OrderByComparator getUserOrderByComparator(
117         String orderByCol, String orderByType);
118 
119     public List<Website> getWebsites(ActionRequest actionRequest);
120 
121     public boolean hasUpdateEmailAddress(
122         PermissionChecker permissionChecker, User user);
123 
124     public boolean hasUpdateScreenName(
125         PermissionChecker permissionChecker, User user);
126 
127     public long[] removeRequiredRoles(long userId, long[] roleIds)
128         throws PortalException, SystemException;
129 
130     public long[] removeRequiredRoles(User user, long[] roleIds)
131         throws PortalException, SystemException;
132 
133     public void updateAddresses(
134             String className, long classPK, List<Address> addresses)
135         throws PortalException, SystemException;
136 
137     public void updateEmailAddresses(
138             String className, long classPK, List<EmailAddress> emailAddresses)
139         throws PortalException, SystemException;
140 
141     public void updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
142         throws PortalException, SystemException;
143 
144     public void updatePhones(
145             String className, long classPK, List<Phone> phones)
146         throws PortalException, SystemException;
147 
148     public void updateWebsites(
149             String className, long classPK, List<Website> websites)
150         throws PortalException, SystemException;
151 
152 }