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