1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.service;
24  
25  
26  /**
27   * <a href="GroupService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portal.service.impl.GroupServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portal.service.GroupServiceFactory
48   * @see com.liferay.portal.service.GroupServiceUtil
49   *
50   */
51  public interface GroupService {
52      public com.liferay.portal.model.Group addGroup(java.lang.String name,
53          java.lang.String description, int type, java.lang.String friendlyURL,
54          boolean active)
55          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
56              com.liferay.portal.PortalException;
57  
58      public com.liferay.portal.model.Group addGroup(long liveGroupId,
59          java.lang.String name, java.lang.String description, int type,
60          java.lang.String friendlyURL, boolean active)
61          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
62              com.liferay.portal.PortalException;
63  
64      public void addRoleGroups(long roleId, long[] groupIds)
65          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
66              com.liferay.portal.PortalException;
67  
68      public void deleteGroup(long groupId)
69          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
70              com.liferay.portal.PortalException;
71  
72      public com.liferay.portal.model.Group getGroup(long groupId)
73          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
74              com.liferay.portal.PortalException;
75  
76      public com.liferay.portal.model.Group getGroup(long companyId,
77          java.lang.String name)
78          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
79              com.liferay.portal.PortalException;
80  
81      public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups(
82          java.util.List<com.liferay.portal.model.Organization> organizations)
83          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
84              com.liferay.portal.PortalException;
85  
86      public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups(
87          java.util.List<com.liferay.portal.model.UserGroup> userGroups)
88          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
89              com.liferay.portal.PortalException;
90  
91      public boolean hasUserGroup(long userId, long groupId)
92          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
93  
94      public java.util.List<com.liferay.portal.model.Group> search(
95          long companyId, java.lang.String name, java.lang.String description,
96          java.lang.String[] params, int begin, int end)
97          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
98  
99      public int searchCount(long companyId, java.lang.String name,
100         java.lang.String description, java.lang.String[] params)
101         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
102 
103     public void setRoleGroups(long roleId, long[] groupIds)
104         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
105             com.liferay.portal.PortalException;
106 
107     public void unsetRoleGroups(long roleId, long[] groupIds)
108         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
109             com.liferay.portal.PortalException;
110 
111     public com.liferay.portal.model.Group updateFriendlyURL(long groupId,
112         java.lang.String friendlyURL)
113         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
114             com.liferay.portal.PortalException;
115 
116     public com.liferay.portal.model.Group updateGroup(long groupId,
117         java.lang.String name, java.lang.String description, int type,
118         java.lang.String friendlyURL, boolean active)
119         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
120             com.liferay.portal.PortalException;
121 
122     public com.liferay.portal.model.Group updateGroup(long groupId,
123         java.lang.String typeSettings)
124         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
125             com.liferay.portal.PortalException;
126 
127     public com.liferay.portal.model.Group updateWorkflow(long groupId,
128         boolean workflowEnabled, int workflowStages,
129         java.lang.String workflowRoleNames)
130         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
131             com.liferay.portal.PortalException;
132 }