001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.shopping.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the shopping 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.
023     *
024     * <p>
025     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see ShoppingItemLocalService
030     * @see com.liferay.portlet.shopping.service.base.ShoppingItemLocalServiceBaseImpl
031     * @see com.liferay.portlet.shopping.service.impl.ShoppingItemLocalServiceImpl
032     * @generated
033     */
034    public class ShoppingItemLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the shopping item to the database. Also notifies the appropriate model listeners.
043            *
044            * @param shoppingItem the shopping item
045            * @return the shopping item that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.shopping.model.ShoppingItem addShoppingItem(
049                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addShoppingItem(shoppingItem);
052            }
053    
054            /**
055            * Creates a new shopping item with the primary key. Does not add the shopping item to the database.
056            *
057            * @param itemId the primary key for the new shopping item
058            * @return the new shopping item
059            */
060            public static com.liferay.portlet.shopping.model.ShoppingItem createShoppingItem(
061                    long itemId) {
062                    return getService().createShoppingItem(itemId);
063            }
064    
065            /**
066            * Deletes the shopping item with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param itemId the primary key of the shopping item
069            * @throws PortalException if a shopping item with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteShoppingItem(long itemId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteShoppingItem(itemId);
076            }
077    
078            /**
079            * Deletes the shopping item from the database. Also notifies the appropriate model listeners.
080            *
081            * @param shoppingItem the shopping item
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteShoppingItem(
085                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteShoppingItem(shoppingItem);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            public static com.liferay.portlet.shopping.model.ShoppingItem fetchShoppingItem(
162                    long itemId) throws com.liferay.portal.kernel.exception.SystemException {
163                    return getService().fetchShoppingItem(itemId);
164            }
165    
166            /**
167            * Returns the shopping item with the primary key.
168            *
169            * @param itemId the primary key of the shopping item
170            * @return the shopping item
171            * @throws PortalException if a shopping item with the primary key could not be found
172            * @throws SystemException if a system exception occurred
173            */
174            public static com.liferay.portlet.shopping.model.ShoppingItem getShoppingItem(
175                    long itemId)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException {
178                    return getService().getShoppingItem(itemId);
179            }
180    
181            public static com.liferay.portal.model.PersistedModel getPersistedModel(
182                    java.io.Serializable primaryKeyObj)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getPersistedModel(primaryKeyObj);
186            }
187    
188            /**
189            * Returns a range of all the shopping items.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of shopping items
196            * @param end the upper bound of the range of shopping items (not inclusive)
197            * @return the range of shopping items
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getShoppingItems(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getShoppingItems(start, end);
204            }
205    
206            /**
207            * Returns the number of shopping items.
208            *
209            * @return the number of shopping items
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getShoppingItemsCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getShoppingItemsCount();
215            }
216    
217            /**
218            * Updates the shopping item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
219            *
220            * @param shoppingItem the shopping item
221            * @return the shopping item that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.shopping.model.ShoppingItem updateShoppingItem(
225                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateShoppingItem(shoppingItem);
228            }
229    
230            /**
231            * Updates the shopping item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
232            *
233            * @param shoppingItem the shopping item
234            * @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.
235            * @return the shopping item that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.shopping.model.ShoppingItem updateShoppingItem(
239                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateShoppingItem(shoppingItem, merge);
243            }
244    
245            /**
246            * Returns the Spring bean ID for this bean.
247            *
248            * @return the Spring bean ID for this bean
249            */
250            public static java.lang.String getBeanIdentifier() {
251                    return getService().getBeanIdentifier();
252            }
253    
254            /**
255            * Sets the Spring bean ID for this bean.
256            *
257            * @param beanIdentifier the Spring bean ID for this bean
258            */
259            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
260                    getService().setBeanIdentifier(beanIdentifier);
261            }
262    
263            public static void addBookItems(long userId, long groupId, long categoryId,
264                    java.lang.String[] isbns)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    getService().addBookItems(userId, groupId, categoryId, isbns);
268            }
269    
270            public static com.liferay.portlet.shopping.model.ShoppingItem addItem(
271                    long userId, long groupId, long categoryId, java.lang.String sku,
272                    java.lang.String name, java.lang.String description,
273                    java.lang.String properties, java.lang.String fieldsQuantities,
274                    boolean requiresShipping, int stockQuantity, boolean featured,
275                    java.lang.Boolean sale, boolean smallImage,
276                    java.lang.String smallImageURL, java.io.File smallImageFile,
277                    boolean mediumImage, java.lang.String mediumImageURL,
278                    java.io.File mediumImageFile, boolean largeImage,
279                    java.lang.String largeImageURL, java.io.File largeImageFile,
280                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
281                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
282                    com.liferay.portal.service.ServiceContext serviceContext)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    return getService()
286                                       .addItem(userId, groupId, categoryId, sku, name,
287                            description, properties, fieldsQuantities, requiresShipping,
288                            stockQuantity, featured, sale, smallImage, smallImageURL,
289                            smallImageFile, mediumImage, mediumImageURL, mediumImageFile,
290                            largeImage, largeImageURL, largeImageFile, itemFields, itemPrices,
291                            serviceContext);
292            }
293    
294            public static void addItemResources(long itemId,
295                    boolean addGroupPermissions, boolean addGuestPermissions)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    getService()
299                            .addItemResources(itemId, addGroupPermissions, addGuestPermissions);
300            }
301    
302            public static void addItemResources(long itemId,
303                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    getService().addItemResources(itemId, groupPermissions, guestPermissions);
307            }
308    
309            public static void addItemResources(
310                    com.liferay.portlet.shopping.model.ShoppingItem item,
311                    boolean addGroupPermissions, boolean addGuestPermissions)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService()
315                            .addItemResources(item, addGroupPermissions, addGuestPermissions);
316            }
317    
318            public static void addItemResources(
319                    com.liferay.portlet.shopping.model.ShoppingItem item,
320                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService().addItemResources(item, groupPermissions, guestPermissions);
324            }
325    
326            public static void deleteItem(long itemId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService().deleteItem(itemId);
330            }
331    
332            public static void deleteItem(
333                    com.liferay.portlet.shopping.model.ShoppingItem item)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException {
336                    getService().deleteItem(item);
337            }
338    
339            public static void deleteItems(long groupId, long categoryId)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException {
342                    getService().deleteItems(groupId, categoryId);
343            }
344    
345            public static int getCategoriesItemsCount(long groupId,
346                    java.util.List<java.lang.Long> categoryIds)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    return getService().getCategoriesItemsCount(groupId, categoryIds);
349            }
350    
351            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getFeaturedItems(
352                    long groupId, long categoryId, int numOfItems)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService().getFeaturedItems(groupId, categoryId, numOfItems);
355            }
356    
357            public static com.liferay.portlet.shopping.model.ShoppingItem getItem(
358                    long itemId)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException {
361                    return getService().getItem(itemId);
362            }
363    
364            public static com.liferay.portlet.shopping.model.ShoppingItem getItem(
365                    long companyId, java.lang.String sku)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getItem(companyId, sku);
369            }
370    
371            public static com.liferay.portlet.shopping.model.ShoppingItem getItemByLargeImageId(
372                    long largeImageId)
373                    throws com.liferay.portal.kernel.exception.PortalException,
374                            com.liferay.portal.kernel.exception.SystemException {
375                    return getService().getItemByLargeImageId(largeImageId);
376            }
377    
378            public static com.liferay.portlet.shopping.model.ShoppingItem getItemByMediumImageId(
379                    long mediumImageId)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException {
382                    return getService().getItemByMediumImageId(mediumImageId);
383            }
384    
385            public static com.liferay.portlet.shopping.model.ShoppingItem getItemBySmallImageId(
386                    long smallImageId)
387                    throws com.liferay.portal.kernel.exception.PortalException,
388                            com.liferay.portal.kernel.exception.SystemException {
389                    return getService().getItemBySmallImageId(smallImageId);
390            }
391    
392            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
393                    long groupId, long categoryId)
394                    throws com.liferay.portal.kernel.exception.SystemException {
395                    return getService().getItems(groupId, categoryId);
396            }
397    
398            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
399                    long groupId, long categoryId, int start, int end,
400                    com.liferay.portal.kernel.util.OrderByComparator obc)
401                    throws com.liferay.portal.kernel.exception.SystemException {
402                    return getService().getItems(groupId, categoryId, start, end, obc);
403            }
404    
405            public static int getItemsCount(long groupId, long categoryId)
406                    throws com.liferay.portal.kernel.exception.SystemException {
407                    return getService().getItemsCount(groupId, categoryId);
408            }
409    
410            public static com.liferay.portlet.shopping.model.ShoppingItem[] getItemsPrevAndNext(
411                    long itemId, com.liferay.portal.kernel.util.OrderByComparator obc)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException {
414                    return getService().getItemsPrevAndNext(itemId, obc);
415            }
416    
417            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getSaleItems(
418                    long groupId, long categoryId, int numOfItems)
419                    throws com.liferay.portal.kernel.exception.SystemException {
420                    return getService().getSaleItems(groupId, categoryId, numOfItems);
421            }
422    
423            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> search(
424                    long groupId, long[] categoryIds, java.lang.String keywords, int start,
425                    int end) throws com.liferay.portal.kernel.exception.SystemException {
426                    return getService().search(groupId, categoryIds, keywords, start, end);
427            }
428    
429            public static int searchCount(long groupId, long[] categoryIds,
430                    java.lang.String keywords)
431                    throws com.liferay.portal.kernel.exception.SystemException {
432                    return getService().searchCount(groupId, categoryIds, keywords);
433            }
434    
435            public static com.liferay.portlet.shopping.model.ShoppingItem updateItem(
436                    long userId, long itemId, long groupId, long categoryId,
437                    java.lang.String sku, java.lang.String name,
438                    java.lang.String description, java.lang.String properties,
439                    java.lang.String fieldsQuantities, boolean requiresShipping,
440                    int stockQuantity, boolean featured, java.lang.Boolean sale,
441                    boolean smallImage, java.lang.String smallImageURL,
442                    java.io.File smallImageFile, boolean mediumImage,
443                    java.lang.String mediumImageURL, java.io.File mediumImageFile,
444                    boolean largeImage, java.lang.String largeImageURL,
445                    java.io.File largeImageFile,
446                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
447                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
448                    com.liferay.portal.service.ServiceContext serviceContext)
449                    throws com.liferay.portal.kernel.exception.PortalException,
450                            com.liferay.portal.kernel.exception.SystemException {
451                    return getService()
452                                       .updateItem(userId, itemId, groupId, categoryId, sku, name,
453                            description, properties, fieldsQuantities, requiresShipping,
454                            stockQuantity, featured, sale, smallImage, smallImageURL,
455                            smallImageFile, mediumImage, mediumImageURL, mediumImageFile,
456                            largeImage, largeImageURL, largeImageFile, itemFields, itemPrices,
457                            serviceContext);
458            }
459    
460            public static ShoppingItemLocalService getService() {
461                    if (_service == null) {
462                            _service = (ShoppingItemLocalService)PortalBeanLocatorUtil.locate(ShoppingItemLocalService.class.getName());
463    
464                            ReferenceRegistry.registerReference(ShoppingItemLocalServiceUtil.class,
465                                    "_service");
466                            MethodCache.remove(ShoppingItemLocalService.class);
467                    }
468    
469                    return _service;
470            }
471    
472            public void setService(ShoppingItemLocalService service) {
473                    MethodCache.remove(ShoppingItemLocalService.class);
474    
475                    _service = service;
476    
477                    ReferenceRegistry.registerReference(ShoppingItemLocalServiceUtil.class,
478                            "_service");
479                    MethodCache.remove(ShoppingItemLocalService.class);
480            }
481    
482            private static ShoppingItemLocalService _service;
483    }