001    /**
002     * Copyright (c) 2000-2010 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    
019    /**
020     * The utility for the shopping item local service. This utility wraps {@link com.liferay.portlet.shopping.service.impl.ShoppingItemLocalServiceImpl} 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.ShoppingItemLocalServiceImpl} 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 ShoppingItemLocalService
032     * @see com.liferay.portlet.shopping.service.base.ShoppingItemLocalServiceBaseImpl
033     * @see com.liferay.portlet.shopping.service.impl.ShoppingItemLocalServiceImpl
034     * @generated
035     */
036    public class ShoppingItemLocalServiceUtil {
037            /**
038            * Adds the shopping item to the database. Also notifies the appropriate model listeners.
039            *
040            * @param shoppingItem the shopping item to add
041            * @return the shopping item that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.shopping.model.ShoppingItem addShoppingItem(
045                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addShoppingItem(shoppingItem);
048            }
049    
050            /**
051            * Creates a new shopping item with the primary key. Does not add the shopping item to the database.
052            *
053            * @param itemId the primary key for the new shopping item
054            * @return the new shopping item
055            */
056            public static com.liferay.portlet.shopping.model.ShoppingItem createShoppingItem(
057                    long itemId) {
058                    return getService().createShoppingItem(itemId);
059            }
060    
061            /**
062            * Deletes the shopping item with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param itemId the primary key of the shopping item to delete
065            * @throws PortalException if a shopping item with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteShoppingItem(long itemId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteShoppingItem(itemId);
072            }
073    
074            /**
075            * Deletes the shopping item from the database. Also notifies the appropriate model listeners.
076            *
077            * @param shoppingItem the shopping item to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteShoppingItem(
081                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteShoppingItem(shoppingItem);
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 item with the primary key.
159            *
160            * @param itemId the primary key of the shopping item to get
161            * @return the shopping item
162            * @throws PortalException if a shopping item 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.ShoppingItem getShoppingItem(
166                    long itemId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getShoppingItem(itemId);
170            }
171    
172            /**
173            * Gets a range of all the shopping items.
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 items to return
180            * @param end the upper bound of the range of shopping items to return (not inclusive)
181            * @return the range of shopping items
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getShoppingItems(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getShoppingItems(start, end);
188            }
189    
190            /**
191            * Gets the number of shopping items.
192            *
193            * @return the number of shopping items
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getShoppingItemsCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getShoppingItemsCount();
199            }
200    
201            /**
202            * Updates the shopping item in the database. Also notifies the appropriate model listeners.
203            *
204            * @param shoppingItem the shopping item to update
205            * @return the shopping item that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portlet.shopping.model.ShoppingItem updateShoppingItem(
209                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updateShoppingItem(shoppingItem);
212            }
213    
214            /**
215            * Updates the shopping item in the database. Also notifies the appropriate model listeners.
216            *
217            * @param shoppingItem the shopping item to update
218            * @param merge whether to merge the shopping item 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 item that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portlet.shopping.model.ShoppingItem updateShoppingItem(
223                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem,
224                    boolean merge)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().updateShoppingItem(shoppingItem, merge);
227            }
228    
229            public static void addBookItems(long userId, long groupId, long categoryId,
230                    java.lang.String[] isbns)
231                    throws com.liferay.portal.kernel.exception.PortalException,
232                            com.liferay.portal.kernel.exception.SystemException {
233                    getService().addBookItems(userId, groupId, categoryId, isbns);
234            }
235    
236            public static com.liferay.portlet.shopping.model.ShoppingItem addItem(
237                    long userId, long groupId, long categoryId, java.lang.String sku,
238                    java.lang.String name, java.lang.String description,
239                    java.lang.String properties, java.lang.String fieldsQuantities,
240                    boolean requiresShipping, int stockQuantity, boolean featured,
241                    java.lang.Boolean sale, boolean smallImage,
242                    java.lang.String smallImageURL, java.io.File smallFile,
243                    boolean mediumImage, java.lang.String mediumImageURL,
244                    java.io.File mediumFile, boolean largeImage,
245                    java.lang.String largeImageURL, java.io.File largeFile,
246                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
247                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
248                    com.liferay.portal.service.ServiceContext serviceContext)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException {
251                    return getService()
252                                       .addItem(userId, groupId, categoryId, sku, name,
253                            description, properties, fieldsQuantities, requiresShipping,
254                            stockQuantity, featured, sale, smallImage, smallImageURL,
255                            smallFile, mediumImage, mediumImageURL, mediumFile, largeImage,
256                            largeImageURL, largeFile, itemFields, itemPrices, serviceContext);
257            }
258    
259            public static void addItemResources(long itemId,
260                    boolean addCommunityPermissions, boolean addGuestPermissions)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException {
263                    getService()
264                            .addItemResources(itemId, addCommunityPermissions,
265                            addGuestPermissions);
266            }
267    
268            public static void addItemResources(long itemId,
269                    java.lang.String[] communityPermissions,
270                    java.lang.String[] guestPermissions)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    getService()
274                            .addItemResources(itemId, communityPermissions, guestPermissions);
275            }
276    
277            public static void addItemResources(
278                    com.liferay.portlet.shopping.model.ShoppingItem item,
279                    boolean addCommunityPermissions, boolean addGuestPermissions)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    getService()
283                            .addItemResources(item, addCommunityPermissions, addGuestPermissions);
284            }
285    
286            public static void addItemResources(
287                    com.liferay.portlet.shopping.model.ShoppingItem item,
288                    java.lang.String[] communityPermissions,
289                    java.lang.String[] guestPermissions)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService()
293                            .addItemResources(item, communityPermissions, guestPermissions);
294            }
295    
296            public static void deleteItem(long itemId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService().deleteItem(itemId);
300            }
301    
302            public static void deleteItem(
303                    com.liferay.portlet.shopping.model.ShoppingItem item)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    getService().deleteItem(item);
307            }
308    
309            public static void deleteItems(long groupId, long categoryId)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    getService().deleteItems(groupId, categoryId);
313            }
314    
315            public static int getCategoriesItemsCount(long groupId,
316                    java.util.List<java.lang.Long> categoryIds)
317                    throws com.liferay.portal.kernel.exception.SystemException {
318                    return getService().getCategoriesItemsCount(groupId, categoryIds);
319            }
320    
321            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getFeaturedItems(
322                    long groupId, long categoryId, int numOfItems)
323                    throws com.liferay.portal.kernel.exception.SystemException {
324                    return getService().getFeaturedItems(groupId, categoryId, numOfItems);
325            }
326    
327            public static com.liferay.portlet.shopping.model.ShoppingItem getItem(
328                    long itemId)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException {
331                    return getService().getItem(itemId);
332            }
333    
334            public static com.liferay.portlet.shopping.model.ShoppingItem getItem(
335                    long companyId, java.lang.String sku)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    return getService().getItem(companyId, sku);
339            }
340    
341            public static com.liferay.portlet.shopping.model.ShoppingItem getItemByLargeImageId(
342                    long largeImageId)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getItemByLargeImageId(largeImageId);
346            }
347    
348            public static com.liferay.portlet.shopping.model.ShoppingItem getItemByMediumImageId(
349                    long mediumImageId)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    return getService().getItemByMediumImageId(mediumImageId);
353            }
354    
355            public static com.liferay.portlet.shopping.model.ShoppingItem getItemBySmallImageId(
356                    long smallImageId)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getItemBySmallImageId(smallImageId);
360            }
361    
362            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
363                    long groupId, long categoryId)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getItems(groupId, categoryId);
366            }
367    
368            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
369                    long groupId, long categoryId, int start, int end,
370                    com.liferay.portal.kernel.util.OrderByComparator obc)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService().getItems(groupId, categoryId, start, end, obc);
373            }
374    
375            public static int getItemsCount(long groupId, long categoryId)
376                    throws com.liferay.portal.kernel.exception.SystemException {
377                    return getService().getItemsCount(groupId, categoryId);
378            }
379    
380            public static com.liferay.portlet.shopping.model.ShoppingItem[] getItemsPrevAndNext(
381                    long itemId, com.liferay.portal.kernel.util.OrderByComparator obc)
382                    throws com.liferay.portal.kernel.exception.PortalException,
383                            com.liferay.portal.kernel.exception.SystemException {
384                    return getService().getItemsPrevAndNext(itemId, obc);
385            }
386    
387            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getSaleItems(
388                    long groupId, long categoryId, int numOfItems)
389                    throws com.liferay.portal.kernel.exception.SystemException {
390                    return getService().getSaleItems(groupId, categoryId, numOfItems);
391            }
392    
393            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> search(
394                    long groupId, long[] categoryIds, java.lang.String keywords, int start,
395                    int end) throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().search(groupId, categoryIds, keywords, start, end);
397            }
398    
399            public static int searchCount(long groupId, long[] categoryIds,
400                    java.lang.String keywords)
401                    throws com.liferay.portal.kernel.exception.SystemException {
402                    return getService().searchCount(groupId, categoryIds, keywords);
403            }
404    
405            public static com.liferay.portlet.shopping.model.ShoppingItem updateItem(
406                    long userId, long itemId, long groupId, long categoryId,
407                    java.lang.String sku, java.lang.String name,
408                    java.lang.String description, java.lang.String properties,
409                    java.lang.String fieldsQuantities, boolean requiresShipping,
410                    int stockQuantity, boolean featured, java.lang.Boolean sale,
411                    boolean smallImage, java.lang.String smallImageURL,
412                    java.io.File smallFile, boolean mediumImage,
413                    java.lang.String mediumImageURL, java.io.File mediumFile,
414                    boolean largeImage, java.lang.String largeImageURL,
415                    java.io.File largeFile,
416                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
417                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
418                    com.liferay.portal.service.ServiceContext serviceContext)
419                    throws com.liferay.portal.kernel.exception.PortalException,
420                            com.liferay.portal.kernel.exception.SystemException {
421                    return getService()
422                                       .updateItem(userId, itemId, groupId, categoryId, sku, name,
423                            description, properties, fieldsQuantities, requiresShipping,
424                            stockQuantity, featured, sale, smallImage, smallImageURL,
425                            smallFile, mediumImage, mediumImageURL, mediumFile, largeImage,
426                            largeImageURL, largeFile, itemFields, itemPrices, serviceContext);
427            }
428    
429            public static ShoppingItemLocalService getService() {
430                    if (_service == null) {
431                            _service = (ShoppingItemLocalService)PortalBeanLocatorUtil.locate(ShoppingItemLocalService.class.getName());
432                    }
433    
434                    return _service;
435            }
436    
437            public void setService(ShoppingItemLocalService service) {
438                    _service = service;
439            }
440    
441            private static ShoppingItemLocalService _service;
442    }