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