001    /**
002     * Copyright (c) 2000-2010 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.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the shopping order local service.
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * <p>
031     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
032     * </p>
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    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface ShoppingOrderLocalService {
043            /**
044            * Adds the shopping order to the database. Also notifies the appropriate model listeners.
045            *
046            * @param shoppingOrder the shopping order to add
047            * @return the shopping order that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.shopping.model.ShoppingOrder addShoppingOrder(
051                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new shopping order with the primary key. Does not add the shopping order to the database.
056            *
057            * @param orderId the primary key for the new shopping order
058            * @return the new shopping order
059            */
060            public com.liferay.portlet.shopping.model.ShoppingOrder createShoppingOrder(
061                    long orderId);
062    
063            /**
064            * Deletes the shopping order with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param orderId the primary key of the shopping order to delete
067            * @throws PortalException if a shopping order with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteShoppingOrder(long orderId)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the shopping order from the database. Also notifies the appropriate model listeners.
076            *
077            * @param shoppingOrder the shopping order to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteShoppingOrder(
081                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the shopping order with the primary key.
148            *
149            * @param orderId the primary key of the shopping order to get
150            * @return the shopping order
151            * @throws PortalException if a shopping order with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.shopping.model.ShoppingOrder getShoppingOrder(
156                    long orderId)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets a range of all the shopping orders.
162            *
163            * <p>
164            * 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.
165            * </p>
166            *
167            * @param start the lower bound of the range of shopping orders to return
168            * @param end the upper bound of the range of shopping orders to return (not inclusive)
169            * @return the range of shopping orders
170            * @throws SystemException if a system exception occurred
171            */
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> getShoppingOrders(
174                    int start, int end)
175                    throws com.liferay.portal.kernel.exception.SystemException;
176    
177            /**
178            * Gets the number of shopping orders.
179            *
180            * @return the number of shopping orders
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public int getShoppingOrdersCount()
185                    throws com.liferay.portal.kernel.exception.SystemException;
186    
187            /**
188            * Updates the shopping order in the database. Also notifies the appropriate model listeners.
189            *
190            * @param shoppingOrder the shopping order to update
191            * @return the shopping order that was updated
192            * @throws SystemException if a system exception occurred
193            */
194            public com.liferay.portlet.shopping.model.ShoppingOrder updateShoppingOrder(
195                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Updates the shopping order in the database. Also notifies the appropriate model listeners.
200            *
201            * @param shoppingOrder the shopping order to update
202            * @param merge whether to merge the shopping order with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
203            * @return the shopping order that was updated
204            * @throws SystemException if a system exception occurred
205            */
206            public com.liferay.portlet.shopping.model.ShoppingOrder updateShoppingOrder(
207                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder,
208                    boolean merge)
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            public com.liferay.portlet.shopping.model.ShoppingOrder addLatestOrder(
212                    long userId, long groupId)
213                    throws com.liferay.portal.kernel.exception.PortalException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            public void completeOrder(java.lang.String number,
217                    java.lang.String ppTxnId, java.lang.String ppPaymentStatus,
218                    double ppPaymentGross, java.lang.String ppReceiverEmail,
219                    java.lang.String ppPayerEmail, boolean updateInventory)
220                    throws com.liferay.portal.kernel.exception.PortalException,
221                            com.liferay.portal.kernel.exception.SystemException;
222    
223            public void deleteOrder(long orderId)
224                    throws com.liferay.portal.kernel.exception.PortalException,
225                            com.liferay.portal.kernel.exception.SystemException;
226    
227            public void deleteOrder(
228                    com.liferay.portlet.shopping.model.ShoppingOrder order)
229                    throws com.liferay.portal.kernel.exception.PortalException,
230                            com.liferay.portal.kernel.exception.SystemException;
231    
232            public void deleteOrders(long groupId)
233                    throws com.liferay.portal.kernel.exception.PortalException,
234                            com.liferay.portal.kernel.exception.SystemException;
235    
236            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237            public com.liferay.portlet.shopping.model.ShoppingOrder getLatestOrder(
238                    long userId, long groupId)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException;
241    
242            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243            public com.liferay.portlet.shopping.model.ShoppingOrder getOrder(
244                    long orderId)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249            public com.liferay.portlet.shopping.model.ShoppingOrder getOrder(
250                    java.lang.String number)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public com.liferay.portlet.shopping.model.ShoppingOrder getPayPalTxnIdOrder(
256                    java.lang.String ppTxnId)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public com.liferay.portlet.shopping.model.ShoppingOrder saveLatestOrder(
261                    com.liferay.portlet.shopping.model.ShoppingCart cart)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266            public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> search(
267                    long groupId, long companyId, long userId, java.lang.String number,
268                    java.lang.String billingFirstName, java.lang.String billingLastName,
269                    java.lang.String billingEmailAddress,
270                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
271                    java.lang.String shippingEmailAddress,
272                    java.lang.String ppPaymentStatus, boolean andOperator, int start,
273                    int end) throws com.liferay.portal.kernel.exception.SystemException;
274    
275            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
276            public int searchCount(long groupId, long companyId, long userId,
277                    java.lang.String number, java.lang.String billingFirstName,
278                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
279                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
280                    java.lang.String shippingEmailAddress,
281                    java.lang.String ppPaymentStatus, boolean andOperator)
282                    throws com.liferay.portal.kernel.exception.SystemException;
283    
284            public void sendEmail(long orderId, java.lang.String emailType)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void sendEmail(
289                    com.liferay.portlet.shopping.model.ShoppingOrder order,
290                    java.lang.String emailType)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public com.liferay.portlet.shopping.model.ShoppingOrder updateLatestOrder(
295                    long userId, long groupId, java.lang.String billingFirstName,
296                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
297                    java.lang.String billingCompany, java.lang.String billingStreet,
298                    java.lang.String billingCity, java.lang.String billingState,
299                    java.lang.String billingZip, java.lang.String billingCountry,
300                    java.lang.String billingPhone, boolean shipToBilling,
301                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
302                    java.lang.String shippingEmailAddress,
303                    java.lang.String shippingCompany, java.lang.String shippingStreet,
304                    java.lang.String shippingCity, java.lang.String shippingState,
305                    java.lang.String shippingZip, java.lang.String shippingCountry,
306                    java.lang.String shippingPhone, java.lang.String ccName,
307                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
308                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            public com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
313                    long orderId, java.lang.String ppTxnId,
314                    java.lang.String ppPaymentStatus, double ppPaymentGross,
315                    java.lang.String ppReceiverEmail, java.lang.String ppPayerEmail)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException;
318    
319            public com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
320                    long orderId, java.lang.String billingFirstName,
321                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
322                    java.lang.String billingCompany, java.lang.String billingStreet,
323                    java.lang.String billingCity, java.lang.String billingState,
324                    java.lang.String billingZip, java.lang.String billingCountry,
325                    java.lang.String billingPhone, boolean shipToBilling,
326                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
327                    java.lang.String shippingEmailAddress,
328                    java.lang.String shippingCompany, java.lang.String shippingStreet,
329                    java.lang.String shippingCity, java.lang.String shippingState,
330                    java.lang.String shippingZip, java.lang.String shippingCountry,
331                    java.lang.String shippingPhone, java.lang.String ccName,
332                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
333                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException;
336    }