001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service.persistence;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.model.OrgGroupRole;
020    
021    /**
022     * The persistence interface for the org group role service.
023     *
024     * <p>
025     * Caching information and settings can be found in <code>portal.properties</code>
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see OrgGroupRolePersistenceImpl
030     * @see OrgGroupRoleUtil
031     * @generated
032     */
033    @ProviderType
034    public interface OrgGroupRolePersistence extends BasePersistence<OrgGroupRole> {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify or reference this interface directly. Always use {@link OrgGroupRoleUtil} to access the org group role persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
039             */
040    
041            /**
042            * Returns all the org group roles where groupId = &#63;.
043            *
044            * @param groupId the group ID
045            * @return the matching org group roles
046            * @throws SystemException if a system exception occurred
047            */
048            public java.util.List<com.liferay.portal.model.OrgGroupRole> findByGroupId(
049                    long groupId)
050                    throws com.liferay.portal.kernel.exception.SystemException;
051    
052            /**
053            * Returns a range of all the org group roles where groupId = &#63;.
054            *
055            * <p>
056            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.OrgGroupRoleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
057            * </p>
058            *
059            * @param groupId the group ID
060            * @param start the lower bound of the range of org group roles
061            * @param end the upper bound of the range of org group roles (not inclusive)
062            * @return the range of matching org group roles
063            * @throws SystemException if a system exception occurred
064            */
065            public java.util.List<com.liferay.portal.model.OrgGroupRole> findByGroupId(
066                    long groupId, int start, int end)
067                    throws com.liferay.portal.kernel.exception.SystemException;
068    
069            /**
070            * Returns an ordered range of all the org group roles where groupId = &#63;.
071            *
072            * <p>
073            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.OrgGroupRoleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
074            * </p>
075            *
076            * @param groupId the group ID
077            * @param start the lower bound of the range of org group roles
078            * @param end the upper bound of the range of org group roles (not inclusive)
079            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
080            * @return the ordered range of matching org group roles
081            * @throws SystemException if a system exception occurred
082            */
083            public java.util.List<com.liferay.portal.model.OrgGroupRole> findByGroupId(
084                    long groupId, int start, int end,
085                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
086                    throws com.liferay.portal.kernel.exception.SystemException;
087    
088            /**
089            * Returns the first org group role in the ordered set where groupId = &#63;.
090            *
091            * @param groupId the group ID
092            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
093            * @return the first matching org group role
094            * @throws com.liferay.portal.NoSuchOrgGroupRoleException if a matching org group role could not be found
095            * @throws SystemException if a system exception occurred
096            */
097            public com.liferay.portal.model.OrgGroupRole findByGroupId_First(
098                    long groupId,
099                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
100                    throws com.liferay.portal.NoSuchOrgGroupRoleException,
101                            com.liferay.portal.kernel.exception.SystemException;
102    
103            /**
104            * Returns the first org group role in the ordered set where groupId = &#63;.
105            *
106            * @param groupId the group ID
107            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
108            * @return the first matching org group role, or <code>null</code> if a matching org group role could not be found
109            * @throws SystemException if a system exception occurred
110            */
111            public com.liferay.portal.model.OrgGroupRole fetchByGroupId_First(
112                    long groupId,
113                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
114                    throws com.liferay.portal.kernel.exception.SystemException;
115    
116            /**
117            * Returns the last org group role in the ordered set where groupId = &#63;.
118            *
119            * @param groupId the group ID
120            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
121            * @return the last matching org group role
122            * @throws com.liferay.portal.NoSuchOrgGroupRoleException if a matching org group role could not be found
123            * @throws SystemException if a system exception occurred
124            */
125            public com.liferay.portal.model.OrgGroupRole findByGroupId_Last(
126                    long groupId,
127                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
128                    throws com.liferay.portal.NoSuchOrgGroupRoleException,
129                            com.liferay.portal.kernel.exception.SystemException;
130    
131            /**
132            * Returns the last org group role in the ordered set where groupId = &#63;.
133            *
134            * @param groupId the group ID
135            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
136            * @return the last matching org group role, or <code>null</code> if a matching org group role could not be found
137            * @throws SystemException if a system exception occurred
138            */
139            public com.liferay.portal.model.OrgGroupRole fetchByGroupId_Last(
140                    long groupId,
141                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            /**
145            * Returns the org group roles before and after the current org group role in the ordered set where groupId = &#63;.
146            *
147            * @param orgGroupRolePK the primary key of the current org group role
148            * @param groupId the group ID
149            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
150            * @return the previous, current, and next org group role
151            * @throws com.liferay.portal.NoSuchOrgGroupRoleException if a org group role with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            public com.liferay.portal.model.OrgGroupRole[] findByGroupId_PrevAndNext(
155                    com.liferay.portal.service.persistence.OrgGroupRolePK orgGroupRolePK,
156                    long groupId,
157                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
158                    throws com.liferay.portal.NoSuchOrgGroupRoleException,
159                            com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Removes all the org group roles where groupId = &#63; from the database.
163            *
164            * @param groupId the group ID
165            * @throws SystemException if a system exception occurred
166            */
167            public void removeByGroupId(long groupId)
168                    throws com.liferay.portal.kernel.exception.SystemException;
169    
170            /**
171            * Returns the number of org group roles where groupId = &#63;.
172            *
173            * @param groupId the group ID
174            * @return the number of matching org group roles
175            * @throws SystemException if a system exception occurred
176            */
177            public int countByGroupId(long groupId)
178                    throws com.liferay.portal.kernel.exception.SystemException;
179    
180            /**
181            * Returns all the org group roles where roleId = &#63;.
182            *
183            * @param roleId the role ID
184            * @return the matching org group roles
185            * @throws SystemException if a system exception occurred
186            */
187            public java.util.List<com.liferay.portal.model.OrgGroupRole> findByRoleId(
188                    long roleId) throws com.liferay.portal.kernel.exception.SystemException;
189    
190            /**
191            * Returns a range of all the org group roles where roleId = &#63;.
192            *
193            * <p>
194            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.OrgGroupRoleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
195            * </p>
196            *
197            * @param roleId the role ID
198            * @param start the lower bound of the range of org group roles
199            * @param end the upper bound of the range of org group roles (not inclusive)
200            * @return the range of matching org group roles
201            * @throws SystemException if a system exception occurred
202            */
203            public java.util.List<com.liferay.portal.model.OrgGroupRole> findByRoleId(
204                    long roleId, int start, int end)
205                    throws com.liferay.portal.kernel.exception.SystemException;
206    
207            /**
208            * Returns an ordered range of all the org group roles where roleId = &#63;.
209            *
210            * <p>
211            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.OrgGroupRoleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
212            * </p>
213            *
214            * @param roleId the role ID
215            * @param start the lower bound of the range of org group roles
216            * @param end the upper bound of the range of org group roles (not inclusive)
217            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
218            * @return the ordered range of matching org group roles
219            * @throws SystemException if a system exception occurred
220            */
221            public java.util.List<com.liferay.portal.model.OrgGroupRole> findByRoleId(
222                    long roleId, int start, int end,
223                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            /**
227            * Returns the first org group role in the ordered set where roleId = &#63;.
228            *
229            * @param roleId the role ID
230            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
231            * @return the first matching org group role
232            * @throws com.liferay.portal.NoSuchOrgGroupRoleException if a matching org group role could not be found
233            * @throws SystemException if a system exception occurred
234            */
235            public com.liferay.portal.model.OrgGroupRole findByRoleId_First(
236                    long roleId,
237                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
238                    throws com.liferay.portal.NoSuchOrgGroupRoleException,
239                            com.liferay.portal.kernel.exception.SystemException;
240    
241            /**
242            * Returns the first org group role in the ordered set where roleId = &#63;.
243            *
244            * @param roleId the role ID
245            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
246            * @return the first matching org group role, or <code>null</code> if a matching org group role could not be found
247            * @throws SystemException if a system exception occurred
248            */
249            public com.liferay.portal.model.OrgGroupRole fetchByRoleId_First(
250                    long roleId,
251                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
252                    throws com.liferay.portal.kernel.exception.SystemException;
253    
254            /**
255            * Returns the last org group role in the ordered set where roleId = &#63;.
256            *
257            * @param roleId the role ID
258            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
259            * @return the last matching org group role
260            * @throws com.liferay.portal.NoSuchOrgGroupRoleException if a matching org group role could not be found
261            * @throws SystemException if a system exception occurred
262            */
263            public com.liferay.portal.model.OrgGroupRole findByRoleId_Last(
264                    long roleId,
265                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
266                    throws com.liferay.portal.NoSuchOrgGroupRoleException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            /**
270            * Returns the last org group role in the ordered set where roleId = &#63;.
271            *
272            * @param roleId the role ID
273            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
274            * @return the last matching org group role, or <code>null</code> if a matching org group role could not be found
275            * @throws SystemException if a system exception occurred
276            */
277            public com.liferay.portal.model.OrgGroupRole fetchByRoleId_Last(
278                    long roleId,
279                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    
282            /**
283            * Returns the org group roles before and after the current org group role in the ordered set where roleId = &#63;.
284            *
285            * @param orgGroupRolePK the primary key of the current org group role
286            * @param roleId the role ID
287            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
288            * @return the previous, current, and next org group role
289            * @throws com.liferay.portal.NoSuchOrgGroupRoleException if a org group role with the primary key could not be found
290            * @throws SystemException if a system exception occurred
291            */
292            public com.liferay.portal.model.OrgGroupRole[] findByRoleId_PrevAndNext(
293                    com.liferay.portal.service.persistence.OrgGroupRolePK orgGroupRolePK,
294                    long roleId,
295                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
296                    throws com.liferay.portal.NoSuchOrgGroupRoleException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            /**
300            * Removes all the org group roles where roleId = &#63; from the database.
301            *
302            * @param roleId the role ID
303            * @throws SystemException if a system exception occurred
304            */
305            public void removeByRoleId(long roleId)
306                    throws com.liferay.portal.kernel.exception.SystemException;
307    
308            /**
309            * Returns the number of org group roles where roleId = &#63;.
310            *
311            * @param roleId the role ID
312            * @return the number of matching org group roles
313            * @throws SystemException if a system exception occurred
314            */
315            public int countByRoleId(long roleId)
316                    throws com.liferay.portal.kernel.exception.SystemException;
317    
318            /**
319            * Caches the org group role in the entity cache if it is enabled.
320            *
321            * @param orgGroupRole the org group role
322            */
323            public void cacheResult(com.liferay.portal.model.OrgGroupRole orgGroupRole);
324    
325            /**
326            * Caches the org group roles in the entity cache if it is enabled.
327            *
328            * @param orgGroupRoles the org group roles
329            */
330            public void cacheResult(
331                    java.util.List<com.liferay.portal.model.OrgGroupRole> orgGroupRoles);
332    
333            /**
334            * Creates a new org group role with the primary key. Does not add the org group role to the database.
335            *
336            * @param orgGroupRolePK the primary key for the new org group role
337            * @return the new org group role
338            */
339            public com.liferay.portal.model.OrgGroupRole create(
340                    com.liferay.portal.service.persistence.OrgGroupRolePK orgGroupRolePK);
341    
342            /**
343            * Removes the org group role with the primary key from the database. Also notifies the appropriate model listeners.
344            *
345            * @param orgGroupRolePK the primary key of the org group role
346            * @return the org group role that was removed
347            * @throws com.liferay.portal.NoSuchOrgGroupRoleException if a org group role with the primary key could not be found
348            * @throws SystemException if a system exception occurred
349            */
350            public com.liferay.portal.model.OrgGroupRole remove(
351                    com.liferay.portal.service.persistence.OrgGroupRolePK orgGroupRolePK)
352                    throws com.liferay.portal.NoSuchOrgGroupRoleException,
353                            com.liferay.portal.kernel.exception.SystemException;
354    
355            public com.liferay.portal.model.OrgGroupRole updateImpl(
356                    com.liferay.portal.model.OrgGroupRole orgGroupRole)
357                    throws com.liferay.portal.kernel.exception.SystemException;
358    
359            /**
360            * Returns the org group role with the primary key or throws a {@link com.liferay.portal.NoSuchOrgGroupRoleException} if it could not be found.
361            *
362            * @param orgGroupRolePK the primary key of the org group role
363            * @return the org group role
364            * @throws com.liferay.portal.NoSuchOrgGroupRoleException if a org group role with the primary key could not be found
365            * @throws SystemException if a system exception occurred
366            */
367            public com.liferay.portal.model.OrgGroupRole findByPrimaryKey(
368                    com.liferay.portal.service.persistence.OrgGroupRolePK orgGroupRolePK)
369                    throws com.liferay.portal.NoSuchOrgGroupRoleException,
370                            com.liferay.portal.kernel.exception.SystemException;
371    
372            /**
373            * Returns the org group role with the primary key or returns <code>null</code> if it could not be found.
374            *
375            * @param orgGroupRolePK the primary key of the org group role
376            * @return the org group role, or <code>null</code> if a org group role with the primary key could not be found
377            * @throws SystemException if a system exception occurred
378            */
379            public com.liferay.portal.model.OrgGroupRole fetchByPrimaryKey(
380                    com.liferay.portal.service.persistence.OrgGroupRolePK orgGroupRolePK)
381                    throws com.liferay.portal.kernel.exception.SystemException;
382    
383            /**
384            * Returns all the org group roles.
385            *
386            * @return the org group roles
387            * @throws SystemException if a system exception occurred
388            */
389            public java.util.List<com.liferay.portal.model.OrgGroupRole> findAll()
390                    throws com.liferay.portal.kernel.exception.SystemException;
391    
392            /**
393            * Returns a range of all the org group roles.
394            *
395            * <p>
396            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.OrgGroupRoleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
397            * </p>
398            *
399            * @param start the lower bound of the range of org group roles
400            * @param end the upper bound of the range of org group roles (not inclusive)
401            * @return the range of org group roles
402            * @throws SystemException if a system exception occurred
403            */
404            public java.util.List<com.liferay.portal.model.OrgGroupRole> findAll(
405                    int start, int end)
406                    throws com.liferay.portal.kernel.exception.SystemException;
407    
408            /**
409            * Returns an ordered range of all the org group roles.
410            *
411            * <p>
412            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.OrgGroupRoleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
413            * </p>
414            *
415            * @param start the lower bound of the range of org group roles
416            * @param end the upper bound of the range of org group roles (not inclusive)
417            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
418            * @return the ordered range of org group roles
419            * @throws SystemException if a system exception occurred
420            */
421            public java.util.List<com.liferay.portal.model.OrgGroupRole> findAll(
422                    int start, int end,
423                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
424                    throws com.liferay.portal.kernel.exception.SystemException;
425    
426            /**
427            * Removes all the org group roles from the database.
428            *
429            * @throws SystemException if a system exception occurred
430            */
431            public void removeAll()
432                    throws com.liferay.portal.kernel.exception.SystemException;
433    
434            /**
435            * Returns the number of org group roles.
436            *
437            * @return the number of org group roles
438            * @throws SystemException if a system exception occurred
439            */
440            public int countAll()
441                    throws com.liferay.portal.kernel.exception.SystemException;
442    }