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