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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.BaseLocalService;
023    import com.liferay.portal.service.PersistedModelLocalService;
024    
025    /**
026     * The interface for the shopping item local service.
027     *
028     * <p>
029     * 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.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see ShoppingItemLocalServiceUtil
034     * @see com.liferay.portlet.shopping.service.base.ShoppingItemLocalServiceBaseImpl
035     * @see com.liferay.portlet.shopping.service.impl.ShoppingItemLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface ShoppingItemLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link ShoppingItemLocalServiceUtil} to access the shopping item local service. Add custom service methods to {@link com.liferay.portlet.shopping.service.impl.ShoppingItemLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the shopping item to the database. Also notifies the appropriate model listeners.
050            *
051            * @param shoppingItem the shopping item
052            * @return the shopping item that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.shopping.model.ShoppingItem addShoppingItem(
056                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new shopping item with the primary key. Does not add the shopping item to the database.
061            *
062            * @param itemId the primary key for the new shopping item
063            * @return the new shopping item
064            */
065            public com.liferay.portlet.shopping.model.ShoppingItem createShoppingItem(
066                    long itemId);
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 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    
081            /**
082            * Deletes the shopping item from the database. Also notifies the appropriate model listeners.
083            *
084            * @param shoppingItem the shopping item
085            * @return the shopping item that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.shopping.model.ShoppingItem deleteShoppingItem(
089                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
090                    throws com.liferay.portal.kernel.exception.SystemException;
091    
092            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException;
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Returns the number of rows that match the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows that match the dynamic query
150            * @throws SystemException if a system exception occurred
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public com.liferay.portlet.shopping.model.ShoppingItem fetchShoppingItem(
158                    long itemId) throws com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Returns the shopping item with the primary key.
162            *
163            * @param itemId the primary key of the shopping item
164            * @return the shopping item
165            * @throws PortalException if a shopping item with the primary key could not be found
166            * @throws SystemException if a system exception occurred
167            */
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.shopping.model.ShoppingItem getShoppingItem(
170                    long itemId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public com.liferay.portal.model.PersistedModel getPersistedModel(
176                    java.io.Serializable primaryKeyObj)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException;
179    
180            /**
181            * Returns a range of all the shopping items.
182            *
183            * <p>
184            * 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.
185            * </p>
186            *
187            * @param start the lower bound of the range of shopping items
188            * @param end the upper bound of the range of shopping items (not inclusive)
189            * @return the range of shopping items
190            * @throws SystemException if a system exception occurred
191            */
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getShoppingItems(
194                    int start, int end)
195                    throws com.liferay.portal.kernel.exception.SystemException;
196    
197            /**
198            * Returns the number of shopping items.
199            *
200            * @return the number of shopping items
201            * @throws SystemException if a system exception occurred
202            */
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public int getShoppingItemsCount()
205                    throws com.liferay.portal.kernel.exception.SystemException;
206    
207            /**
208            * Updates the shopping item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
209            *
210            * @param shoppingItem the shopping item
211            * @return the shopping item that was updated
212            * @throws SystemException if a system exception occurred
213            */
214            public com.liferay.portlet.shopping.model.ShoppingItem updateShoppingItem(
215                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
216                    throws com.liferay.portal.kernel.exception.SystemException;
217    
218            /**
219            * Updates the shopping item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param shoppingItem the shopping item
222            * @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.
223            * @return the shopping item that was updated
224            * @throws SystemException if a system exception occurred
225            */
226            public com.liferay.portlet.shopping.model.ShoppingItem updateShoppingItem(
227                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem,
228                    boolean merge)
229                    throws com.liferay.portal.kernel.exception.SystemException;
230    
231            /**
232            * Returns the Spring bean ID for this bean.
233            *
234            * @return the Spring bean ID for this bean
235            */
236            public java.lang.String getBeanIdentifier();
237    
238            /**
239            * Sets the Spring bean ID for this bean.
240            *
241            * @param beanIdentifier the Spring bean ID for this bean
242            */
243            public void setBeanIdentifier(java.lang.String beanIdentifier);
244    
245            public void addBookItems(long userId, long groupId, long categoryId,
246                    java.lang.String[] isbns)
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException;
249    
250            public com.liferay.portlet.shopping.model.ShoppingItem addItem(
251                    long userId, long groupId, long categoryId, java.lang.String sku,
252                    java.lang.String name, java.lang.String description,
253                    java.lang.String properties, java.lang.String fieldsQuantities,
254                    boolean requiresShipping, int stockQuantity, boolean featured,
255                    java.lang.Boolean sale, boolean smallImage,
256                    java.lang.String smallImageURL, java.io.File smallImageFile,
257                    boolean mediumImage, java.lang.String mediumImageURL,
258                    java.io.File mediumImageFile, boolean largeImage,
259                    java.lang.String largeImageURL, java.io.File largeImageFile,
260                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
261                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
262                    com.liferay.portal.service.ServiceContext serviceContext)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public void addItemResources(long itemId, boolean addGroupPermissions,
267                    boolean addGuestPermissions)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public void addItemResources(long itemId,
272                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public void addItemResources(
277                    com.liferay.portlet.shopping.model.ShoppingItem item,
278                    boolean addGroupPermissions, boolean addGuestPermissions)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException;
281    
282            public void addItemResources(
283                    com.liferay.portlet.shopping.model.ShoppingItem item,
284                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void deleteItem(long itemId)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public void deleteItem(com.liferay.portlet.shopping.model.ShoppingItem item)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException;
295    
296            public void deleteItems(long groupId, long categoryId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException;
299    
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public int getCategoriesItemsCount(long groupId,
302                    java.util.List<java.lang.Long> categoryIds)
303                    throws com.liferay.portal.kernel.exception.SystemException;
304    
305            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getFeaturedItems(
307                    long groupId, long categoryId, int numOfItems)
308                    throws com.liferay.portal.kernel.exception.SystemException;
309    
310            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
311            public com.liferay.portlet.shopping.model.ShoppingItem getItem(long itemId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException;
314    
315            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
316            public com.liferay.portlet.shopping.model.ShoppingItem getItem(
317                    long companyId, java.lang.String sku)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException;
320    
321            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
322            public com.liferay.portlet.shopping.model.ShoppingItem getItemByLargeImageId(
323                    long largeImageId)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public com.liferay.portlet.shopping.model.ShoppingItem getItemByMediumImageId(
329                    long mediumImageId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException;
332    
333            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
334            public com.liferay.portlet.shopping.model.ShoppingItem getItemBySmallImageId(
335                    long smallImageId)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException;
338    
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
341                    long groupId, long categoryId)
342                    throws com.liferay.portal.kernel.exception.SystemException;
343    
344            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
345            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
346                    long groupId, long categoryId, int start, int end,
347                    com.liferay.portal.kernel.util.OrderByComparator obc)
348                    throws com.liferay.portal.kernel.exception.SystemException;
349    
350            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351            public int getItemsCount(long groupId, long categoryId)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public com.liferay.portlet.shopping.model.ShoppingItem[] getItemsPrevAndNext(
356                    long itemId, com.liferay.portal.kernel.util.OrderByComparator obc)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException;
359    
360            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
361            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getSaleItems(
362                    long groupId, long categoryId, int numOfItems)
363                    throws com.liferay.portal.kernel.exception.SystemException;
364    
365            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> search(
367                    long groupId, long[] categoryIds, java.lang.String keywords, int start,
368                    int end) throws com.liferay.portal.kernel.exception.SystemException;
369    
370            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
371            public int searchCount(long groupId, long[] categoryIds,
372                    java.lang.String keywords)
373                    throws com.liferay.portal.kernel.exception.SystemException;
374    
375            public com.liferay.portlet.shopping.model.ShoppingItem updateItem(
376                    long userId, long itemId, long groupId, long categoryId,
377                    java.lang.String sku, java.lang.String name,
378                    java.lang.String description, java.lang.String properties,
379                    java.lang.String fieldsQuantities, boolean requiresShipping,
380                    int stockQuantity, boolean featured, java.lang.Boolean sale,
381                    boolean smallImage, java.lang.String smallImageURL,
382                    java.io.File smallImageFile, boolean mediumImage,
383                    java.lang.String mediumImageURL, java.io.File mediumImageFile,
384                    boolean largeImage, java.lang.String largeImageURL,
385                    java.io.File largeImageFile,
386                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
387                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
388                    com.liferay.portal.service.ServiceContext serviceContext)
389                    throws com.liferay.portal.kernel.exception.PortalException,
390                            com.liferay.portal.kernel.exception.SystemException;
391    }