001    /**
002     * Copyright (c) 2000-2012 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            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150            public com.liferay.portlet.shopping.model.ShoppingOrder fetchShoppingOrder(
151                    long orderId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the shopping order with the primary key.
156            *
157            * @param orderId the primary key of the shopping order
158            * @return the shopping order
159            * @throws PortalException if a shopping order with the primary key could not be found
160            * @throws SystemException if a system exception occurred
161            */
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portlet.shopping.model.ShoppingOrder getShoppingOrder(
164                    long orderId)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.PersistedModel getPersistedModel(
170                    java.io.Serializable primaryKeyObj)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns a range of all the shopping orders.
176            *
177            * <p>
178            * 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.
179            * </p>
180            *
181            * @param start the lower bound of the range of shopping orders
182            * @param end the upper bound of the range of shopping orders (not inclusive)
183            * @return the range of shopping orders
184            * @throws SystemException if a system exception occurred
185            */
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> getShoppingOrders(
188                    int start, int end)
189                    throws com.liferay.portal.kernel.exception.SystemException;
190    
191            /**
192            * Returns the number of shopping orders.
193            *
194            * @return the number of shopping orders
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public int getShoppingOrdersCount()
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Updates the shopping order in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
203            *
204            * @param shoppingOrder the shopping order
205            * @return the shopping order that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public com.liferay.portlet.shopping.model.ShoppingOrder updateShoppingOrder(
209                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Updates the shopping order in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param shoppingOrder the shopping order
216            * @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.
217            * @return the shopping order that was updated
218            * @throws SystemException if a system exception occurred
219            */
220            public com.liferay.portlet.shopping.model.ShoppingOrder updateShoppingOrder(
221                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder,
222                    boolean merge)
223                    throws com.liferay.portal.kernel.exception.SystemException;
224    
225            /**
226            * Returns the Spring bean ID for this bean.
227            *
228            * @return the Spring bean ID for this bean
229            */
230            public java.lang.String getBeanIdentifier();
231    
232            /**
233            * Sets the Spring bean ID for this bean.
234            *
235            * @param beanIdentifier the Spring bean ID for this bean
236            */
237            public void setBeanIdentifier(java.lang.String beanIdentifier);
238    
239            public com.liferay.portlet.shopping.model.ShoppingOrder addLatestOrder(
240                    long userId, long groupId)
241                    throws com.liferay.portal.kernel.exception.PortalException,
242                            com.liferay.portal.kernel.exception.SystemException;
243    
244            public void completeOrder(java.lang.String number,
245                    java.lang.String ppTxnId, java.lang.String ppPaymentStatus,
246                    double ppPaymentGross, java.lang.String ppReceiverEmail,
247                    java.lang.String ppPayerEmail, boolean updateInventory,
248                    com.liferay.portal.service.ServiceContext serviceContext)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException;
251    
252            public void deleteOrder(long orderId)
253                    throws com.liferay.portal.kernel.exception.PortalException,
254                            com.liferay.portal.kernel.exception.SystemException;
255    
256            public void deleteOrder(
257                    com.liferay.portlet.shopping.model.ShoppingOrder order)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException;
260    
261            public void deleteOrders(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 getLatestOrder(
267                    long userId, long groupId)
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                    long orderId)
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 getOrder(
279                    java.lang.String number)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
284            public com.liferay.portlet.shopping.model.ShoppingOrder getPayPalTxnIdOrder(
285                    java.lang.String ppTxnId)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            public com.liferay.portlet.shopping.model.ShoppingOrder saveLatestOrder(
290                    com.liferay.portlet.shopping.model.ShoppingCart cart)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
295            public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> search(
296                    long groupId, long companyId, long userId, java.lang.String number,
297                    java.lang.String billingFirstName, java.lang.String billingLastName,
298                    java.lang.String billingEmailAddress,
299                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
300                    java.lang.String shippingEmailAddress,
301                    java.lang.String ppPaymentStatus, boolean andOperator, int start,
302                    int end) throws com.liferay.portal.kernel.exception.SystemException;
303    
304            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305            public int searchCount(long groupId, long companyId, long userId,
306                    java.lang.String number, java.lang.String billingFirstName,
307                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
308                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
309                    java.lang.String shippingEmailAddress,
310                    java.lang.String ppPaymentStatus, boolean andOperator)
311                    throws com.liferay.portal.kernel.exception.SystemException;
312    
313            public void sendEmail(long orderId, java.lang.String emailType,
314                    com.liferay.portal.service.ServiceContext serviceContext)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException;
317    
318            public void sendEmail(
319                    com.liferay.portlet.shopping.model.ShoppingOrder order,
320                    java.lang.String emailType,
321                    com.liferay.portal.service.ServiceContext serviceContext)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException;
324    
325            public com.liferay.portlet.shopping.model.ShoppingOrder updateLatestOrder(
326                    long userId, long groupId, java.lang.String billingFirstName,
327                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
328                    java.lang.String billingCompany, java.lang.String billingStreet,
329                    java.lang.String billingCity, java.lang.String billingState,
330                    java.lang.String billingZip, java.lang.String billingCountry,
331                    java.lang.String billingPhone, boolean shipToBilling,
332                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
333                    java.lang.String shippingEmailAddress,
334                    java.lang.String shippingCompany, java.lang.String shippingStreet,
335                    java.lang.String shippingCity, java.lang.String shippingState,
336                    java.lang.String shippingZip, java.lang.String shippingCountry,
337                    java.lang.String shippingPhone, java.lang.String ccName,
338                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
339                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException;
342    
343            public com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
344                    long orderId, java.lang.String ppTxnId,
345                    java.lang.String ppPaymentStatus, double ppPaymentGross,
346                    java.lang.String ppReceiverEmail, java.lang.String ppPayerEmail)
347                    throws com.liferay.portal.kernel.exception.PortalException,
348                            com.liferay.portal.kernel.exception.SystemException;
349    
350            public com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
351                    long orderId, java.lang.String billingFirstName,
352                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
353                    java.lang.String billingCompany, java.lang.String billingStreet,
354                    java.lang.String billingCity, java.lang.String billingState,
355                    java.lang.String billingZip, java.lang.String billingCountry,
356                    java.lang.String billingPhone, boolean shipToBilling,
357                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
358                    java.lang.String shippingEmailAddress,
359                    java.lang.String shippingCompany, java.lang.String shippingStreet,
360                    java.lang.String shippingCity, java.lang.String shippingState,
361                    java.lang.String shippingZip, java.lang.String shippingCountry,
362                    java.lang.String shippingPhone, java.lang.String ccName,
363                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
364                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
365                    throws com.liferay.portal.kernel.exception.PortalException,
366                            com.liferay.portal.kernel.exception.SystemException;
367    }