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.portlet.shopping.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 shopping category local service. This utility wraps {@link com.liferay.portlet.shopping.service.impl.ShoppingCategoryLocalServiceImpl} 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 ShoppingCategoryLocalService
030     * @see com.liferay.portlet.shopping.service.base.ShoppingCategoryLocalServiceBaseImpl
031     * @see com.liferay.portlet.shopping.service.impl.ShoppingCategoryLocalServiceImpl
032     * @generated
033     */
034    public class ShoppingCategoryLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.shopping.service.impl.ShoppingCategoryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the shopping category to the database. Also notifies the appropriate model listeners.
043            *
044            * @param shoppingCategory the shopping category
045            * @return the shopping category that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.shopping.model.ShoppingCategory addShoppingCategory(
049                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addShoppingCategory(shoppingCategory);
052            }
053    
054            /**
055            * Creates a new shopping category with the primary key. Does not add the shopping category to the database.
056            *
057            * @param categoryId the primary key for the new shopping category
058            * @return the new shopping category
059            */
060            public static com.liferay.portlet.shopping.model.ShoppingCategory createShoppingCategory(
061                    long categoryId) {
062                    return getService().createShoppingCategory(categoryId);
063            }
064    
065            /**
066            * Deletes the shopping category with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param categoryId the primary key of the shopping category
069            * @throws PortalException if a shopping category with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteShoppingCategory(long categoryId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteShoppingCategory(categoryId);
076            }
077    
078            /**
079            * Deletes the shopping category from the database. Also notifies the appropriate model listeners.
080            *
081            * @param shoppingCategory the shopping category
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteShoppingCategory(
085                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteShoppingCategory(shoppingCategory);
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 shopping category with the primary key.
163            *
164            * @param categoryId the primary key of the shopping category
165            * @return the shopping category
166            * @throws PortalException if a shopping category with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.shopping.model.ShoppingCategory getShoppingCategory(
170                    long categoryId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getShoppingCategory(categoryId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the shopping categories.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of shopping categories
191            * @param end the upper bound of the range of shopping categories (not inclusive)
192            * @return the range of shopping categories
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getShoppingCategories(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getShoppingCategories(start, end);
199            }
200    
201            /**
202            * Returns the number of shopping categories.
203            *
204            * @return the number of shopping categories
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getShoppingCategoriesCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getShoppingCategoriesCount();
210            }
211    
212            /**
213            * Updates the shopping category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param shoppingCategory the shopping category
216            * @return the shopping category that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.shopping.model.ShoppingCategory updateShoppingCategory(
220                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateShoppingCategory(shoppingCategory);
223            }
224    
225            /**
226            * Updates the shopping category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param shoppingCategory the shopping category
229            * @param merge whether to merge the shopping category 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.
230            * @return the shopping category that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portlet.shopping.model.ShoppingCategory updateShoppingCategory(
234                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().updateShoppingCategory(shoppingCategory, merge);
238            }
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public static java.lang.String getBeanIdentifier() {
246                    return getService().getBeanIdentifier();
247            }
248    
249            /**
250            * Sets the Spring bean ID for this bean.
251            *
252            * @param beanIdentifier the Spring bean ID for this bean
253            */
254            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
255                    getService().setBeanIdentifier(beanIdentifier);
256            }
257    
258            public static com.liferay.portlet.shopping.model.ShoppingCategory addCategory(
259                    long userId, long parentCategoryId, java.lang.String name,
260                    java.lang.String description,
261                    com.liferay.portal.service.ServiceContext serviceContext)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException {
264                    return getService()
265                                       .addCategory(userId, parentCategoryId, name, description,
266                            serviceContext);
267            }
268    
269            public static void addCategoryResources(long categoryId,
270                    boolean addGroupPermissions, boolean addGuestPermissions)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    getService()
274                            .addCategoryResources(categoryId, addGroupPermissions,
275                            addGuestPermissions);
276            }
277    
278            public static void addCategoryResources(long categoryId,
279                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    getService()
283                            .addCategoryResources(categoryId, groupPermissions, guestPermissions);
284            }
285    
286            public static void addCategoryResources(
287                    com.liferay.portlet.shopping.model.ShoppingCategory category,
288                    boolean addGroupPermissions, boolean addGuestPermissions)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    getService()
292                            .addCategoryResources(category, addGroupPermissions,
293                            addGuestPermissions);
294            }
295    
296            public static void addCategoryResources(
297                    com.liferay.portlet.shopping.model.ShoppingCategory category,
298                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService()
302                            .addCategoryResources(category, groupPermissions, guestPermissions);
303            }
304    
305            public static void deleteCategories(long groupId)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    getService().deleteCategories(groupId);
309            }
310    
311            public static void deleteCategory(long categoryId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService().deleteCategory(categoryId);
315            }
316    
317            public static void deleteCategory(
318                    com.liferay.portlet.shopping.model.ShoppingCategory category)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    getService().deleteCategory(category);
322            }
323    
324            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getCategories(
325                    long groupId)
326                    throws com.liferay.portal.kernel.exception.SystemException {
327                    return getService().getCategories(groupId);
328            }
329    
330            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getCategories(
331                    long groupId, long parentCategoryId, int start, int end)
332                    throws com.liferay.portal.kernel.exception.SystemException {
333                    return getService().getCategories(groupId, parentCategoryId, start, end);
334            }
335    
336            public static int getCategoriesCount(long groupId, long parentCategoryId)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService().getCategoriesCount(groupId, parentCategoryId);
339            }
340    
341            public static com.liferay.portlet.shopping.model.ShoppingCategory getCategory(
342                    long categoryId)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getCategory(categoryId);
346            }
347    
348            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getParentCategories(
349                    long categoryId)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    return getService().getParentCategories(categoryId);
353            }
354    
355            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getParentCategories(
356                    com.liferay.portlet.shopping.model.ShoppingCategory category)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getParentCategories(category);
360            }
361    
362            public static com.liferay.portlet.shopping.model.ShoppingCategory getParentCategory(
363                    com.liferay.portlet.shopping.model.ShoppingCategory category)
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getParentCategory(category);
367            }
368    
369            public static void getSubcategoryIds(
370                    java.util.List<java.lang.Long> categoryIds, long groupId,
371                    long categoryId)
372                    throws com.liferay.portal.kernel.exception.SystemException {
373                    getService().getSubcategoryIds(categoryIds, groupId, categoryId);
374            }
375    
376            public static com.liferay.portlet.shopping.model.ShoppingCategory updateCategory(
377                    long categoryId, long parentCategoryId, java.lang.String name,
378                    java.lang.String description, boolean mergeWithParentCategory,
379                    com.liferay.portal.service.ServiceContext serviceContext)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException {
382                    return getService()
383                                       .updateCategory(categoryId, parentCategoryId, name,
384                            description, mergeWithParentCategory, serviceContext);
385            }
386    
387            public static ShoppingCategoryLocalService getService() {
388                    if (_service == null) {
389                            _service = (ShoppingCategoryLocalService)PortalBeanLocatorUtil.locate(ShoppingCategoryLocalService.class.getName());
390    
391                            ReferenceRegistry.registerReference(ShoppingCategoryLocalServiceUtil.class,
392                                    "_service");
393                            MethodCache.remove(ShoppingCategoryLocalService.class);
394                    }
395    
396                    return _service;
397            }
398    
399            public void setService(ShoppingCategoryLocalService service) {
400                    MethodCache.remove(ShoppingCategoryLocalService.class);
401    
402                    _service = service;
403    
404                    ReferenceRegistry.registerReference(ShoppingCategoryLocalServiceUtil.class,
405                            "_service");
406                    MethodCache.remove(ShoppingCategoryLocalService.class);
407            }
408    
409            private static ShoppingCategoryLocalService _service;
410    }