001    /**
002     * Copyright (c) 2000-2012 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            public static com.liferay.portal.model.Resource fetchResource(
162                    long resourceId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchResource(resourceId);
165            }
166    
167            /**
168            * Returns the resource with the primary key.
169            *
170            * @param resourceId the primary key of the resource
171            * @return the resource
172            * @throws PortalException if a resource with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portal.model.Resource getResource(long resourceId)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException {
178                    return getService().getResource(resourceId);
179            }
180    
181            public static com.liferay.portal.model.PersistedModel getPersistedModel(
182                    java.io.Serializable primaryKeyObj)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getPersistedModel(primaryKeyObj);
186            }
187    
188            /**
189            * Returns a range of all the resources.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of resources
196            * @param end the upper bound of the range of resources (not inclusive)
197            * @return the range of resources
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portal.model.Resource> getResources(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getResources(start, end);
204            }
205    
206            /**
207            * Returns the number of resources.
208            *
209            * @return the number of resources
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getResourcesCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getResourcesCount();
215            }
216    
217            /**
218            * Updates the resource in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
219            *
220            * @param resource the resource
221            * @return the resource that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portal.model.Resource updateResource(
225                    com.liferay.portal.model.Resource resource)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateResource(resource);
228            }
229    
230            /**
231            * Updates the resource in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
232            *
233            * @param resource the resource
234            * @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.
235            * @return the resource that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portal.model.Resource updateResource(
239                    com.liferay.portal.model.Resource resource, boolean merge)
240                    throws com.liferay.portal.kernel.exception.SystemException {
241                    return getService().updateResource(resource, merge);
242            }
243    
244            /**
245            * Returns the Spring bean ID for this bean.
246            *
247            * @return the Spring bean ID for this bean
248            */
249            public static java.lang.String getBeanIdentifier() {
250                    return getService().getBeanIdentifier();
251            }
252    
253            /**
254            * Sets the Spring bean ID for this bean.
255            *
256            * @param beanIdentifier the Spring bean ID for this bean
257            */
258            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
259                    getService().setBeanIdentifier(beanIdentifier);
260            }
261    
262            public static void addModelResources(
263                    com.liferay.portal.model.AuditedModel auditedModel,
264                    com.liferay.portal.service.ServiceContext serviceContext)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    getService().addModelResources(auditedModel, serviceContext);
268            }
269    
270            public static void addModelResources(long companyId, long groupId,
271                    long userId, java.lang.String name, long primKey,
272                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException {
275                    getService()
276                            .addModelResources(companyId, groupId, userId, name, primKey,
277                            groupPermissions, guestPermissions);
278            }
279    
280            public static void addModelResources(long companyId, long groupId,
281                    long userId, java.lang.String name, java.lang.String primKey,
282                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    getService()
286                            .addModelResources(companyId, groupId, userId, name, primKey,
287                            groupPermissions, guestPermissions);
288            }
289    
290            public static com.liferay.portal.model.Resource addResource(
291                    long companyId, java.lang.String name, int scope,
292                    java.lang.String primKey)
293                    throws com.liferay.portal.kernel.exception.SystemException {
294                    return getService().addResource(companyId, name, scope, primKey);
295            }
296    
297            public static void addResources(long companyId, long groupId, long userId,
298                    java.lang.String name, long primKey, boolean portletActions,
299                    boolean addGroupPermissions, boolean addGuestPermissions)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    getService()
303                            .addResources(companyId, groupId, userId, name, primKey,
304                            portletActions, addGroupPermissions, addGuestPermissions);
305            }
306    
307            public static void addResources(long companyId, long groupId, long userId,
308                    java.lang.String name, java.lang.String primKey,
309                    boolean portletActions, boolean addGroupPermissions,
310                    boolean addGuestPermissions)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException {
313                    getService()
314                            .addResources(companyId, groupId, userId, name, primKey,
315                            portletActions, addGroupPermissions, addGuestPermissions);
316            }
317    
318            public static void addResources(long companyId, long groupId,
319                    java.lang.String name, boolean portletActions)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException {
322                    getService().addResources(companyId, groupId, name, portletActions);
323            }
324    
325            public static void deleteResource(
326                    com.liferay.portal.model.AuditedModel auditedModel, int scope)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService().deleteResource(auditedModel, scope);
330            }
331    
332            public static void deleteResource(long companyId, java.lang.String name,
333                    int scope, long primKey)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException {
336                    getService().deleteResource(companyId, name, scope, primKey);
337            }
338    
339            public static void deleteResource(long companyId, java.lang.String name,
340                    int scope, java.lang.String primKey)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException {
343                    getService().deleteResource(companyId, name, scope, primKey);
344            }
345    
346            public static void deleteResources(java.lang.String name)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    getService().deleteResources(name);
349            }
350    
351            public static com.liferay.portal.model.Resource fetchResource(
352                    long companyId, java.lang.String name, int scope,
353                    java.lang.String primKey)
354                    throws com.liferay.portal.kernel.exception.SystemException {
355                    return getService().fetchResource(companyId, name, scope, primKey);
356            }
357    
358            public static long getLatestResourceId()
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService().getLatestResourceId();
361            }
362    
363            public static com.liferay.portal.model.Resource getResource(
364                    long companyId, java.lang.String name, int scope,
365                    java.lang.String primKey)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getResource(companyId, name, scope, primKey);
369            }
370    
371            public static java.util.List<com.liferay.portal.model.Resource> getResources()
372                    throws com.liferay.portal.kernel.exception.SystemException {
373                    return getService().getResources();
374            }
375    
376            public static void updateModelResources(
377                    com.liferay.portal.model.AuditedModel auditedModel,
378                    com.liferay.portal.service.ServiceContext serviceContext)
379                    throws com.liferay.portal.kernel.exception.PortalException,
380                            com.liferay.portal.kernel.exception.SystemException {
381                    getService().updateModelResources(auditedModel, serviceContext);
382            }
383    
384            public static void updateResources(long companyId, long groupId,
385                    java.lang.String name, long primKey,
386                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
387                    throws com.liferay.portal.kernel.exception.PortalException,
388                            com.liferay.portal.kernel.exception.SystemException {
389                    getService()
390                            .updateResources(companyId, groupId, name, primKey,
391                            groupPermissions, guestPermissions);
392            }
393    
394            public static void updateResources(long companyId, long groupId,
395                    java.lang.String name, java.lang.String primKey,
396                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException {
399                    getService()
400                            .updateResources(companyId, groupId, name, primKey,
401                            groupPermissions, guestPermissions);
402            }
403    
404            public static void updateResources(long companyId, java.lang.String name,
405                    int scope, java.lang.String primKey, java.lang.String newPrimKey)
406                    throws com.liferay.portal.kernel.exception.PortalException,
407                            com.liferay.portal.kernel.exception.SystemException {
408                    getService().updateResources(companyId, name, scope, primKey, newPrimKey);
409            }
410    
411            public static ResourceLocalService getService() {
412                    if (_service == null) {
413                            _service = (ResourceLocalService)PortalBeanLocatorUtil.locate(ResourceLocalService.class.getName());
414    
415                            ReferenceRegistry.registerReference(ResourceLocalServiceUtil.class,
416                                    "_service");
417                            MethodCache.remove(ResourceLocalService.class);
418                    }
419    
420                    return _service;
421            }
422    
423            public void setService(ResourceLocalService service) {
424                    MethodCache.remove(ResourceLocalService.class);
425    
426                    _service = service;
427    
428                    ReferenceRegistry.registerReference(ResourceLocalServiceUtil.class,
429                            "_service");
430                    MethodCache.remove(ResourceLocalService.class);
431            }
432    
433            private static ResourceLocalService _service;
434    }