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