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 ShoppingOrder. 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 ShoppingOrderLocalServiceUtil
036     * @see com.liferay.portlet.shopping.service.base.ShoppingOrderLocalServiceBaseImpl
037     * @see com.liferay.portlet.shopping.service.impl.ShoppingOrderLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface ShoppingOrderLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link ShoppingOrderLocalServiceUtil} to access the shopping order local service. Add custom service methods to {@link com.liferay.portlet.shopping.service.impl.ShoppingOrderLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050    
051            /**
052            * Adds the shopping order to the database. Also notifies the appropriate model listeners.
053            *
054            * @param shoppingOrder the shopping order
055            * @return the shopping order 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.ShoppingOrder addShoppingOrder(
060                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
061                    throws com.liferay.portal.kernel.exception.SystemException;
062    
063            /**
064            * Creates a new shopping order with the primary key. Does not add the shopping order to the database.
065            *
066            * @param orderId the primary key for the new shopping order
067            * @return the new shopping order
068            */
069            public com.liferay.portlet.shopping.model.ShoppingOrder createShoppingOrder(
070                    long orderId);
071    
072            /**
073            * Deletes the shopping order with the primary key from the database. Also notifies the appropriate model listeners.
074            *
075            * @param orderId the primary key of the shopping order
076            * @return the shopping order that was removed
077            * @throws PortalException if a shopping order 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.ShoppingOrder deleteShoppingOrder(
082                    long orderId)
083                    throws com.liferay.portal.kernel.exception.PortalException,
084                            com.liferay.portal.kernel.exception.SystemException;
085    
086            /**
087            * Deletes the shopping order from the database. Also notifies the appropriate model listeners.
088            *
089            * @param shoppingOrder the shopping order
090            * @return the shopping order 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.ShoppingOrder deleteShoppingOrder(
095                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
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.ShoppingOrderModelImpl}. 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.ShoppingOrderModelImpl}. 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.ShoppingOrder fetchShoppingOrder(
177                    long orderId)
178                    throws com.liferay.portal.kernel.exception.SystemException;
179    
180            /**
181            * Returns the shopping order with the primary key.
182            *
183            * @param orderId the primary key of the shopping order
184            * @return the shopping order
185            * @throws PortalException if a shopping order with the primary key could not be found
186            * @throws SystemException if a system exception occurred
187            */
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public com.liferay.portlet.shopping.model.ShoppingOrder getShoppingOrder(
190                    long orderId)
191                    throws com.liferay.portal.kernel.exception.PortalException,
192                            com.liferay.portal.kernel.exception.SystemException;
193    
194            @Override
195            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196            public com.liferay.portal.model.PersistedModel getPersistedModel(
197                    java.io.Serializable primaryKeyObj)
198                    throws com.liferay.portal.kernel.exception.PortalException,
199                            com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns a range of all the shopping orders.
203            *
204            * <p>
205            * 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.ShoppingOrderModelImpl}. 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.
206            * </p>
207            *
208            * @param start the lower bound of the range of shopping orders
209            * @param end the upper bound of the range of shopping orders (not inclusive)
210            * @return the range of shopping orders
211            * @throws SystemException if a system exception occurred
212            */
213            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214            public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> getShoppingOrders(
215                    int start, int end)
216                    throws com.liferay.portal.kernel.exception.SystemException;
217    
218            /**
219            * Returns the number of shopping orders.
220            *
221            * @return the number of shopping orders
222            * @throws SystemException if a system exception occurred
223            */
224            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225            public int getShoppingOrdersCount()
226                    throws com.liferay.portal.kernel.exception.SystemException;
227    
228            /**
229            * Updates the shopping order in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param shoppingOrder the shopping order
232            * @return the shopping order that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
236            public com.liferay.portlet.shopping.model.ShoppingOrder updateShoppingOrder(
237                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public java.lang.String getBeanIdentifier();
246    
247            /**
248            * Sets the Spring bean ID for this bean.
249            *
250            * @param beanIdentifier the Spring bean ID for this bean
251            */
252            public void setBeanIdentifier(java.lang.String beanIdentifier);
253    
254            public com.liferay.portlet.shopping.model.ShoppingOrder addLatestOrder(
255                    long userId, long groupId)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException;
258    
259            public void completeOrder(java.lang.String number,
260                    java.lang.String ppTxnId, java.lang.String ppPaymentStatus,
261                    double ppPaymentGross, java.lang.String ppReceiverEmail,
262                    java.lang.String ppPayerEmail, boolean updateInventory,
263                    com.liferay.portal.service.ServiceContext serviceContext)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException;
266    
267            public void deleteOrder(long orderId)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public void deleteOrder(
272                    com.liferay.portlet.shopping.model.ShoppingOrder order)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public void deleteOrders(long groupId)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public com.liferay.portlet.shopping.model.ShoppingOrder getLatestOrder(
282                    long userId, long groupId)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException;
285    
286            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
287            public com.liferay.portlet.shopping.model.ShoppingOrder getOrder(
288                    long orderId)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293            public com.liferay.portlet.shopping.model.ShoppingOrder getOrder(
294                    java.lang.String number)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public com.liferay.portlet.shopping.model.ShoppingOrder getPayPalTxnIdOrder(
300                    java.lang.String ppTxnId)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            public com.liferay.portlet.shopping.model.ShoppingOrder saveLatestOrder(
305                    com.liferay.portlet.shopping.model.ShoppingCart cart)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> search(
311                    long groupId, long companyId, long userId, java.lang.String number,
312                    java.lang.String billingFirstName, java.lang.String billingLastName,
313                    java.lang.String billingEmailAddress,
314                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
315                    java.lang.String shippingEmailAddress,
316                    java.lang.String ppPaymentStatus, boolean andOperator, int start,
317                    int end) throws com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public int searchCount(long groupId, long companyId, long userId,
321                    java.lang.String number, java.lang.String billingFirstName,
322                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
323                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
324                    java.lang.String shippingEmailAddress,
325                    java.lang.String ppPaymentStatus, boolean andOperator)
326                    throws com.liferay.portal.kernel.exception.SystemException;
327    
328            public void sendEmail(long orderId, java.lang.String emailType,
329                    com.liferay.portal.service.ServiceContext serviceContext)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException;
332    
333            public void sendEmail(
334                    com.liferay.portlet.shopping.model.ShoppingOrder order,
335                    java.lang.String emailType,
336                    com.liferay.portal.service.ServiceContext serviceContext)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException;
339    
340            public com.liferay.portlet.shopping.model.ShoppingOrder updateLatestOrder(
341                    long userId, long groupId, java.lang.String billingFirstName,
342                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
343                    java.lang.String billingCompany, java.lang.String billingStreet,
344                    java.lang.String billingCity, java.lang.String billingState,
345                    java.lang.String billingZip, java.lang.String billingCountry,
346                    java.lang.String billingPhone, boolean shipToBilling,
347                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
348                    java.lang.String shippingEmailAddress,
349                    java.lang.String shippingCompany, java.lang.String shippingStreet,
350                    java.lang.String shippingCity, java.lang.String shippingState,
351                    java.lang.String shippingZip, java.lang.String shippingCountry,
352                    java.lang.String shippingPhone, java.lang.String ccName,
353                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
354                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException;
357    
358            public com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
359                    long orderId, java.lang.String ppTxnId,
360                    java.lang.String ppPaymentStatus, double ppPaymentGross,
361                    java.lang.String ppReceiverEmail, java.lang.String ppPayerEmail)
362                    throws com.liferay.portal.kernel.exception.PortalException,
363                            com.liferay.portal.kernel.exception.SystemException;
364    
365            public com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
366                    long orderId, java.lang.String billingFirstName,
367                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
368                    java.lang.String billingCompany, java.lang.String billingStreet,
369                    java.lang.String billingCity, java.lang.String billingState,
370                    java.lang.String billingZip, java.lang.String billingCountry,
371                    java.lang.String billingPhone, boolean shipToBilling,
372                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
373                    java.lang.String shippingEmailAddress,
374                    java.lang.String shippingCompany, java.lang.String shippingStreet,
375                    java.lang.String shippingCity, java.lang.String shippingState,
376                    java.lang.String shippingZip, java.lang.String shippingCountry,
377                    java.lang.String shippingPhone, java.lang.String ccName,
378                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
379                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException;
382    }