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     * Provides the local service interface for ShoppingOrder. Methods of this
027     * service will not have security checks based on the propagated JAAS
028     * credentials because this service can only be accessed from within the same
029     * VM.
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 BaseLocalService,
040            PersistedModelLocalService {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * 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.
045             */
046    
047            /**
048            * Adds the shopping order to the database. Also notifies the appropriate model listeners.
049            *
050            * @param shoppingOrder the shopping order
051            * @return the shopping order that was added
052            * @throws SystemException if a system exception occurred
053            */
054            public com.liferay.portlet.shopping.model.ShoppingOrder addShoppingOrder(
055                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
056                    throws com.liferay.portal.kernel.exception.SystemException;
057    
058            /**
059            * Creates a new shopping order with the primary key. Does not add the shopping order to the database.
060            *
061            * @param orderId the primary key for the new shopping order
062            * @return the new shopping order
063            */
064            public com.liferay.portlet.shopping.model.ShoppingOrder createShoppingOrder(
065                    long orderId);
066    
067            /**
068            * Deletes the shopping order with the primary key from the database. Also notifies the appropriate model listeners.
069            *
070            * @param orderId the primary key of the shopping order
071            * @return the shopping order that was removed
072            * @throws PortalException if a shopping order with the primary key could not be found
073            * @throws SystemException if a system exception occurred
074            */
075            public com.liferay.portlet.shopping.model.ShoppingOrder deleteShoppingOrder(
076                    long orderId)
077                    throws com.liferay.portal.kernel.exception.PortalException,
078                            com.liferay.portal.kernel.exception.SystemException;
079    
080            /**
081            * Deletes the shopping order from the database. Also notifies the appropriate model listeners.
082            *
083            * @param shoppingOrder the shopping order
084            * @return the shopping order that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public com.liferay.portlet.shopping.model.ShoppingOrder deleteShoppingOrder(
088                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
089                    throws com.liferay.portal.kernel.exception.SystemException;
090    
091            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
092    
093            /**
094            * Performs a dynamic query on the database and returns the matching rows.
095            *
096            * @param dynamicQuery the dynamic query
097            * @return the matching rows
098            * @throws SystemException if a system exception occurred
099            */
100            @SuppressWarnings("rawtypes")
101            public java.util.List dynamicQuery(
102                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
103                    throws com.liferay.portal.kernel.exception.SystemException;
104    
105            /**
106            * Performs a dynamic query on the database and returns a range of the matching rows.
107            *
108            * <p>
109            * 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.
110            * </p>
111            *
112            * @param dynamicQuery the dynamic query
113            * @param start the lower bound of the range of model instances
114            * @param end the upper bound of the range of model instances (not inclusive)
115            * @return the range of matching rows
116            * @throws SystemException if a system exception occurred
117            */
118            @SuppressWarnings("rawtypes")
119            public java.util.List dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
121                    int end) throws com.liferay.portal.kernel.exception.SystemException;
122    
123            /**
124            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
125            *
126            * <p>
127            * 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.
128            * </p>
129            *
130            * @param dynamicQuery the dynamic query
131            * @param start the lower bound of the range of model instances
132            * @param end the upper bound of the range of model instances (not inclusive)
133            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
134            * @return the ordered range of matching rows
135            * @throws SystemException if a system exception occurred
136            */
137            @SuppressWarnings("rawtypes")
138            public java.util.List dynamicQuery(
139                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
140                    int end,
141                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            /**
145            * Returns the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @param projection the projection to apply to the query
160            * @return the number of rows that match the dynamic query
161            * @throws SystemException if a system exception occurred
162            */
163            public long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
165                    com.liferay.portal.kernel.dao.orm.Projection projection)
166                    throws com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.shopping.model.ShoppingOrder fetchShoppingOrder(
170                    long orderId)
171                    throws com.liferay.portal.kernel.exception.SystemException;
172    
173            /**
174            * Returns the shopping order with the primary key.
175            *
176            * @param orderId the primary key of the shopping order
177            * @return the shopping order
178            * @throws PortalException if a shopping order with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public com.liferay.portlet.shopping.model.ShoppingOrder getShoppingOrder(
183                    long orderId)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException;
186    
187            @Override
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public com.liferay.portal.model.PersistedModel getPersistedModel(
190                    java.io.Serializable primaryKeyObj)
191                    throws com.liferay.portal.kernel.exception.PortalException,
192                            com.liferay.portal.kernel.exception.SystemException;
193    
194            /**
195            * Returns a range of all the shopping orders.
196            *
197            * <p>
198            * 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.
199            * </p>
200            *
201            * @param start the lower bound of the range of shopping orders
202            * @param end the upper bound of the range of shopping orders (not inclusive)
203            * @return the range of shopping orders
204            * @throws SystemException if a system exception occurred
205            */
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> getShoppingOrders(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            /**
212            * Returns the number of shopping orders.
213            *
214            * @return the number of shopping orders
215            * @throws SystemException if a system exception occurred
216            */
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public int getShoppingOrdersCount()
219                    throws com.liferay.portal.kernel.exception.SystemException;
220    
221            /**
222            * Updates the shopping order in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
223            *
224            * @param shoppingOrder the shopping order
225            * @return the shopping order that was updated
226            * @throws SystemException if a system exception occurred
227            */
228            public com.liferay.portlet.shopping.model.ShoppingOrder updateShoppingOrder(
229                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
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    }