001    /**
002     * Copyright (c) 2000-2011 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;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the resource local service. This utility wraps {@link com.liferay.portal.service.impl.ResourceLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see ResourceLocalService
030     * @see com.liferay.portal.service.base.ResourceLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.ResourceLocalServiceImpl
032     * @generated
033     */
034    public class ResourceLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.ResourceLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the resource to the database. Also notifies the appropriate model listeners.
043            *
044            * @param resource the resource
045            * @return the resource that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.Resource addResource(
049                    com.liferay.portal.model.Resource resource)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addResource(resource);
052            }
053    
054            /**
055            * Creates a new resource with the primary key. Does not add the resource to the database.
056            *
057            * @param resourceId the primary key for the new resource
058            * @return the new resource
059            */
060            public static com.liferay.portal.model.Resource createResource(
061                    long resourceId) {
062                    return getService().createResource(resourceId);
063            }
064    
065            /**
066            * Deletes the resource with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param resourceId the primary key of the resource
069            * @throws PortalException if a resource with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteResource(long resourceId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteResource(resourceId);
076            }
077    
078            /**
079            * Deletes the resource from the database. Also notifies the appropriate model listeners.
080            *
081            * @param resource the resource
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteResource(
085                    com.liferay.portal.model.Resource resource)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteResource(resource);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the resource with the primary key.
163            *
164            * @param resourceId the primary key of the resource
165            * @return the resource
166            * @throws PortalException if a resource with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portal.model.Resource getResource(long resourceId)
170                    throws com.liferay.portal.kernel.exception.PortalException,
171                            com.liferay.portal.kernel.exception.SystemException {
172                    return getService().getResource(resourceId);
173            }
174    
175            public static com.liferay.portal.model.PersistedModel getPersistedModel(
176                    java.io.Serializable primaryKeyObj)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getPersistedModel(primaryKeyObj);
180            }
181    
182            /**
183            * Returns a range of all the resources.
184            *
185            * <p>
186            * 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.
187            * </p>
188            *
189            * @param start the lower bound of the range of resources
190            * @param end the upper bound of the range of resources (not inclusive)
191            * @return the range of resources
192            * @throws SystemException if a system exception occurred
193            */
194            public static java.util.List<com.liferay.portal.model.Resource> getResources(
195                    int start, int end)
196                    throws com.liferay.portal.kernel.exception.SystemException {
197                    return getService().getResources(start, end);
198            }
199    
200            /**
201            * Returns the number of resources.
202            *
203            * @return the number of resources
204            * @throws SystemException if a system exception occurred
205            */
206            public static int getResourcesCount()
207                    throws com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getResourcesCount();
209            }
210    
211            /**
212            * Updates the resource in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
213            *
214            * @param resource the resource
215            * @return the resource that was updated
216            * @throws SystemException if a system exception occurred
217            */
218            public static com.liferay.portal.model.Resource updateResource(
219                    com.liferay.portal.model.Resource resource)
220                    throws com.liferay.portal.kernel.exception.SystemException {
221                    return getService().updateResource(resource);
222            }
223    
224            /**
225            * Updates the resource in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param resource the resource
228            * @param merge whether to merge the resource 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.
229            * @return the resource that was updated
230            * @throws SystemException if a system exception occurred
231            */
232            public static com.liferay.portal.model.Resource updateResource(
233                    com.liferay.portal.model.Resource resource, boolean merge)
234                    throws com.liferay.portal.kernel.exception.SystemException {
235                    return getService().updateResource(resource, merge);
236            }
237    
238            /**
239            * Returns the Spring bean ID for this bean.
240            *
241            * @return the Spring bean ID for this bean
242            */
243            public static java.lang.String getBeanIdentifier() {
244                    return getService().getBeanIdentifier();
245            }
246    
247            /**
248            * Sets the Spring bean ID for this bean.
249            *
250            * @param beanIdentifier the Spring bean ID for this bean
251            */
252            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
253                    getService().setBeanIdentifier(beanIdentifier);
254            }
255    
256            public static void addModelResources(
257                    com.liferay.portal.model.AuditedModel auditedModel,
258                    com.liferay.portal.service.ServiceContext serviceContext)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException {
261                    getService().addModelResources(auditedModel, serviceContext);
262            }
263    
264            public static void addModelResources(long companyId, long groupId,
265                    long userId, java.lang.String name, long primKey,
266                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException {
269                    getService()
270                            .addModelResources(companyId, groupId, userId, name, primKey,
271                            groupPermissions, guestPermissions);
272            }
273    
274            public static void addModelResources(long companyId, long groupId,
275                    long userId, java.lang.String name, java.lang.String primKey,
276                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    getService()
280                            .addModelResources(companyId, groupId, userId, name, primKey,
281                            groupPermissions, guestPermissions);
282            }
283    
284            public static com.liferay.portal.model.Resource addResource(
285                    long companyId, java.lang.String name, int scope,
286                    java.lang.String primKey)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    return getService().addResource(companyId, name, scope, primKey);
289            }
290    
291            public static void addResources(long companyId, long groupId, long userId,
292                    java.lang.String name, long primKey, boolean portletActions,
293                    boolean addGroupPermissions, boolean addGuestPermissions)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    getService()
297                            .addResources(companyId, groupId, userId, name, primKey,
298                            portletActions, addGroupPermissions, addGuestPermissions);
299            }
300    
301            public static void addResources(long companyId, long groupId, long userId,
302                    java.lang.String name, java.lang.String primKey,
303                    boolean portletActions, boolean addGroupPermissions,
304                    boolean addGuestPermissions)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException {
307                    getService()
308                            .addResources(companyId, groupId, userId, name, primKey,
309                            portletActions, addGroupPermissions, addGuestPermissions);
310            }
311    
312            public static void addResources(long companyId, long groupId,
313                    java.lang.String name, boolean portletActions)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    getService().addResources(companyId, groupId, name, portletActions);
317            }
318    
319            public static void deleteResource(
320                    com.liferay.portal.model.AuditedModel auditedModel, int scope)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService().deleteResource(auditedModel, scope);
324            }
325    
326            public static void deleteResource(long companyId, java.lang.String name,
327                    int scope, long primKey)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException {
330                    getService().deleteResource(companyId, name, scope, primKey);
331            }
332    
333            public static void deleteResource(long companyId, java.lang.String name,
334                    int scope, java.lang.String primKey)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException {
337                    getService().deleteResource(companyId, name, scope, primKey);
338            }
339    
340            public static void deleteResources(java.lang.String name)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    getService().deleteResources(name);
343            }
344    
345            public static com.liferay.portal.model.Resource fetchResource(
346                    long companyId, java.lang.String name, int scope,
347                    java.lang.String primKey)
348                    throws com.liferay.portal.kernel.exception.SystemException {
349                    return getService().fetchResource(companyId, name, scope, primKey);
350            }
351    
352            public static long getLatestResourceId()
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService().getLatestResourceId();
355            }
356    
357            public static com.liferay.portal.model.Resource getResource(
358                    long companyId, java.lang.String name, int scope,
359                    java.lang.String primKey)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException {
362                    return getService().getResource(companyId, name, scope, primKey);
363            }
364    
365            public static java.util.List<com.liferay.portal.model.Resource> getResources()
366                    throws com.liferay.portal.kernel.exception.SystemException {
367                    return getService().getResources();
368            }
369    
370            public static void updateModelResources(
371                    com.liferay.portal.model.AuditedModel auditedModel,
372                    com.liferay.portal.service.ServiceContext serviceContext)
373                    throws com.liferay.portal.kernel.exception.PortalException,
374                            com.liferay.portal.kernel.exception.SystemException {
375                    getService().updateModelResources(auditedModel, serviceContext);
376            }
377    
378            public static void updateResources(long companyId, long groupId,
379                    java.lang.String name, long primKey,
380                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
381                    throws com.liferay.portal.kernel.exception.PortalException,
382                            com.liferay.portal.kernel.exception.SystemException {
383                    getService()
384                            .updateResources(companyId, groupId, name, primKey,
385                            groupPermissions, guestPermissions);
386            }
387    
388            public static void updateResources(long companyId, long groupId,
389                    java.lang.String name, java.lang.String primKey,
390                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
391                    throws com.liferay.portal.kernel.exception.PortalException,
392                            com.liferay.portal.kernel.exception.SystemException {
393                    getService()
394                            .updateResources(companyId, groupId, name, primKey,
395                            groupPermissions, guestPermissions);
396            }
397    
398            public static void updateResources(long companyId, java.lang.String name,
399                    int scope, java.lang.String primKey, java.lang.String newPrimKey)
400                    throws com.liferay.portal.kernel.exception.PortalException,
401                            com.liferay.portal.kernel.exception.SystemException {
402                    getService().updateResources(companyId, name, scope, primKey, newPrimKey);
403            }
404    
405            public static ResourceLocalService getService() {
406                    if (_service == null) {
407                            _service = (ResourceLocalService)PortalBeanLocatorUtil.locate(ResourceLocalService.class.getName());
408    
409                            ReferenceRegistry.registerReference(ResourceLocalServiceUtil.class,
410                                    "_service");
411                            MethodCache.remove(ResourceLocalService.class);
412                    }
413    
414                    return _service;
415            }
416    
417            public void setService(ResourceLocalService service) {
418                    MethodCache.remove(ResourceLocalService.class);
419    
420                    _service = service;
421    
422                    ReferenceRegistry.registerReference(ResourceLocalServiceUtil.class,
423                            "_service");
424                    MethodCache.remove(ResourceLocalService.class);
425            }
426    
427            private static ResourceLocalService _service;
428    }