001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.shopping.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * 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.
021     *
022     * <p>
023     * 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.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see ShoppingCategoryLocalService
032     * @see com.liferay.portlet.shopping.service.base.ShoppingCategoryLocalServiceBaseImpl
033     * @see com.liferay.portlet.shopping.service.impl.ShoppingCategoryLocalServiceImpl
034     * @generated
035     */
036    public class ShoppingCategoryLocalServiceUtil {
037            /**
038            * Adds the shopping category to the database. Also notifies the appropriate model listeners.
039            *
040            * @param shoppingCategory the shopping category to add
041            * @return the shopping category that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.shopping.model.ShoppingCategory addShoppingCategory(
045                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addShoppingCategory(shoppingCategory);
048            }
049    
050            /**
051            * Creates a new shopping category with the primary key. Does not add the shopping category to the database.
052            *
053            * @param categoryId the primary key for the new shopping category
054            * @return the new shopping category
055            */
056            public static com.liferay.portlet.shopping.model.ShoppingCategory createShoppingCategory(
057                    long categoryId) {
058                    return getService().createShoppingCategory(categoryId);
059            }
060    
061            /**
062            * Deletes the shopping category with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param categoryId the primary key of the shopping category to delete
065            * @throws PortalException if a shopping category with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteShoppingCategory(long categoryId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteShoppingCategory(categoryId);
072            }
073    
074            /**
075            * Deletes the shopping category from the database. Also notifies the appropriate model listeners.
076            *
077            * @param shoppingCategory the shopping category to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteShoppingCategory(
081                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteShoppingCategory(shoppingCategory);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the shopping category with the primary key.
159            *
160            * @param categoryId the primary key of the shopping category to get
161            * @return the shopping category
162            * @throws PortalException if a shopping category with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.shopping.model.ShoppingCategory getShoppingCategory(
166                    long categoryId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getShoppingCategory(categoryId);
170            }
171    
172            /**
173            * Gets a range of all the shopping categories.
174            *
175            * <p>
176            * 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.
177            * </p>
178            *
179            * @param start the lower bound of the range of shopping categories to return
180            * @param end the upper bound of the range of shopping categories to return (not inclusive)
181            * @return the range of shopping categories
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getShoppingCategories(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getShoppingCategories(start, end);
188            }
189    
190            /**
191            * Gets the number of shopping categories.
192            *
193            * @return the number of shopping categories
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getShoppingCategoriesCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getShoppingCategoriesCount();
199            }
200    
201            /**
202            * Updates the shopping category in the database. Also notifies the appropriate model listeners.
203            *
204            * @param shoppingCategory the shopping category to update
205            * @return the shopping category that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portlet.shopping.model.ShoppingCategory updateShoppingCategory(
209                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateShoppingCategory(shoppingCategory);
212            }
213    
214            /**
215            * Updates the shopping category in the database. Also notifies the appropriate model listeners.
216            *
217            * @param shoppingCategory the shopping category to update
218            * @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.
219            * @return the shopping category that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portlet.shopping.model.ShoppingCategory updateShoppingCategory(
223                    com.liferay.portlet.shopping.model.ShoppingCategory shoppingCategory,
224                    boolean merge)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().updateShoppingCategory(shoppingCategory, merge);
227            }
228    
229            public static com.liferay.portlet.shopping.model.ShoppingCategory addCategory(
230                    long userId, long parentCategoryId, java.lang.String name,
231                    java.lang.String description,
232                    com.liferay.portal.service.ServiceContext serviceContext)
233                    throws com.liferay.portal.kernel.exception.PortalException,
234                            com.liferay.portal.kernel.exception.SystemException {
235                    return getService()
236                                       .addCategory(userId, parentCategoryId, name, description,
237                            serviceContext);
238            }
239    
240            public static void addCategoryResources(long categoryId,
241                    boolean addCommunityPermissions, boolean addGuestPermissions)
242                    throws com.liferay.portal.kernel.exception.PortalException,
243                            com.liferay.portal.kernel.exception.SystemException {
244                    getService()
245                            .addCategoryResources(categoryId, addCommunityPermissions,
246                            addGuestPermissions);
247            }
248    
249            public static void addCategoryResources(long categoryId,
250                    java.lang.String[] communityPermissions,
251                    java.lang.String[] guestPermissions)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException {
254                    getService()
255                            .addCategoryResources(categoryId, communityPermissions,
256                            guestPermissions);
257            }
258    
259            public static void addCategoryResources(
260                    com.liferay.portlet.shopping.model.ShoppingCategory category,
261                    boolean addCommunityPermissions, boolean addGuestPermissions)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException {
264                    getService()
265                            .addCategoryResources(category, addCommunityPermissions,
266                            addGuestPermissions);
267            }
268    
269            public static void addCategoryResources(
270                    com.liferay.portlet.shopping.model.ShoppingCategory category,
271                    java.lang.String[] communityPermissions,
272                    java.lang.String[] guestPermissions)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException {
275                    getService()
276                            .addCategoryResources(category, communityPermissions,
277                            guestPermissions);
278            }
279    
280            public static void deleteCategories(long groupId)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    getService().deleteCategories(groupId);
284            }
285    
286            public static void deleteCategory(long categoryId)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService().deleteCategory(categoryId);
290            }
291    
292            public static void deleteCategory(
293                    com.liferay.portlet.shopping.model.ShoppingCategory category)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    getService().deleteCategory(category);
297            }
298    
299            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getCategories(
300                    long groupId)
301                    throws com.liferay.portal.kernel.exception.SystemException {
302                    return getService().getCategories(groupId);
303            }
304    
305            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getCategories(
306                    long groupId, long parentCategoryId, int start, int end)
307                    throws com.liferay.portal.kernel.exception.SystemException {
308                    return getService().getCategories(groupId, parentCategoryId, start, end);
309            }
310    
311            public static int getCategoriesCount(long groupId, long parentCategoryId)
312                    throws com.liferay.portal.kernel.exception.SystemException {
313                    return getService().getCategoriesCount(groupId, parentCategoryId);
314            }
315    
316            public static com.liferay.portlet.shopping.model.ShoppingCategory getCategory(
317                    long categoryId)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    return getService().getCategory(categoryId);
321            }
322    
323            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getParentCategories(
324                    long categoryId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    return getService().getParentCategories(categoryId);
328            }
329    
330            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingCategory> getParentCategories(
331                    com.liferay.portlet.shopping.model.ShoppingCategory category)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getParentCategories(category);
335            }
336    
337            public static com.liferay.portlet.shopping.model.ShoppingCategory getParentCategory(
338                    com.liferay.portlet.shopping.model.ShoppingCategory category)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException {
341                    return getService().getParentCategory(category);
342            }
343    
344            public static void getSubcategoryIds(
345                    java.util.List<java.lang.Long> categoryIds, long groupId,
346                    long categoryId)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    getService().getSubcategoryIds(categoryIds, groupId, categoryId);
349            }
350    
351            public static com.liferay.portlet.shopping.model.ShoppingCategory updateCategory(
352                    long categoryId, long parentCategoryId, java.lang.String name,
353                    java.lang.String description, boolean mergeWithParentCategory,
354                    com.liferay.portal.service.ServiceContext serviceContext)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException {
357                    return getService()
358                                       .updateCategory(categoryId, parentCategoryId, name,
359                            description, mergeWithParentCategory, serviceContext);
360            }
361    
362            public static ShoppingCategoryLocalService getService() {
363                    if (_service == null) {
364                            _service = (ShoppingCategoryLocalService)PortalBeanLocatorUtil.locate(ShoppingCategoryLocalService.class.getName());
365                    }
366    
367                    return _service;
368            }
369    
370            public void setService(ShoppingCategoryLocalService service) {
371                    _service = service;
372            }
373    
374            private static ShoppingCategoryLocalService _service;
375    }