1   /**
2    * Copyright (c) 2000-2009 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.persistence;
24  
25  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.annotation.Propagation;
28  import com.liferay.portal.kernel.annotation.Transactional;
29  
30  /**
31   * <a href="UserGroupPersistence.java.html"><b><i>View Source</i></b></a>
32   *
33   * @author Brian Wing Shun Chan
34   *
35   */
36  @Transactional(rollbackFor =  {
37      PortalException.class, SystemException.class})
38  public interface UserGroupPersistence extends BasePersistence {
39      public com.liferay.portal.model.UserGroup create(long userGroupId);
40  
41      public com.liferay.portal.model.UserGroup remove(long userGroupId)
42          throws com.liferay.portal.NoSuchUserGroupException,
43              com.liferay.portal.SystemException;
44  
45      public com.liferay.portal.model.UserGroup remove(
46          com.liferay.portal.model.UserGroup userGroup)
47          throws com.liferay.portal.SystemException;
48  
49      /**
50       * @deprecated Use <code>update(UserGroup userGroup, boolean merge)</code>.
51       */
52      public com.liferay.portal.model.UserGroup update(
53          com.liferay.portal.model.UserGroup userGroup)
54          throws com.liferay.portal.SystemException;
55  
56      /**
57       * Add, update, or merge, the entity. This method also calls the model
58       * listeners to trigger the proper events associated with adding, deleting,
59       * or updating an entity.
60       *
61       * @param        userGroup the entity to add, update, or merge
62       * @param        merge boolean value for whether to merge the entity. The
63       *                default value is false. Setting merge to true is more
64       *                expensive and should only be true when userGroup is
65       *                transient. See LEP-5473 for a detailed discussion of this
66       *                method.
67       * @return        true if the portlet can be displayed via Ajax
68       */
69      public com.liferay.portal.model.UserGroup update(
70          com.liferay.portal.model.UserGroup userGroup, boolean merge)
71          throws com.liferay.portal.SystemException;
72  
73      public com.liferay.portal.model.UserGroup updateImpl(
74          com.liferay.portal.model.UserGroup userGroup, boolean merge)
75          throws com.liferay.portal.SystemException;
76  
77      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
78      public com.liferay.portal.model.UserGroup findByPrimaryKey(long userGroupId)
79          throws com.liferay.portal.NoSuchUserGroupException,
80              com.liferay.portal.SystemException;
81  
82      public com.liferay.portal.model.UserGroup fetchByPrimaryKey(
83          long userGroupId) throws com.liferay.portal.SystemException;
84  
85      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
86      public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId(
87          long companyId) throws com.liferay.portal.SystemException;
88  
89      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
90      public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId(
91          long companyId, int start, int end)
92          throws com.liferay.portal.SystemException;
93  
94      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
95      public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId(
96          long companyId, int start, int end,
97          com.liferay.portal.kernel.util.OrderByComparator obc)
98          throws com.liferay.portal.SystemException;
99  
100     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
101     public com.liferay.portal.model.UserGroup findByCompanyId_First(
102         long companyId, com.liferay.portal.kernel.util.OrderByComparator obc)
103         throws com.liferay.portal.NoSuchUserGroupException,
104             com.liferay.portal.SystemException;
105 
106     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
107     public com.liferay.portal.model.UserGroup findByCompanyId_Last(
108         long companyId, com.liferay.portal.kernel.util.OrderByComparator obc)
109         throws com.liferay.portal.NoSuchUserGroupException,
110             com.liferay.portal.SystemException;
111 
112     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
113     public com.liferay.portal.model.UserGroup[] findByCompanyId_PrevAndNext(
114         long userGroupId, long companyId,
115         com.liferay.portal.kernel.util.OrderByComparator obc)
116         throws com.liferay.portal.NoSuchUserGroupException,
117             com.liferay.portal.SystemException;
118 
119     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
120     public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
121         long companyId, long parentUserGroupId)
122         throws com.liferay.portal.SystemException;
123 
124     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125     public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
126         long companyId, long parentUserGroupId, int start, int end)
127         throws com.liferay.portal.SystemException;
128 
129     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
130     public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
131         long companyId, long parentUserGroupId, int start, int end,
132         com.liferay.portal.kernel.util.OrderByComparator obc)
133         throws com.liferay.portal.SystemException;
134 
135     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
136     public com.liferay.portal.model.UserGroup findByC_P_First(long companyId,
137         long parentUserGroupId,
138         com.liferay.portal.kernel.util.OrderByComparator obc)
139         throws com.liferay.portal.NoSuchUserGroupException,
140             com.liferay.portal.SystemException;
141 
142     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
143     public com.liferay.portal.model.UserGroup findByC_P_Last(long companyId,
144         long parentUserGroupId,
145         com.liferay.portal.kernel.util.OrderByComparator obc)
146         throws com.liferay.portal.NoSuchUserGroupException,
147             com.liferay.portal.SystemException;
148 
149     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150     public com.liferay.portal.model.UserGroup[] findByC_P_PrevAndNext(
151         long userGroupId, long companyId, long parentUserGroupId,
152         com.liferay.portal.kernel.util.OrderByComparator obc)
153         throws com.liferay.portal.NoSuchUserGroupException,
154             com.liferay.portal.SystemException;
155 
156     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157     public com.liferay.portal.model.UserGroup findByC_N(long companyId,
158         java.lang.String name)
159         throws com.liferay.portal.NoSuchUserGroupException,
160             com.liferay.portal.SystemException;
161 
162     public com.liferay.portal.model.UserGroup fetchByC_N(long companyId,
163         java.lang.String name) throws com.liferay.portal.SystemException;
164 
165     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
166     public java.util.List<Object> findWithDynamicQuery(
167         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
168         throws com.liferay.portal.SystemException;
169 
170     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171     public java.util.List<Object> findWithDynamicQuery(
172         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
173         int end) throws com.liferay.portal.SystemException;
174 
175     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176     public java.util.List<com.liferay.portal.model.UserGroup> findAll()
177         throws com.liferay.portal.SystemException;
178 
179     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
180     public java.util.List<com.liferay.portal.model.UserGroup> findAll(
181         int start, int end) throws com.liferay.portal.SystemException;
182 
183     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184     public java.util.List<com.liferay.portal.model.UserGroup> findAll(
185         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
186         throws com.liferay.portal.SystemException;
187 
188     public void removeByCompanyId(long companyId)
189         throws com.liferay.portal.SystemException;
190 
191     public void removeByC_P(long companyId, long parentUserGroupId)
192         throws com.liferay.portal.SystemException;
193 
194     public void removeByC_N(long companyId, java.lang.String name)
195         throws com.liferay.portal.NoSuchUserGroupException,
196             com.liferay.portal.SystemException;
197 
198     public void removeAll() throws com.liferay.portal.SystemException;
199 
200     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201     public int countByCompanyId(long companyId)
202         throws com.liferay.portal.SystemException;
203 
204     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205     public int countByC_P(long companyId, long parentUserGroupId)
206         throws com.liferay.portal.SystemException;
207 
208     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209     public int countByC_N(long companyId, java.lang.String name)
210         throws com.liferay.portal.SystemException;
211 
212     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213     public int countAll() throws com.liferay.portal.SystemException;
214 
215     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
216     public java.util.List<com.liferay.portal.model.User> getUsers(long pk)
217         throws com.liferay.portal.SystemException;
218 
219     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220     public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
221         int start, int end) throws com.liferay.portal.SystemException;
222 
223     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
224     public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
225         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
226         throws com.liferay.portal.SystemException;
227 
228     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
229     public int getUsersSize(long pk) throws com.liferay.portal.SystemException;
230 
231     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232     public boolean containsUser(long pk, long userPK)
233         throws com.liferay.portal.SystemException;
234 
235     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
236     public boolean containsUsers(long pk)
237         throws com.liferay.portal.SystemException;
238 
239     public void addUser(long pk, long userPK)
240         throws com.liferay.portal.SystemException;
241 
242     public void addUser(long pk, com.liferay.portal.model.User user)
243         throws com.liferay.portal.SystemException;
244 
245     public void addUsers(long pk, long[] userPKs)
246         throws com.liferay.portal.SystemException;
247 
248     public void addUsers(long pk,
249         java.util.List<com.liferay.portal.model.User> users)
250         throws com.liferay.portal.SystemException;
251 
252     public void clearUsers(long pk) throws com.liferay.portal.SystemException;
253 
254     public void removeUser(long pk, long userPK)
255         throws com.liferay.portal.SystemException;
256 
257     public void removeUser(long pk, com.liferay.portal.model.User user)
258         throws com.liferay.portal.SystemException;
259 
260     public void removeUsers(long pk, long[] userPKs)
261         throws com.liferay.portal.SystemException;
262 
263     public void removeUsers(long pk,
264         java.util.List<com.liferay.portal.model.User> users)
265         throws com.liferay.portal.SystemException;
266 
267     public void setUsers(long pk, long[] userPKs)
268         throws com.liferay.portal.SystemException;
269 
270     public void setUsers(long pk,
271         java.util.List<com.liferay.portal.model.User> users)
272         throws com.liferay.portal.SystemException;
273 }