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.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. 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.
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. 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.
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. 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.
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            * Returns the Spring bean ID for this bean.
221            *
222            * @return the Spring bean ID for this bean
223            */
224            public java.lang.String getBeanIdentifier();
225    
226            /**
227            * Sets the Spring bean ID for this bean.
228            *
229            * @param beanIdentifier the Spring bean ID for this bean
230            */
231            public void setBeanIdentifier(java.lang.String beanIdentifier);
232    
233            public com.liferay.portlet.shopping.model.ShoppingOrder addLatestOrder(
234                    long userId, long groupId)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException;
237    
238            public void completeOrder(java.lang.String number,
239                    java.lang.String ppTxnId, java.lang.String ppPaymentStatus,
240                    double ppPaymentGross, java.lang.String ppReceiverEmail,
241                    java.lang.String ppPayerEmail, boolean updateInventory,
242                    com.liferay.portal.service.ServiceContext serviceContext)
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                    com.liferay.portal.service.ServiceContext serviceContext)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            public void sendEmail(
313                    com.liferay.portlet.shopping.model.ShoppingOrder order,
314                    java.lang.String emailType,
315                    com.liferay.portal.service.ServiceContext serviceContext)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException;
318    
319            public com.liferay.portlet.shopping.model.ShoppingOrder updateLatestOrder(
320                    long userId, long groupId, 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    
337            public com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
338                    long orderId, java.lang.String ppTxnId,
339                    java.lang.String ppPaymentStatus, double ppPaymentGross,
340                    java.lang.String ppReceiverEmail, java.lang.String ppPayerEmail)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException;
343    
344            public com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
345                    long orderId, java.lang.String billingFirstName,
346                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
347                    java.lang.String billingCompany, java.lang.String billingStreet,
348                    java.lang.String billingCity, java.lang.String billingState,
349                    java.lang.String billingZip, java.lang.String billingCountry,
350                    java.lang.String billingPhone, boolean shipToBilling,
351                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
352                    java.lang.String shippingEmailAddress,
353                    java.lang.String shippingCompany, java.lang.String shippingStreet,
354                    java.lang.String shippingCity, java.lang.String shippingState,
355                    java.lang.String shippingZip, java.lang.String shippingCountry,
356                    java.lang.String shippingPhone, java.lang.String ccName,
357                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
358                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException;
361    }