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