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.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.
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.
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.
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            * Updates the shopping order in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
239            *
240            * @param shoppingOrder the shopping order
241            * @param merge whether to merge the shopping order with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
242            * @return the shopping order that was updated
243            * @throws SystemException if a system exception occurred
244            */
245            public static com.liferay.portlet.shopping.model.ShoppingOrder updateShoppingOrder(
246                    com.liferay.portlet.shopping.model.ShoppingOrder shoppingOrder,
247                    boolean merge)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService().updateShoppingOrder(shoppingOrder, merge);
250            }
251    
252            /**
253            * Returns the Spring bean ID for this bean.
254            *
255            * @return the Spring bean ID for this bean
256            */
257            public static java.lang.String getBeanIdentifier() {
258                    return getService().getBeanIdentifier();
259            }
260    
261            /**
262            * Sets the Spring bean ID for this bean.
263            *
264            * @param beanIdentifier the Spring bean ID for this bean
265            */
266            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
267                    getService().setBeanIdentifier(beanIdentifier);
268            }
269    
270            public static com.liferay.portlet.shopping.model.ShoppingOrder addLatestOrder(
271                    long userId, long groupId)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    return getService().addLatestOrder(userId, groupId);
275            }
276    
277            public static void completeOrder(java.lang.String number,
278                    java.lang.String ppTxnId, java.lang.String ppPaymentStatus,
279                    double ppPaymentGross, java.lang.String ppReceiverEmail,
280                    java.lang.String ppPayerEmail, boolean updateInventory,
281                    com.liferay.portal.service.ServiceContext serviceContext)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    getService()
285                            .completeOrder(number, ppTxnId, ppPaymentStatus, ppPaymentGross,
286                            ppReceiverEmail, ppPayerEmail, updateInventory, serviceContext);
287            }
288    
289            public static void deleteOrder(long orderId)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService().deleteOrder(orderId);
293            }
294    
295            public static void deleteOrder(
296                    com.liferay.portlet.shopping.model.ShoppingOrder order)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService().deleteOrder(order);
300            }
301    
302            public static void deleteOrders(long groupId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService().deleteOrders(groupId);
306            }
307    
308            public static com.liferay.portlet.shopping.model.ShoppingOrder getLatestOrder(
309                    long userId, long groupId)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    return getService().getLatestOrder(userId, groupId);
313            }
314    
315            public static com.liferay.portlet.shopping.model.ShoppingOrder getOrder(
316                    long orderId)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    return getService().getOrder(orderId);
320            }
321    
322            public static com.liferay.portlet.shopping.model.ShoppingOrder getOrder(
323                    java.lang.String number)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    return getService().getOrder(number);
327            }
328    
329            public static com.liferay.portlet.shopping.model.ShoppingOrder getPayPalTxnIdOrder(
330                    java.lang.String ppTxnId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    return getService().getPayPalTxnIdOrder(ppTxnId);
334            }
335    
336            public static com.liferay.portlet.shopping.model.ShoppingOrder saveLatestOrder(
337                    com.liferay.portlet.shopping.model.ShoppingCart cart)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    return getService().saveLatestOrder(cart);
341            }
342    
343            public static java.util.List<com.liferay.portlet.shopping.model.ShoppingOrder> search(
344                    long groupId, long companyId, long userId, java.lang.String number,
345                    java.lang.String billingFirstName, java.lang.String billingLastName,
346                    java.lang.String billingEmailAddress,
347                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
348                    java.lang.String shippingEmailAddress,
349                    java.lang.String ppPaymentStatus, boolean andOperator, int start,
350                    int end) throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService()
352                                       .search(groupId, companyId, userId, number,
353                            billingFirstName, billingLastName, billingEmailAddress,
354                            shippingFirstName, shippingLastName, shippingEmailAddress,
355                            ppPaymentStatus, andOperator, start, end);
356            }
357    
358            public static int searchCount(long groupId, long companyId, long userId,
359                    java.lang.String number, java.lang.String billingFirstName,
360                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
361                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
362                    java.lang.String shippingEmailAddress,
363                    java.lang.String ppPaymentStatus, boolean andOperator)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService()
366                                       .searchCount(groupId, companyId, userId, number,
367                            billingFirstName, billingLastName, billingEmailAddress,
368                            shippingFirstName, shippingLastName, shippingEmailAddress,
369                            ppPaymentStatus, andOperator);
370            }
371    
372            public static void sendEmail(long orderId, java.lang.String emailType,
373                    com.liferay.portal.service.ServiceContext serviceContext)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException {
376                    getService().sendEmail(orderId, emailType, serviceContext);
377            }
378    
379            public static void sendEmail(
380                    com.liferay.portlet.shopping.model.ShoppingOrder order,
381                    java.lang.String emailType,
382                    com.liferay.portal.service.ServiceContext serviceContext)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException {
385                    getService().sendEmail(order, emailType, serviceContext);
386            }
387    
388            public static com.liferay.portlet.shopping.model.ShoppingOrder updateLatestOrder(
389                    long userId, long groupId, java.lang.String billingFirstName,
390                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
391                    java.lang.String billingCompany, java.lang.String billingStreet,
392                    java.lang.String billingCity, java.lang.String billingState,
393                    java.lang.String billingZip, java.lang.String billingCountry,
394                    java.lang.String billingPhone, boolean shipToBilling,
395                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
396                    java.lang.String shippingEmailAddress,
397                    java.lang.String shippingCompany, java.lang.String shippingStreet,
398                    java.lang.String shippingCity, java.lang.String shippingState,
399                    java.lang.String shippingZip, java.lang.String shippingCountry,
400                    java.lang.String shippingPhone, java.lang.String ccName,
401                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
402                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
403                    throws com.liferay.portal.kernel.exception.PortalException,
404                            com.liferay.portal.kernel.exception.SystemException {
405                    return getService()
406                                       .updateLatestOrder(userId, groupId, billingFirstName,
407                            billingLastName, billingEmailAddress, billingCompany,
408                            billingStreet, billingCity, billingState, billingZip,
409                            billingCountry, billingPhone, shipToBilling, shippingFirstName,
410                            shippingLastName, shippingEmailAddress, shippingCompany,
411                            shippingStreet, shippingCity, shippingState, shippingZip,
412                            shippingCountry, shippingPhone, ccName, ccType, ccNumber,
413                            ccExpMonth, ccExpYear, ccVerNumber, comments);
414            }
415    
416            public static com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
417                    long orderId, java.lang.String ppTxnId,
418                    java.lang.String ppPaymentStatus, double ppPaymentGross,
419                    java.lang.String ppReceiverEmail, java.lang.String ppPayerEmail)
420                    throws com.liferay.portal.kernel.exception.PortalException,
421                            com.liferay.portal.kernel.exception.SystemException {
422                    return getService()
423                                       .updateOrder(orderId, ppTxnId, ppPaymentStatus,
424                            ppPaymentGross, ppReceiverEmail, ppPayerEmail);
425            }
426    
427            public static com.liferay.portlet.shopping.model.ShoppingOrder updateOrder(
428                    long orderId, java.lang.String billingFirstName,
429                    java.lang.String billingLastName, java.lang.String billingEmailAddress,
430                    java.lang.String billingCompany, java.lang.String billingStreet,
431                    java.lang.String billingCity, java.lang.String billingState,
432                    java.lang.String billingZip, java.lang.String billingCountry,
433                    java.lang.String billingPhone, boolean shipToBilling,
434                    java.lang.String shippingFirstName, java.lang.String shippingLastName,
435                    java.lang.String shippingEmailAddress,
436                    java.lang.String shippingCompany, java.lang.String shippingStreet,
437                    java.lang.String shippingCity, java.lang.String shippingState,
438                    java.lang.String shippingZip, java.lang.String shippingCountry,
439                    java.lang.String shippingPhone, java.lang.String ccName,
440                    java.lang.String ccType, java.lang.String ccNumber, int ccExpMonth,
441                    int ccExpYear, java.lang.String ccVerNumber, java.lang.String comments)
442                    throws com.liferay.portal.kernel.exception.PortalException,
443                            com.liferay.portal.kernel.exception.SystemException {
444                    return getService()
445                                       .updateOrder(orderId, billingFirstName, billingLastName,
446                            billingEmailAddress, billingCompany, billingStreet, billingCity,
447                            billingState, billingZip, billingCountry, billingPhone,
448                            shipToBilling, shippingFirstName, shippingLastName,
449                            shippingEmailAddress, shippingCompany, shippingStreet,
450                            shippingCity, shippingState, shippingZip, shippingCountry,
451                            shippingPhone, ccName, ccType, ccNumber, ccExpMonth, ccExpYear,
452                            ccVerNumber, comments);
453            }
454    
455            public static ShoppingOrderLocalService getService() {
456                    if (_service == null) {
457                            _service = (ShoppingOrderLocalService)PortalBeanLocatorUtil.locate(ShoppingOrderLocalService.class.getName());
458    
459                            ReferenceRegistry.registerReference(ShoppingOrderLocalServiceUtil.class,
460                                    "_service");
461                    }
462    
463                    return _service;
464            }
465    
466            /**
467             * @deprecated
468             */
469            public void setService(ShoppingOrderLocalService service) {
470            }
471    
472            private static ShoppingOrderLocalService _service;
473    }