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