001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.shopping.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.transaction.Isolation;
022    import com.liferay.portal.kernel.transaction.Propagation;
023    import com.liferay.portal.kernel.transaction.Transactional;
024    import com.liferay.portal.service.BaseLocalService;
025    import com.liferay.portal.service.PersistedModelLocalService;
026    
027    /**
028     * Provides the local service interface for ShoppingItem. Methods of this
029     * service will not have security checks based on the propagated JAAS
030     * credentials because this service can only be accessed from within the same
031     * VM.
032     *
033     * @author Brian Wing Shun Chan
034     * @see ShoppingItemLocalServiceUtil
035     * @see com.liferay.portlet.shopping.service.base.ShoppingItemLocalServiceBaseImpl
036     * @see com.liferay.portlet.shopping.service.impl.ShoppingItemLocalServiceImpl
037     * @generated
038     */
039    @ProviderType
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface ShoppingItemLocalService extends BaseLocalService,
043            PersistedModelLocalService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * 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.
048             */
049    
050            /**
051            * Adds the shopping item to the database. Also notifies the appropriate model listeners.
052            *
053            * @param shoppingItem the shopping item
054            * @return the shopping item that was added
055            * @throws SystemException if a system exception occurred
056            */
057            public com.liferay.portlet.shopping.model.ShoppingItem addShoppingItem(
058                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new shopping item with the primary key. Does not add the shopping item to the database.
063            *
064            * @param itemId the primary key for the new shopping item
065            * @return the new shopping item
066            */
067            public com.liferay.portlet.shopping.model.ShoppingItem createShoppingItem(
068                    long itemId);
069    
070            /**
071            * Deletes the shopping item with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param itemId the primary key of the shopping item
074            * @return the shopping item that was removed
075            * @throws PortalException if a shopping item with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            public com.liferay.portlet.shopping.model.ShoppingItem deleteShoppingItem(
079                    long itemId)
080                    throws com.liferay.portal.kernel.exception.PortalException,
081                            com.liferay.portal.kernel.exception.SystemException;
082    
083            /**
084            * Deletes the shopping item from the database. Also notifies the appropriate model listeners.
085            *
086            * @param shoppingItem the shopping item
087            * @return the shopping item that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public com.liferay.portlet.shopping.model.ShoppingItem deleteShoppingItem(
091                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
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 java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * 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.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
121            @SuppressWarnings("rawtypes")
122            public java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException;
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the number of rows that match the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows that match the dynamic query
152            * @throws SystemException if a system exception occurred
153            */
154            public long dynamicQueryCount(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows that match the dynamic query
164            * @throws SystemException if a system exception occurred
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portlet.shopping.model.ShoppingItem fetchShoppingItem(
173                    long itemId) throws com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Returns the shopping item with the primary key.
177            *
178            * @param itemId the primary key of the shopping item
179            * @return the shopping item
180            * @throws PortalException if a shopping item with the primary key could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.shopping.model.ShoppingItem getShoppingItem(
185                    long itemId)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            @Override
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portal.model.PersistedModel getPersistedModel(
192                    java.io.Serializable primaryKeyObj)
193                    throws com.liferay.portal.kernel.exception.PortalException,
194                            com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Returns a range of all the shopping items.
198            *
199            * <p>
200            * 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.
201            * </p>
202            *
203            * @param start the lower bound of the range of shopping items
204            * @param end the upper bound of the range of shopping items (not inclusive)
205            * @return the range of shopping items
206            * @throws SystemException if a system exception occurred
207            */
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getShoppingItems(
210                    int start, int end)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Returns the number of shopping items.
215            *
216            * @return the number of shopping items
217            * @throws SystemException if a system exception occurred
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public int getShoppingItemsCount()
221                    throws com.liferay.portal.kernel.exception.SystemException;
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 com.liferay.portlet.shopping.model.ShoppingItem updateShoppingItem(
231                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            /**
235            * Returns the Spring bean ID for this bean.
236            *
237            * @return the Spring bean ID for this bean
238            */
239            public java.lang.String getBeanIdentifier();
240    
241            /**
242            * Sets the Spring bean ID for this bean.
243            *
244            * @param beanIdentifier the Spring bean ID for this bean
245            */
246            public void setBeanIdentifier(java.lang.String beanIdentifier);
247    
248            public void addBookItems(long userId, long groupId, long categoryId,
249                    java.lang.String[] isbns)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            public com.liferay.portlet.shopping.model.ShoppingItem addItem(
254                    long userId, long groupId, long categoryId, java.lang.String sku,
255                    java.lang.String name, java.lang.String description,
256                    java.lang.String properties, java.lang.String fieldsQuantities,
257                    boolean requiresShipping, int stockQuantity, boolean featured,
258                    java.lang.Boolean sale, boolean smallImage,
259                    java.lang.String smallImageURL, java.io.File smallImageFile,
260                    boolean mediumImage, java.lang.String mediumImageURL,
261                    java.io.File mediumImageFile, boolean largeImage,
262                    java.lang.String largeImageURL, java.io.File largeImageFile,
263                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
264                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
265                    com.liferay.portal.service.ServiceContext serviceContext)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            public void addItemResources(long itemId, boolean addGroupPermissions,
270                    boolean addGuestPermissions)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException;
273    
274            public void addItemResources(long itemId,
275                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException;
278    
279            public void addItemResources(
280                    com.liferay.portlet.shopping.model.ShoppingItem item,
281                    boolean addGroupPermissions, boolean addGuestPermissions)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException;
284    
285            public void addItemResources(
286                    com.liferay.portlet.shopping.model.ShoppingItem item,
287                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            public void deleteItem(long itemId)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException;
294    
295            public void deleteItem(com.liferay.portlet.shopping.model.ShoppingItem item)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            public void deleteItems(long groupId, long categoryId)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException;
302    
303            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
304            public int getCategoriesItemsCount(long groupId,
305                    java.util.List<java.lang.Long> categoryIds)
306                    throws com.liferay.portal.kernel.exception.SystemException;
307    
308            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
309            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getFeaturedItems(
310                    long groupId, long categoryId, int numOfItems)
311                    throws com.liferay.portal.kernel.exception.SystemException;
312    
313            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
314            public com.liferay.portlet.shopping.model.ShoppingItem getItem(long itemId)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public com.liferay.portlet.shopping.model.ShoppingItem getItem(
320                    long companyId, java.lang.String sku)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public com.liferay.portlet.shopping.model.ShoppingItem getItemByLargeImageId(
326                    long largeImageId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public com.liferay.portlet.shopping.model.ShoppingItem getItemByMediumImageId(
332                    long mediumImageId)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException;
335    
336            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337            public com.liferay.portlet.shopping.model.ShoppingItem getItemBySmallImageId(
338                    long smallImageId)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException;
341    
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
344                    long groupId, long categoryId)
345                    throws com.liferay.portal.kernel.exception.SystemException;
346    
347            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
348            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getItems(
349                    long groupId, long categoryId, int start, int end,
350                    com.liferay.portal.kernel.util.OrderByComparator obc)
351                    throws com.liferay.portal.kernel.exception.SystemException;
352    
353            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
354            public int getItemsCount(long groupId, long categoryId)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public com.liferay.portlet.shopping.model.ShoppingItem[] getItemsPrevAndNext(
359                    long itemId, com.liferay.portal.kernel.util.OrderByComparator obc)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException;
362    
363            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
364            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getSaleItems(
365                    long groupId, long categoryId, int numOfItems)
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
369            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> search(
370                    long groupId, long[] categoryIds, java.lang.String keywords, int start,
371                    int end) throws com.liferay.portal.kernel.exception.SystemException;
372    
373            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
374            public int searchCount(long groupId, long[] categoryIds,
375                    java.lang.String keywords)
376                    throws com.liferay.portal.kernel.exception.SystemException;
377    
378            public com.liferay.portlet.shopping.model.ShoppingItem updateItem(
379                    long userId, long itemId, long groupId, long categoryId,
380                    java.lang.String sku, java.lang.String name,
381                    java.lang.String description, java.lang.String properties,
382                    java.lang.String fieldsQuantities, boolean requiresShipping,
383                    int stockQuantity, boolean featured, java.lang.Boolean sale,
384                    boolean smallImage, java.lang.String smallImageURL,
385                    java.io.File smallImageFile, boolean mediumImage,
386                    java.lang.String mediumImageURL, java.io.File mediumImageFile,
387                    boolean largeImage, java.lang.String largeImageURL,
388                    java.io.File largeImageFile,
389                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> itemFields,
390                    java.util.List<com.liferay.portlet.shopping.model.ShoppingItemPrice> itemPrices,
391                    com.liferay.portal.service.ServiceContext serviceContext)
392                    throws com.liferay.portal.kernel.exception.PortalException,
393                            com.liferay.portal.kernel.exception.SystemException;
394    }