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