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     * Provides the local service utility for ShoppingCategory. This utility wraps
022     * {@link com.liferay.portlet.shopping.service.impl.ShoppingCategoryLocalServiceImpl} and is the
023     * primary access point for service operations in application layer code running
024     * on the local server. Methods of this service will not have security checks
025     * based on the propagated JAAS credentials because this service can only be
026     * accessed from within the same VM.
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            * @return the shopping category that was removed
070            * @throws PortalException if a shopping category with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public static com.liferay.portlet.shopping.model.ShoppingCategory deleteShoppingCategory(
074                    long categoryId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException {
077                    return getService().deleteShoppingCategory(categoryId);
078            }
079    
080            /**
081            * Deletes the shopping category from the database. Also notifies the appropriate model listeners.
082            *
083            * @param shoppingCategory the shopping category
084            * @return the shopping category that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public static com.liferay.portlet.shopping.model.ShoppingCategory deleteShoppingCategory(
088                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory)
089                    throws com.liferay.portal.kernel.exception.SystemException {
090                    return getService().deleteShoppingCategory(shoppingCategory);
091            }
092    
093            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
094                    return getService().dynamicQuery();
095            }
096    
097            /**
098            * Performs a dynamic query on the database and returns the matching rows.
099            *
100            * @param dynamicQuery the dynamic query
101            * @return the matching rows
102            * @throws SystemException if a system exception occurred
103            */
104            @SuppressWarnings("rawtypes")
105            public static java.util.List dynamicQuery(
106                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
107                    throws com.liferay.portal.kernel.exception.SystemException {
108                    return getService().dynamicQuery(dynamicQuery);
109            }
110    
111            /**
112            * Performs a dynamic query on the database and returns a range of the matching rows.
113            *
114            * <p>
115            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.shopping.model.impl.ShoppingCategoryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
116            * </p>
117            *
118            * @param dynamicQuery the dynamic query
119            * @param start the lower bound of the range of model instances
120            * @param end the upper bound of the range of model instances (not inclusive)
121            * @return the range of matching rows
122            * @throws SystemException if a system exception occurred
123            */
124            @SuppressWarnings("rawtypes")
125            public static java.util.List dynamicQuery(
126                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
127                    int end) throws com.liferay.portal.kernel.exception.SystemException {
128                    return getService().dynamicQuery(dynamicQuery, start, end);
129            }
130    
131            /**
132            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
133            *
134            * <p>
135            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.shopping.model.impl.ShoppingCategoryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
136            * </p>
137            *
138            * @param dynamicQuery the dynamic query
139            * @param start the lower bound of the range of model instances
140            * @param end the upper bound of the range of model instances (not inclusive)
141            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
142            * @return the ordered range of matching rows
143            * @throws SystemException if a system exception occurred
144            */
145            @SuppressWarnings("rawtypes")
146            public static java.util.List dynamicQuery(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
148                    int end,
149                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
150                    throws com.liferay.portal.kernel.exception.SystemException {
151                    return getService()
152                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
153            }
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @return the number of rows that match the dynamic query
160            * @throws SystemException if a system exception occurred
161            */
162            public static long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
164                    throws com.liferay.portal.kernel.exception.SystemException {
165                    return getService().dynamicQueryCount(dynamicQuery);
166            }
167    
168            /**
169            * Returns the number of rows that match the dynamic query.
170            *
171            * @param dynamicQuery the dynamic query
172            * @param projection the projection to apply to the query
173            * @return the number of rows that match the dynamic query
174            * @throws SystemException if a system exception occurred
175            */
176            public static long dynamicQueryCount(
177                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
178                    com.liferay.portal.kernel.dao.orm.Projection projection)
179                    throws com.liferay.portal.kernel.exception.SystemException {
180                    return getService().dynamicQueryCount(dynamicQuery, projection);
181            }
182    
183            public static com.liferay.portlet.shopping.model.ShoppingCategory fetchShoppingCategory(
184                    long categoryId)
185                    throws com.liferay.portal.kernel.exception.SystemException {
186                    return getService().fetchShoppingCategory(categoryId);
187            }
188    
189            /**
190            * Returns the shopping category with the primary key.
191            *
192            * @param categoryId the primary key of the shopping category
193            * @return the shopping category
194            * @throws PortalException if a shopping category with the primary key could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public static com.liferay.portlet.shopping.model.ShoppingCategory getShoppingCategory(
198                    long categoryId)
199                    throws com.liferay.portal.kernel.exception.PortalException,
200                            com.liferay.portal.kernel.exception.SystemException {
201                    return getService().getShoppingCategory(categoryId);
202            }
203    
204            public static com.liferay.portal.model.PersistedModel getPersistedModel(
205                    java.io.Serializable primaryKeyObj)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getPersistedModel(primaryKeyObj);
209            }
210    
211            /**
212            * Returns a range of all the shopping categories.
213            *
214            * <p>
215            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.shopping.model.impl.ShoppingCategoryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
216            * </p>
217            *
218            * @param start the lower bound of the range of shopping categories
219            * @param end the upper bound of the range of shopping categories (not inclusive)
220            * @return the range of shopping categories
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getShoppingCategories(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getShoppingCategories(start, end);
227            }
228    
229            /**
230            * Returns the number of shopping categories.
231            *
232            * @return the number of shopping categories
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getShoppingCategoriesCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getShoppingCategoriesCount();
238            }
239    
240            /**
241            * Updates the shopping category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param shoppingCategory the shopping category
244            * @return the shopping category that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.shopping.model.ShoppingCategory updateShoppingCategory(
248                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateShoppingCategory(shoppingCategory);
251            }
252    
253            /**
254            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portlet.shopping.model.ShoppingCategory addCategory(
272                    long userId, long parentCategoryId, java.lang.String name,
273                    java.lang.String description,
274                    com.liferay.portal.service.ServiceContext serviceContext)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService()
278                                       .addCategory(userId, parentCategoryId, name, description,
279                            serviceContext);
280            }
281    
282            public static void addCategoryResources(long categoryId,
283                    boolean addGroupPermissions, boolean addGuestPermissions)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    getService()
287                            .addCategoryResources(categoryId, addGroupPermissions,
288                            addGuestPermissions);
289            }
290    
291            public static void addCategoryResources(long categoryId,
292                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    getService()
296                            .addCategoryResources(categoryId, groupPermissions, guestPermissions);
297            }
298    
299            public static void addCategoryResources(
300                    com.liferay.portlet.shopping.model.ShoppingCategory category,
301                    boolean addGroupPermissions, boolean addGuestPermissions)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    getService()
305                            .addCategoryResources(category, addGroupPermissions,
306                            addGuestPermissions);
307            }
308    
309            public static void addCategoryResources(
310                    com.liferay.portlet.shopping.model.ShoppingCategory category,
311                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService()
315                            .addCategoryResources(category, groupPermissions, guestPermissions);
316            }
317    
318            public static void deleteCategories(long groupId)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    getService().deleteCategories(groupId);
322            }
323    
324            public static void deleteCategory(long categoryId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteCategory(categoryId);
328            }
329    
330            public static void deleteCategory(
331                    com.liferay.portlet.shopping.model.ShoppingCategory category)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    getService().deleteCategory(category);
335            }
336    
337            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getCategories(
338                    long groupId)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getCategories(groupId);
341            }
342    
343            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getCategories(
344                    long groupId, long parentCategoryId, int start, int end)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService().getCategories(groupId, parentCategoryId, start, end);
347            }
348    
349            public static int getCategoriesCount(long groupId, long parentCategoryId)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().getCategoriesCount(groupId, parentCategoryId);
352            }
353    
354            public static com.liferay.portlet.shopping.model.ShoppingCategory getCategory(
355                    long categoryId)
356                    throws com.liferay.portal.kernel.exception.PortalException,
357                            com.liferay.portal.kernel.exception.SystemException {
358                    return getService().getCategory(categoryId);
359            }
360    
361            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getParentCategories(
362                    long categoryId)
363                    throws com.liferay.portal.kernel.exception.PortalException,
364                            com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getParentCategories(categoryId);
366            }
367    
368            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getParentCategories(
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().getParentCategories(category);
373            }
374    
375            public static com.liferay.portlet.shopping.model.ShoppingCategory getParentCategory(
376                    com.liferay.portlet.shopping.model.ShoppingCategory category)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException {
379                    return getService().getParentCategory(category);
380            }
381    
382            public static void getSubcategoryIds(
383                    java.util.List<java.lang.Long> categoryIds, long groupId,
384                    long categoryId)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    getService().getSubcategoryIds(categoryIds, groupId, categoryId);
387            }
388    
389            public static com.liferay.portlet.shopping.model.ShoppingCategory updateCategory(
390                    long categoryId, long parentCategoryId, java.lang.String name,
391                    java.lang.String description, boolean mergeWithParentCategory,
392                    com.liferay.portal.service.ServiceContext serviceContext)
393                    throws com.liferay.portal.kernel.exception.PortalException,
394                            com.liferay.portal.kernel.exception.SystemException {
395                    return getService()
396                                       .updateCategory(categoryId, parentCategoryId, name,
397                            description, mergeWithParentCategory, serviceContext);
398            }
399    
400            public static ShoppingCategoryLocalService getService() {
401                    if (_service == null) {
402                            _service = (ShoppingCategoryLocalService)PortalBeanLocatorUtil.locate(ShoppingCategoryLocalService.class.getName());
403    
404                            ReferenceRegistry.registerReference(ShoppingCategoryLocalServiceUtil.class,
405                                    "_service");
406                    }
407    
408                    return _service;
409            }
410    
411            /**
412             * @deprecated As of 6.2.0
413             */
414            public void setService(ShoppingCategoryLocalService service) {
415            }
416    
417            private static ShoppingCategoryLocalService _service;
418    }