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     * Provides the local service interface for ShoppingItem. Methods of this
027     * service will not have security checks based on the propagated JAAS
028     * credentials because this service can only be accessed from within the same
029     * VM.
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 BaseLocalService,
040            PersistedModelLocalService {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * 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.
045             */
046    
047            /**
048            * Adds the shopping item to the database. Also notifies the appropriate model listeners.
049            *
050            * @param shoppingItem the shopping item
051            * @return the shopping item that was added
052            * @throws SystemException if a system exception occurred
053            */
054            public com.liferay.portlet.shopping.model.ShoppingItem addShoppingItem(
055                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
056                    throws com.liferay.portal.kernel.exception.SystemException;
057    
058            /**
059            * Creates a new shopping item with the primary key. Does not add the shopping item to the database.
060            *
061            * @param itemId the primary key for the new shopping item
062            * @return the new shopping item
063            */
064            public com.liferay.portlet.shopping.model.ShoppingItem createShoppingItem(
065                    long itemId);
066    
067            /**
068            * Deletes the shopping item with the primary key from the database. Also notifies the appropriate model listeners.
069            *
070            * @param itemId the primary key of the shopping item
071            * @return the shopping item that was removed
072            * @throws PortalException if a shopping item with the primary key could not be found
073            * @throws SystemException if a system exception occurred
074            */
075            public com.liferay.portlet.shopping.model.ShoppingItem deleteShoppingItem(
076                    long itemId)
077                    throws com.liferay.portal.kernel.exception.PortalException,
078                            com.liferay.portal.kernel.exception.SystemException;
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 com.liferay.portlet.shopping.model.ShoppingItem deleteShoppingItem(
088                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
089                    throws com.liferay.portal.kernel.exception.SystemException;
090    
091            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
092    
093            /**
094            * Performs a dynamic query on the database and returns the matching rows.
095            *
096            * @param dynamicQuery the dynamic query
097            * @return the matching rows
098            * @throws SystemException if a system exception occurred
099            */
100            @SuppressWarnings("rawtypes")
101            public java.util.List dynamicQuery(
102                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
103                    throws com.liferay.portal.kernel.exception.SystemException;
104    
105            /**
106            * Performs a dynamic query on the database and returns a range of the matching rows.
107            *
108            * <p>
109            * 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.
110            * </p>
111            *
112            * @param dynamicQuery the dynamic query
113            * @param start the lower bound of the range of model instances
114            * @param end the upper bound of the range of model instances (not inclusive)
115            * @return the range of matching rows
116            * @throws SystemException if a system exception occurred
117            */
118            @SuppressWarnings("rawtypes")
119            public java.util.List dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
121                    int end) throws com.liferay.portal.kernel.exception.SystemException;
122    
123            /**
124            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
125            *
126            * <p>
127            * 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.
128            * </p>
129            *
130            * @param dynamicQuery the dynamic query
131            * @param start the lower bound of the range of model instances
132            * @param end the upper bound of the range of model instances (not inclusive)
133            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
134            * @return the ordered range of matching rows
135            * @throws SystemException if a system exception occurred
136            */
137            @SuppressWarnings("rawtypes")
138            public java.util.List dynamicQuery(
139                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
140                    int end,
141                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            /**
145            * Returns the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @param projection the projection to apply to the query
160            * @return the number of rows that match the dynamic query
161            * @throws SystemException if a system exception occurred
162            */
163            public long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
165                    com.liferay.portal.kernel.dao.orm.Projection projection)
166                    throws com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.shopping.model.ShoppingItem fetchShoppingItem(
170                    long itemId) throws com.liferay.portal.kernel.exception.SystemException;
171    
172            /**
173            * Returns the shopping item with the primary key.
174            *
175            * @param itemId the primary key of the shopping item
176            * @return the shopping item
177            * @throws PortalException if a shopping item with the primary key could not be found
178            * @throws SystemException if a system exception occurred
179            */
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public com.liferay.portlet.shopping.model.ShoppingItem getShoppingItem(
182                    long itemId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException;
185    
186            @Override
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException;
192    
193            /**
194            * Returns a range of all the shopping items.
195            *
196            * <p>
197            * 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.
198            * </p>
199            *
200            * @param start the lower bound of the range of shopping items
201            * @param end the upper bound of the range of shopping items (not inclusive)
202            * @return the range of shopping items
203            * @throws SystemException if a system exception occurred
204            */
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItem> getShoppingItems(
207                    int start, int end)
208                    throws com.liferay.portal.kernel.exception.SystemException;
209    
210            /**
211            * Returns the number of shopping items.
212            *
213            * @return the number of shopping items
214            * @throws SystemException if a system exception occurred
215            */
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public int getShoppingItemsCount()
218                    throws com.liferay.portal.kernel.exception.SystemException;
219    
220            /**
221            * Updates the shopping item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
222            *
223            * @param shoppingItem the shopping item
224            * @return the shopping item that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public com.liferay.portlet.shopping.model.ShoppingItem updateShoppingItem(
228                    com.liferay.portlet.shopping.model.ShoppingItem shoppingItem)
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    }