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