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