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  /**
23   * <a href="PermissionPersistence.java.html"><b><i>View Source</i></b></a>
24   *
25   * @author Brian Wing Shun Chan
26   *
27   */
28  public interface PermissionPersistence extends BasePersistence {
29      public void cacheResult(com.liferay.portal.model.Permission permission);
30  
31      public void cacheResult(
32          java.util.List<com.liferay.portal.model.Permission> permissions);
33  
34      public void clearCache();
35  
36      public com.liferay.portal.model.Permission create(long permissionId);
37  
38      public com.liferay.portal.model.Permission remove(long permissionId)
39          throws com.liferay.portal.NoSuchPermissionException,
40              com.liferay.portal.SystemException;
41  
42      public com.liferay.portal.model.Permission remove(
43          com.liferay.portal.model.Permission permission)
44          throws com.liferay.portal.SystemException;
45  
46      /**
47       * @deprecated Use <code>update(Permission permission, boolean merge)</code>.
48       */
49      public com.liferay.portal.model.Permission update(
50          com.liferay.portal.model.Permission permission)
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        permission 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 permission 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.Permission update(
67          com.liferay.portal.model.Permission permission, boolean merge)
68          throws com.liferay.portal.SystemException;
69  
70      public com.liferay.portal.model.Permission updateImpl(
71          com.liferay.portal.model.Permission permission, boolean merge)
72          throws com.liferay.portal.SystemException;
73  
74      public com.liferay.portal.model.Permission findByPrimaryKey(
75          long permissionId)
76          throws com.liferay.portal.NoSuchPermissionException,
77              com.liferay.portal.SystemException;
78  
79      public com.liferay.portal.model.Permission fetchByPrimaryKey(
80          long permissionId) throws com.liferay.portal.SystemException;
81  
82      public java.util.List<com.liferay.portal.model.Permission> findByResourceId(
83          long resourceId) throws com.liferay.portal.SystemException;
84  
85      public java.util.List<com.liferay.portal.model.Permission> findByResourceId(
86          long resourceId, int start, int end)
87          throws com.liferay.portal.SystemException;
88  
89      public java.util.List<com.liferay.portal.model.Permission> findByResourceId(
90          long resourceId, int start, int end,
91          com.liferay.portal.kernel.util.OrderByComparator obc)
92          throws com.liferay.portal.SystemException;
93  
94      public com.liferay.portal.model.Permission findByResourceId_First(
95          long resourceId, com.liferay.portal.kernel.util.OrderByComparator obc)
96          throws com.liferay.portal.NoSuchPermissionException,
97              com.liferay.portal.SystemException;
98  
99      public com.liferay.portal.model.Permission findByResourceId_Last(
100         long resourceId, com.liferay.portal.kernel.util.OrderByComparator obc)
101         throws com.liferay.portal.NoSuchPermissionException,
102             com.liferay.portal.SystemException;
103 
104     public com.liferay.portal.model.Permission[] findByResourceId_PrevAndNext(
105         long permissionId, long resourceId,
106         com.liferay.portal.kernel.util.OrderByComparator obc)
107         throws com.liferay.portal.NoSuchPermissionException,
108             com.liferay.portal.SystemException;
109 
110     public com.liferay.portal.model.Permission findByA_R(
111         java.lang.String actionId, long resourceId)
112         throws com.liferay.portal.NoSuchPermissionException,
113             com.liferay.portal.SystemException;
114 
115     public com.liferay.portal.model.Permission fetchByA_R(
116         java.lang.String actionId, long resourceId)
117         throws com.liferay.portal.SystemException;
118 
119     public com.liferay.portal.model.Permission fetchByA_R(
120         java.lang.String actionId, long resourceId, boolean retrieveFromCache)
121         throws com.liferay.portal.SystemException;
122 
123     public java.util.List<Object> findWithDynamicQuery(
124         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
125         throws com.liferay.portal.SystemException;
126 
127     public java.util.List<Object> findWithDynamicQuery(
128         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
129         int end) throws com.liferay.portal.SystemException;
130 
131     public java.util.List<com.liferay.portal.model.Permission> findAll()
132         throws com.liferay.portal.SystemException;
133 
134     public java.util.List<com.liferay.portal.model.Permission> findAll(
135         int start, int end) throws com.liferay.portal.SystemException;
136 
137     public java.util.List<com.liferay.portal.model.Permission> findAll(
138         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
139         throws com.liferay.portal.SystemException;
140 
141     public void removeByResourceId(long resourceId)
142         throws com.liferay.portal.SystemException;
143 
144     public void removeByA_R(java.lang.String actionId, long resourceId)
145         throws com.liferay.portal.NoSuchPermissionException,
146             com.liferay.portal.SystemException;
147 
148     public void removeAll() throws com.liferay.portal.SystemException;
149 
150     public int countByResourceId(long resourceId)
151         throws com.liferay.portal.SystemException;
152 
153     public int countByA_R(java.lang.String actionId, long resourceId)
154         throws com.liferay.portal.SystemException;
155 
156     public int countAll() throws com.liferay.portal.SystemException;
157 
158     public java.util.List<com.liferay.portal.model.Group> getGroups(long pk)
159         throws com.liferay.portal.SystemException;
160 
161     public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
162         int start, int end) throws com.liferay.portal.SystemException;
163 
164     public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
165         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
166         throws com.liferay.portal.SystemException;
167 
168     public int getGroupsSize(long pk) throws com.liferay.portal.SystemException;
169 
170     public boolean containsGroup(long pk, long groupPK)
171         throws com.liferay.portal.SystemException;
172 
173     public boolean containsGroups(long pk)
174         throws com.liferay.portal.SystemException;
175 
176     public void addGroup(long pk, long groupPK)
177         throws com.liferay.portal.SystemException;
178 
179     public void addGroup(long pk, com.liferay.portal.model.Group group)
180         throws com.liferay.portal.SystemException;
181 
182     public void addGroups(long pk, long[] groupPKs)
183         throws com.liferay.portal.SystemException;
184 
185     public void addGroups(long pk,
186         java.util.List<com.liferay.portal.model.Group> groups)
187         throws com.liferay.portal.SystemException;
188 
189     public void clearGroups(long pk) throws com.liferay.portal.SystemException;
190 
191     public void removeGroup(long pk, long groupPK)
192         throws com.liferay.portal.SystemException;
193 
194     public void removeGroup(long pk, com.liferay.portal.model.Group group)
195         throws com.liferay.portal.SystemException;
196 
197     public void removeGroups(long pk, long[] groupPKs)
198         throws com.liferay.portal.SystemException;
199 
200     public void removeGroups(long pk,
201         java.util.List<com.liferay.portal.model.Group> groups)
202         throws com.liferay.portal.SystemException;
203 
204     public void setGroups(long pk, long[] groupPKs)
205         throws com.liferay.portal.SystemException;
206 
207     public void setGroups(long pk,
208         java.util.List<com.liferay.portal.model.Group> groups)
209         throws com.liferay.portal.SystemException;
210 
211     public java.util.List<com.liferay.portal.model.Role> getRoles(long pk)
212         throws com.liferay.portal.SystemException;
213 
214     public java.util.List<com.liferay.portal.model.Role> getRoles(long pk,
215         int start, int end) throws com.liferay.portal.SystemException;
216 
217     public java.util.List<com.liferay.portal.model.Role> getRoles(long pk,
218         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
219         throws com.liferay.portal.SystemException;
220 
221     public int getRolesSize(long pk) throws com.liferay.portal.SystemException;
222 
223     public boolean containsRole(long pk, long rolePK)
224         throws com.liferay.portal.SystemException;
225 
226     public boolean containsRoles(long pk)
227         throws com.liferay.portal.SystemException;
228 
229     public void addRole(long pk, long rolePK)
230         throws com.liferay.portal.SystemException;
231 
232     public void addRole(long pk, com.liferay.portal.model.Role role)
233         throws com.liferay.portal.SystemException;
234 
235     public void addRoles(long pk, long[] rolePKs)
236         throws com.liferay.portal.SystemException;
237 
238     public void addRoles(long pk,
239         java.util.List<com.liferay.portal.model.Role> roles)
240         throws com.liferay.portal.SystemException;
241 
242     public void clearRoles(long pk) throws com.liferay.portal.SystemException;
243 
244     public void removeRole(long pk, long rolePK)
245         throws com.liferay.portal.SystemException;
246 
247     public void removeRole(long pk, com.liferay.portal.model.Role role)
248         throws com.liferay.portal.SystemException;
249 
250     public void removeRoles(long pk, long[] rolePKs)
251         throws com.liferay.portal.SystemException;
252 
253     public void removeRoles(long pk,
254         java.util.List<com.liferay.portal.model.Role> roles)
255         throws com.liferay.portal.SystemException;
256 
257     public void setRoles(long pk, long[] rolePKs)
258         throws com.liferay.portal.SystemException;
259 
260     public void setRoles(long pk,
261         java.util.List<com.liferay.portal.model.Role> roles)
262         throws com.liferay.portal.SystemException;
263 
264     public java.util.List<com.liferay.portal.model.User> getUsers(long pk)
265         throws com.liferay.portal.SystemException;
266 
267     public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
268         int start, int end) throws com.liferay.portal.SystemException;
269 
270     public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
271         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
272         throws com.liferay.portal.SystemException;
273 
274     public int getUsersSize(long pk) throws com.liferay.portal.SystemException;
275 
276     public boolean containsUser(long pk, long userPK)
277         throws com.liferay.portal.SystemException;
278 
279     public boolean containsUsers(long pk)
280         throws com.liferay.portal.SystemException;
281 
282     public void addUser(long pk, long userPK)
283         throws com.liferay.portal.SystemException;
284 
285     public void addUser(long pk, com.liferay.portal.model.User user)
286         throws com.liferay.portal.SystemException;
287 
288     public void addUsers(long pk, long[] userPKs)
289         throws com.liferay.portal.SystemException;
290 
291     public void addUsers(long pk,
292         java.util.List<com.liferay.portal.model.User> users)
293         throws com.liferay.portal.SystemException;
294 
295     public void clearUsers(long pk) throws com.liferay.portal.SystemException;
296 
297     public void removeUser(long pk, long userPK)
298         throws com.liferay.portal.SystemException;
299 
300     public void removeUser(long pk, com.liferay.portal.model.User user)
301         throws com.liferay.portal.SystemException;
302 
303     public void removeUsers(long pk, long[] userPKs)
304         throws com.liferay.portal.SystemException;
305 
306     public void removeUsers(long pk,
307         java.util.List<com.liferay.portal.model.User> users)
308         throws com.liferay.portal.SystemException;
309 
310     public void setUsers(long pk, long[] userPKs)
311         throws com.liferay.portal.SystemException;
312 
313     public void setUsers(long pk,
314         java.util.List<com.liferay.portal.model.User> users)
315         throws com.liferay.portal.SystemException;
316 }