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