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. 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.
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. 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.
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. 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.
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            * Returns the Spring bean ID for this bean.
238            *
239            * @return the Spring bean ID for this bean
240            */
241            public static java.lang.String getBeanIdentifier() {
242                    return getService().getBeanIdentifier();
243            }
244    
245            /**
246            * Sets the Spring bean ID for this bean.
247            *
248            * @param beanIdentifier the Spring bean ID for this bean
249            */
250            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
251                    getService().setBeanIdentifier(beanIdentifier);
252            }
253    
254            public static void addBookItems(long userId, long groupId, long categoryId,
255                    java.lang.String[] isbns)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException {
258                    getService().addBookItems(userId, groupId, categoryId, isbns);
259            }
260    
261            public static com.liferay.portlet.shopping.model.ShoppingItem addItem(
262                    long userId, long groupId, long categoryId, java.lang.String sku,
263                    java.lang.String name, java.lang.String description,
264                    java.lang.String properties, java.lang.String fieldsQuantities,
265                    boolean requiresShipping, int stockQuantity, boolean featured,
266                    java.lang.Boolean sale, boolean smallImage,
267                    java.lang.String smallImageURL, java.io.File smallImageFile,
268                    boolean mediumImage, java.lang.String mediumImageURL,
269                    java.io.File mediumImageFile, boolean largeImage,
270                    java.lang.String largeImageURL, java.io.File largeImageFile,
271                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
272                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
273                    com.liferay.portal.service.ServiceContext serviceContext)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    return getService()
277                                       .addItem(userId, groupId, categoryId, sku, name,
278                            description, properties, fieldsQuantities, requiresShipping,
279                            stockQuantity, featured, sale, smallImage, smallImageURL,
280                            smallImageFile, mediumImage, mediumImageURL, mediumImageFile,
281                            largeImage, largeImageURL, largeImageFile, itemFields, itemPrices,
282                            serviceContext);
283            }
284    
285            public static void addItemResources(long itemId,
286                    boolean addGroupPermissions, boolean addGuestPermissions)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService()
290                            .addItemResources(itemId, addGroupPermissions, addGuestPermissions);
291            }
292    
293            public static void addItemResources(long itemId,
294                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService().addItemResources(itemId, groupPermissions, guestPermissions);
298            }
299    
300            public static void addItemResources(
301                    com.liferay.portlet.shopping.model.ShoppingItem item,
302                    boolean addGroupPermissions, boolean addGuestPermissions)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService()
306                            .addItemResources(item, addGroupPermissions, addGuestPermissions);
307            }
308    
309            public static void addItemResources(
310                    com.liferay.portlet.shopping.model.ShoppingItem item,
311                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService().addItemResources(item, groupPermissions, guestPermissions);
315            }
316    
317            public static void deleteItem(long itemId)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    getService().deleteItem(itemId);
321            }
322    
323            public static void deleteItem(
324                    com.liferay.portlet.shopping.model.ShoppingItem item)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteItem(item);
328            }
329    
330            public static void deleteItems(long groupId, long categoryId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    getService().deleteItems(groupId, categoryId);
334            }
335    
336            public static int getCategoriesItemsCount(long groupId,
337                    java.util.List<java.lang.Long> categoryIds)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getCategoriesItemsCount(groupId, categoryIds);
340            }
341    
342            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getFeaturedItems(
343                    long groupId, long categoryId, int numOfItems)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getFeaturedItems(groupId, categoryId, numOfItems);
346            }
347    
348            public static com.liferay.portlet.shopping.model.ShoppingItem getItem(
349                    long itemId)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    return getService().getItem(itemId);
353            }
354    
355            public static com.liferay.portlet.shopping.model.ShoppingItem getItem(
356                    long companyId, java.lang.String sku)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getItem(companyId, sku);
360            }
361    
362            public static com.liferay.portlet.shopping.model.ShoppingItem getItemByLargeImageId(
363                    long largeImageId)
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getItemByLargeImageId(largeImageId);
367            }
368    
369            public static com.liferay.portlet.shopping.model.ShoppingItem getItemByMediumImageId(
370                    long mediumImageId)
371                    throws com.liferay.portal.kernel.exception.PortalException,
372                            com.liferay.portal.kernel.exception.SystemException {
373                    return getService().getItemByMediumImageId(mediumImageId);
374            }
375    
376            public static com.liferay.portlet.shopping.model.ShoppingItem getItemBySmallImageId(
377                    long smallImageId)
378                    throws com.liferay.portal.kernel.exception.PortalException,
379                            com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getItemBySmallImageId(smallImageId);
381            }
382    
383            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
384                    long groupId, long categoryId)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getItems(groupId, categoryId);
387            }
388    
389            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
390                    long groupId, long categoryId, int start, int end,
391                    com.liferay.portal.kernel.util.OrderByComparator obc)
392                    throws com.liferay.portal.kernel.exception.SystemException {
393                    return getService().getItems(groupId, categoryId, start, end, obc);
394            }
395    
396            public static int getItemsCount(long groupId, long categoryId)
397                    throws com.liferay.portal.kernel.exception.SystemException {
398                    return getService().getItemsCount(groupId, categoryId);
399            }
400    
401            public static com.liferay.portlet.shopping.model.ShoppingItem[] getItemsPrevAndNext(
402                    long itemId, com.liferay.portal.kernel.util.OrderByComparator obc)
403                    throws com.liferay.portal.kernel.exception.PortalException,
404                            com.liferay.portal.kernel.exception.SystemException {
405                    return getService().getItemsPrevAndNext(itemId, obc);
406            }
407    
408            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getSaleItems(
409                    long groupId, long categoryId, int numOfItems)
410                    throws com.liferay.portal.kernel.exception.SystemException {
411                    return getService().getSaleItems(groupId, categoryId, numOfItems);
412            }
413    
414            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> search(
415                    long groupId, long[] categoryIds, java.lang.String keywords, int start,
416                    int end) throws com.liferay.portal.kernel.exception.SystemException {
417                    return getService().search(groupId, categoryIds, keywords, start, end);
418            }
419    
420            public static int searchCount(long groupId, long[] categoryIds,
421                    java.lang.String keywords)
422                    throws com.liferay.portal.kernel.exception.SystemException {
423                    return getService().searchCount(groupId, categoryIds, keywords);
424            }
425    
426            public static com.liferay.portlet.shopping.model.ShoppingItem updateItem(
427                    long userId, long itemId, long groupId, long categoryId,
428                    java.lang.String sku, java.lang.String name,
429                    java.lang.String description, java.lang.String properties,
430                    java.lang.String fieldsQuantities, boolean requiresShipping,
431                    int stockQuantity, boolean featured, java.lang.Boolean sale,
432                    boolean smallImage, java.lang.String smallImageURL,
433                    java.io.File smallImageFile, boolean mediumImage,
434                    java.lang.String mediumImageURL, java.io.File mediumImageFile,
435                    boolean largeImage, java.lang.String largeImageURL,
436                    java.io.File largeImageFile,
437                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
438                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
439                    com.liferay.portal.service.ServiceContext serviceContext)
440                    throws com.liferay.portal.kernel.exception.PortalException,
441                            com.liferay.portal.kernel.exception.SystemException {
442                    return getService()
443                                       .updateItem(userId, itemId, groupId, categoryId, sku, name,
444                            description, properties, fieldsQuantities, requiresShipping,
445                            stockQuantity, featured, sale, smallImage, smallImageURL,
446                            smallImageFile, mediumImage, mediumImageURL, mediumImageFile,
447                            largeImage, largeImageURL, largeImageFile, itemFields, itemPrices,
448                            serviceContext);
449            }
450    
451            public static ShoppingItemLocalService getService() {
452                    if (_service == null) {
453                            _service = (ShoppingItemLocalService)PortalBeanLocatorUtil.locate(ShoppingItemLocalService.class.getName());
454    
455                            ReferenceRegistry.registerReference(ShoppingItemLocalServiceUtil.class,
456                                    "_service");
457                    }
458    
459                    return _service;
460            }
461    
462            /**
463             * @deprecated As of 6.2.0
464             */
465            public void setService(ShoppingItemLocalService service) {
466            }
467    
468            private static ShoppingItemLocalService _service;
469    }