001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the resource permission local service. This utility wraps {@link com.liferay.portal.service.impl.ResourcePermissionLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.ResourcePermissionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see ResourcePermissionLocalService
032     * @see com.liferay.portal.service.base.ResourcePermissionLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.ResourcePermissionLocalServiceImpl
034     * @generated
035     */
036    public class ResourcePermissionLocalServiceUtil {
037            /**
038            * Adds the resource permission to the database. Also notifies the appropriate model listeners.
039            *
040            * @param resourcePermission the resource permission to add
041            * @return the resource permission that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portal.model.ResourcePermission addResourcePermission(
045                    com.liferay.portal.model.ResourcePermission resourcePermission)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addResourcePermission(resourcePermission);
048            }
049    
050            /**
051            * Creates a new resource permission with the primary key. Does not add the resource permission to the database.
052            *
053            * @param resourcePermissionId the primary key for the new resource permission
054            * @return the new resource permission
055            */
056            public static com.liferay.portal.model.ResourcePermission createResourcePermission(
057                    long resourcePermissionId) {
058                    return getService().createResourcePermission(resourcePermissionId);
059            }
060    
061            /**
062            * Deletes the resource permission with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param resourcePermissionId the primary key of the resource permission to delete
065            * @throws PortalException if a resource permission with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteResourcePermission(long resourcePermissionId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteResourcePermission(resourcePermissionId);
072            }
073    
074            /**
075            * Deletes the resource permission from the database. Also notifies the appropriate model listeners.
076            *
077            * @param resourcePermission the resource permission to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteResourcePermission(
081                    com.liferay.portal.model.ResourcePermission resourcePermission)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteResourcePermission(resourcePermission);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the resource permission with the primary key.
159            *
160            * @param resourcePermissionId the primary key of the resource permission to get
161            * @return the resource permission
162            * @throws PortalException if a resource permission with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portal.model.ResourcePermission getResourcePermission(
166                    long resourcePermissionId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getResourcePermission(resourcePermissionId);
170            }
171    
172            /**
173            * Gets a range of all the resource permissions.
174            *
175            * <p>
176            * 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.
177            * </p>
178            *
179            * @param start the lower bound of the range of resource permissions to return
180            * @param end the upper bound of the range of resource permissions to return (not inclusive)
181            * @return the range of resource permissions
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portal.model.ResourcePermission> getResourcePermissions(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getResourcePermissions(start, end);
188            }
189    
190            /**
191            * Gets the number of resource permissions.
192            *
193            * @return the number of resource permissions
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getResourcePermissionsCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getResourcePermissionsCount();
199            }
200    
201            /**
202            * Updates the resource permission in the database. Also notifies the appropriate model listeners.
203            *
204            * @param resourcePermission the resource permission to update
205            * @return the resource permission that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portal.model.ResourcePermission updateResourcePermission(
209                    com.liferay.portal.model.ResourcePermission resourcePermission)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateResourcePermission(resourcePermission);
212            }
213    
214            /**
215            * Updates the resource permission in the database. Also notifies the appropriate model listeners.
216            *
217            * @param resourcePermission the resource permission to update
218            * @param merge whether to merge the resource permission with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
219            * @return the resource permission that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portal.model.ResourcePermission updateResourcePermission(
223                    com.liferay.portal.model.ResourcePermission resourcePermission,
224                    boolean merge)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().updateResourcePermission(resourcePermission, merge);
227            }
228    
229            public static void addResourcePermission(long companyId,
230                    java.lang.String name, int scope, java.lang.String primKey,
231                    long roleId, java.lang.String actionId)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException {
234                    getService()
235                            .addResourcePermission(companyId, name, scope, primKey, roleId,
236                            actionId);
237            }
238    
239            public static java.util.List<java.lang.String> getAvailableResourcePermissionActionIds(
240                    long companyId, java.lang.String name, int scope,
241                    java.lang.String primKey, long roleId,
242                    java.util.List<java.lang.String> actionIds)
243                    throws com.liferay.portal.kernel.exception.PortalException,
244                            com.liferay.portal.kernel.exception.SystemException {
245                    return getService()
246                                       .getAvailableResourcePermissionActionIds(companyId, name,
247                            scope, primKey, roleId, actionIds);
248            }
249    
250            public static java.util.List<com.liferay.portal.model.ResourcePermission> getResourcePermissions(
251                    long companyId, java.lang.String name, int scope,
252                    java.lang.String primKey)
253                    throws com.liferay.portal.kernel.exception.SystemException {
254                    return getService()
255                                       .getResourcePermissions(companyId, name, scope, primKey);
256            }
257    
258            public static int getResourcePermissionsCount(long companyId,
259                    java.lang.String name, int scope, java.lang.String primKey)
260                    throws com.liferay.portal.kernel.exception.SystemException {
261                    return getService()
262                                       .getResourcePermissionsCount(companyId, name, scope, primKey);
263            }
264    
265            public static java.util.List<com.liferay.portal.model.ResourcePermission> getRoleResourcePermissions(
266                    long roleId) throws com.liferay.portal.kernel.exception.SystemException {
267                    return getService().getRoleResourcePermissions(roleId);
268            }
269    
270            public static java.util.List<com.liferay.portal.model.ResourcePermission> getRoleResourcePermissions(
271                    long roleId, int[] scopes, int start, int end)
272                    throws com.liferay.portal.kernel.exception.SystemException {
273                    return getService()
274                                       .getRoleResourcePermissions(roleId, scopes, start, end);
275            }
276    
277            public static boolean hasActionId(
278                    com.liferay.portal.model.ResourcePermission resourcePermission,
279                    com.liferay.portal.model.ResourceAction resourceAction) {
280                    return getService().hasActionId(resourcePermission, resourceAction);
281            }
282    
283            public static boolean hasResourcePermission(long companyId,
284                    java.lang.String name, int scope, java.lang.String primKey,
285                    long roleId, java.lang.String actionId)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    return getService()
289                                       .hasResourcePermission(companyId, name, scope, primKey,
290                            roleId, actionId);
291            }
292    
293            public static boolean hasScopeResourcePermission(long companyId,
294                    java.lang.String name, int scope, long roleId, java.lang.String actionId)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    return getService()
298                                       .hasScopeResourcePermission(companyId, name, scope, roleId,
299                            actionId);
300            }
301    
302            public static void mergePermissions(long fromRoleId, long toRoleId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService().mergePermissions(fromRoleId, toRoleId);
306            }
307    
308            public static void reassignPermissions(long resourcePermissionId,
309                    long toRoleId)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    getService().reassignPermissions(resourcePermissionId, toRoleId);
313            }
314    
315            public static void removeResourcePermission(long companyId,
316                    java.lang.String name, int scope, java.lang.String primKey,
317                    long roleId, java.lang.String actionId)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    getService()
321                            .removeResourcePermission(companyId, name, scope, primKey, roleId,
322                            actionId);
323            }
324    
325            public static void removeResourcePermissions(long companyId,
326                    java.lang.String name, int scope, long roleId, java.lang.String actionId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService()
330                            .removeResourcePermissions(companyId, name, scope, roleId, actionId);
331            }
332    
333            public static void setResourcePermissions(long companyId,
334                    java.lang.String name, int scope, java.lang.String primKey,
335                    long roleId, java.lang.String[] actionIds)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    getService()
339                            .setResourcePermissions(companyId, name, scope, primKey, roleId,
340                            actionIds);
341            }
342    
343            public static ResourcePermissionLocalService getService() {
344                    if (_service == null) {
345                            _service = (ResourcePermissionLocalService)PortalBeanLocatorUtil.locate(ResourcePermissionLocalService.class.getName());
346                    }
347    
348                    return _service;
349            }
350    
351            public void setService(ResourcePermissionLocalService service) {
352                    _service = service;
353            }
354    
355            private static ResourcePermissionLocalService _service;
356    }