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