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