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