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.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the shopping order local service. This utility wraps {@link com.liferay.portlet.shopping.service.impl.ShoppingOrderLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see ShoppingOrderLocalService
029     * @see com.liferay.portlet.shopping.service.base.ShoppingOrderLocalServiceBaseImpl
030     * @see com.liferay.portlet.shopping.service.impl.ShoppingOrderLocalServiceImpl
031     * @generated
032     */
033    public class ShoppingOrderLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.shopping.service.impl.ShoppingOrderLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the shopping order to the database. Also notifies the appropriate model listeners.
042            *
043            * @param shoppingOrder the shopping order
044            * @return the shopping order that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.shopping.model.ShoppingOrder addShoppingOrder(
048                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addShoppingOrder(shoppingOrder);
051            }
052    
053            /**
054            * Creates a new shopping order with the primary key. Does not add the shopping order to the database.
055            *
056            * @param orderId the primary key for the new shopping order
057            * @return the new shopping order
058            */
059            public static com.liferay.portlet.shopping.model.ShoppingOrder createShoppingOrder(
060                    long orderId) {
061                    return getService().createShoppingOrder(orderId);
062            }
063    
064            /**
065            * Deletes the shopping order with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param orderId the primary key of the shopping order
068            * @return the shopping order that was removed
069            * @throws PortalException if a shopping order with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.shopping.model.ShoppingOrder deleteShoppingOrder(
073                    long orderId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteShoppingOrder(orderId);
077            }
078    
079            /**
080            * Deletes the shopping order from the database. Also notifies the appropriate model listeners.
081            *
082            * @param shoppingOrder the shopping order
083            * @return the shopping order that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.shopping.model.ShoppingOrder deleteShoppingOrder(
087                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteShoppingOrder(shoppingOrder);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
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 static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * 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.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.shopping.model.ShoppingOrder fetchShoppingOrder(
168                    long orderId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchShoppingOrder(orderId);
171            }
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            public static com.liferay.portlet.shopping.model.ShoppingOrder getShoppingOrder(
182                    long orderId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getShoppingOrder(orderId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns a range of all the shopping orders.
197            *
198            * <p>
199            * 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of shopping orders
203            * @param end the upper bound of the range of shopping orders (not inclusive)
204            * @return the range of shopping orders
205            * @throws SystemException if a system exception occurred
206            */
207            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> getShoppingOrders(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException {
210                    return getService().getShoppingOrders(start, end);
211            }
212    
213            /**
214            * Returns the number of shopping orders.
215            *
216            * @return the number of shopping orders
217            * @throws SystemException if a system exception occurred
218            */
219            public static int getShoppingOrdersCount()
220                    throws com.liferay.portal.kernel.exception.SystemException {
221                    return getService().getShoppingOrdersCount();
222            }
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 static com.liferay.portlet.shopping.model.ShoppingOrder updateShoppingOrder(
232                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder)
233                    throws com.liferay.portal.kernel.exception.SystemException {
234                    return getService().updateShoppingOrder(shoppingOrder);
235            }
236    
237            /**
238            * Returns the Spring bean ID for this bean.
239            *
240            * @return the Spring bean ID for this bean
241            */
242            public static java.lang.String getBeanIdentifier() {
243                    return getService().getBeanIdentifier();
244            }
245    
246            /**
247            * Sets the Spring bean ID for this bean.
248            *
249            * @param beanIdentifier the Spring bean ID for this bean
250            */
251            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
252                    getService().setBeanIdentifier(beanIdentifier);
253            }
254    
255            public static com.liferay.portlet.shopping.model.ShoppingOrder addLatestOrder(
256                    long userId, long groupId)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException {
259                    return getService().addLatestOrder(userId, groupId);
260            }
261    
262            public static void completeOrder(java.lang.String number,
263                    java.lang.String ppTxnId, java.lang.String ppPaymentStatus,
264                    double ppPaymentGross, java.lang.String ppReceiverEmail,
265                    java.lang.String ppPayerEmail, boolean updateInventory,
266                    com.liferay.portal.service.ServiceContext serviceContext)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException {
269                    getService()
270                            .completeOrder(number, ppTxnId, ppPaymentStatus, ppPaymentGross,
271                            ppReceiverEmail, ppPayerEmail, updateInventory, serviceContext);
272            }
273    
274            public static void deleteOrder(long orderId)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    getService().deleteOrder(orderId);
278            }
279    
280            public static void deleteOrder(
281                    com.liferay.portlet.shopping.model.ShoppingOrder order)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    getService().deleteOrder(order);
285            }
286    
287            public static void deleteOrders(long groupId)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    getService().deleteOrders(groupId);
291            }
292    
293            public static com.liferay.portlet.shopping.model.ShoppingOrder getLatestOrder(
294                    long userId, long groupId)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    return getService().getLatestOrder(userId, groupId);
298            }
299    
300            public static com.liferay.portlet.shopping.model.ShoppingOrder getOrder(
301                    long orderId)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    return getService().getOrder(orderId);
305            }
306    
307            public static com.liferay.portlet.shopping.model.ShoppingOrder getOrder(
308                    java.lang.String number)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    return getService().getOrder(number);
312            }
313    
314            public static com.liferay.portlet.shopping.model.ShoppingOrder getPayPalTxnIdOrder(
315                    java.lang.String ppTxnId)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    return getService().getPayPalTxnIdOrder(ppTxnId);
319            }
320    
321            public static com.liferay.portlet.shopping.model.ShoppingOrder saveLatestOrder(
322                    com.liferay.portlet.shopping.model.ShoppingCart cart)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException {
325                    return getService().saveLatestOrder(cart);
326            }
327    
328            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> search(
329                    long groupId, long companyId, long userId, java.lang.String number,
330                    java.lang.String billingFirstName, java.lang.String billingLastName,
331                    java.lang.String billingEmailAddress,
332                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
333                    java.lang.String shippingEmailAddress,
334                    java.lang.String ppPaymentStatus, boolean andOperator, int start,
335                    int end) throws com.liferay.portal.kernel.exception.SystemException {
336                    return getService()
337                                       .search(groupId, companyId, userId, number,
338                            billingFirstName, billingLastName, billingEmailAddress,
339                            shippingFirstName, shippingLastName, shippingEmailAddress,
340                            ppPaymentStatus, andOperator, start, end);
341            }
342    
343            public static int searchCount(long groupId, long companyId, long userId,
344                    java.lang.String number, java.lang.String billingFirstName,
345                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
346                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
347                    java.lang.String shippingEmailAddress,
348                    java.lang.String ppPaymentStatus, boolean andOperator)
349                    throws com.liferay.portal.kernel.exception.SystemException {
350                    return getService()
351                                       .searchCount(groupId, companyId, userId, number,
352                            billingFirstName, billingLastName, billingEmailAddress,
353                            shippingFirstName, shippingLastName, shippingEmailAddress,
354                            ppPaymentStatus, andOperator);
355            }
356    
357            public static void sendEmail(long orderId, java.lang.String emailType,
358                    com.liferay.portal.service.ServiceContext serviceContext)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException {
361                    getService().sendEmail(orderId, emailType, serviceContext);
362            }
363    
364            public static void sendEmail(
365                    com.liferay.portlet.shopping.model.ShoppingOrder order,
366                    java.lang.String emailType,
367                    com.liferay.portal.service.ServiceContext serviceContext)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    getService().sendEmail(order, emailType, serviceContext);
371            }
372    
373            public static com.liferay.portlet.shopping.model.ShoppingOrder updateLatestOrder(
374                    long userId, long groupId, java.lang.String billingFirstName,
375                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
376                    java.lang.String billingCompany, java.lang.String billingStreet,
377                    java.lang.String billingCity, java.lang.String billingState,
378                    java.lang.String billingZip, java.lang.String billingCountry,
379                    java.lang.String billingPhone, boolean shipToBilling,
380                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
381                    java.lang.String shippingEmailAddress,
382                    java.lang.String shippingCompany, java.lang.String shippingStreet,
383                    java.lang.String shippingCity, java.lang.String shippingState,
384                    java.lang.String shippingZip, java.lang.String shippingCountry,
385                    java.lang.String shippingPhone, java.lang.String ccName,
386                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
387                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException {
390                    return getService()
391                                       .updateLatestOrder(userId, groupId, billingFirstName,
392                            billingLastName, billingEmailAddress, billingCompany,
393                            billingStreet, billingCity, billingState, billingZip,
394                            billingCountry, billingPhone, shipToBilling, shippingFirstName,
395                            shippingLastName, shippingEmailAddress, shippingCompany,
396                            shippingStreet, shippingCity, shippingState, shippingZip,
397                            shippingCountry, shippingPhone, ccName, ccType, ccNumber,
398                            ccExpMonth, ccExpYear, ccVerNumber, comments);
399            }
400    
401            public static com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
402                    long orderId, java.lang.String ppTxnId,
403                    java.lang.String ppPaymentStatus, double ppPaymentGross,
404                    java.lang.String ppReceiverEmail, java.lang.String ppPayerEmail)
405                    throws com.liferay.portal.kernel.exception.PortalException,
406                            com.liferay.portal.kernel.exception.SystemException {
407                    return getService()
408                                       .updateOrder(orderId, ppTxnId, ppPaymentStatus,
409                            ppPaymentGross, ppReceiverEmail, ppPayerEmail);
410            }
411    
412            public static com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
413                    long orderId, java.lang.String billingFirstName,
414                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
415                    java.lang.String billingCompany, java.lang.String billingStreet,
416                    java.lang.String billingCity, java.lang.String billingState,
417                    java.lang.String billingZip, java.lang.String billingCountry,
418                    java.lang.String billingPhone, boolean shipToBilling,
419                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
420                    java.lang.String shippingEmailAddress,
421                    java.lang.String shippingCompany, java.lang.String shippingStreet,
422                    java.lang.String shippingCity, java.lang.String shippingState,
423                    java.lang.String shippingZip, java.lang.String shippingCountry,
424                    java.lang.String shippingPhone, java.lang.String ccName,
425                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
426                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
427                    throws com.liferay.portal.kernel.exception.PortalException,
428                            com.liferay.portal.kernel.exception.SystemException {
429                    return getService()
430                                       .updateOrder(orderId, billingFirstName, billingLastName,
431                            billingEmailAddress, billingCompany, billingStreet, billingCity,
432                            billingState, billingZip, billingCountry, billingPhone,
433                            shipToBilling, shippingFirstName, shippingLastName,
434                            shippingEmailAddress, shippingCompany, shippingStreet,
435                            shippingCity, shippingState, shippingZip, shippingCountry,
436                            shippingPhone, ccName, ccType, ccNumber, ccExpMonth, ccExpYear,
437                            ccVerNumber, comments);
438            }
439    
440            public static ShoppingOrderLocalService getService() {
441                    if (_service == null) {
442                            _service = (ShoppingOrderLocalService)PortalBeanLocatorUtil.locate(ShoppingOrderLocalService.class.getName());
443    
444                            ReferenceRegistry.registerReference(ShoppingOrderLocalServiceUtil.class,
445                                    "_service");
446                    }
447    
448                    return _service;
449            }
450    
451            /**
452             * @deprecated
453             */
454            public void setService(ShoppingOrderLocalService service) {
455            }
456    
457            private static ShoppingOrderLocalService _service;
458    }