com.liferay.portlet.shopping.service
Class ShoppingOrderLocalServiceUtil

java.lang.Object
  com.liferay.portlet.shopping.service.ShoppingOrderLocalServiceUtil

@ProviderType
public class ShoppingOrderLocalServiceUtil
extends Object

Provides the local service utility for ShoppingOrder. This utility wraps 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. 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.

See Also:

ShoppingOrderLocalService, com.liferay.portlet.shopping.service.base.ShoppingOrderLocalServiceBaseImpl, com.liferay.portlet.shopping.service.impl.ShoppingOrderLocalServiceImpl

Constructor Summary

ShoppingOrderLocalServiceUtil()

Method Summary

static ShoppingOrder	addLatestOrder(long userId, long groupId)
static ShoppingOrder	addShoppingOrder(ShoppingOrder shoppingOrder) Adds the shopping order to the database.
static void	completeOrder(String number, String ppTxnId, String ppPaymentStatus, double ppPaymentGross, String ppReceiverEmail, String ppPayerEmail, boolean updateInventory, ServiceContext serviceContext)
static ShoppingOrder	createShoppingOrder(long orderId) Creates a new shopping order with the primary key.
static void	deleteOrder(long orderId)
static void	deleteOrder(ShoppingOrder order)
static void	deleteOrders(long groupId)
static ShoppingOrder	deleteShoppingOrder(long orderId) Deletes the shopping order with the primary key from the database.
static ShoppingOrder	deleteShoppingOrder(ShoppingOrder shoppingOrder) Deletes the shopping order from the database.
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static ShoppingOrder	fetchShoppingOrder(long orderId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static ShoppingOrder	getLatestOrder(long userId, long groupId)
static ShoppingOrder	getOrder(long orderId)
static ShoppingOrder	getOrder(String number)
static ShoppingOrder	getPayPalTxnIdOrder(String ppTxnId)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ShoppingOrderLocalService	getService()
static ShoppingOrder	getShoppingOrder(long orderId) Returns the shopping order with the primary key.
static List<ShoppingOrder>	getShoppingOrders(int start, int end) Returns a range of all the shopping orders.
static int	getShoppingOrdersCount() Returns the number of shopping orders.
static ShoppingOrder	saveLatestOrder(ShoppingCart cart)
static List<ShoppingOrder>	search(long groupId, long companyId, long userId, String number, String billingFirstName, String billingLastName, String billingEmailAddress, String shippingFirstName, String shippingLastName, String shippingEmailAddress, String ppPaymentStatus, boolean andOperator, int start, int end)
static int	searchCount(long groupId, long companyId, long userId, String number, String billingFirstName, String billingLastName, String billingEmailAddress, String shippingFirstName, String shippingLastName, String shippingEmailAddress, String ppPaymentStatus, boolean andOperator)
static void	sendEmail(long orderId, String emailType, ServiceContext serviceContext)
static void	sendEmail(ShoppingOrder order, String emailType, ServiceContext serviceContext)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(ShoppingOrderLocalService service) Deprecated. As of 6.2.0
static ShoppingOrder	updateLatestOrder(long userId, long groupId, String billingFirstName, String billingLastName, String billingEmailAddress, String billingCompany, String billingStreet, String billingCity, String billingState, String billingZip, String billingCountry, String billingPhone, boolean shipToBilling, String shippingFirstName, String shippingLastName, String shippingEmailAddress, String shippingCompany, String shippingStreet, String shippingCity, String shippingState, String shippingZip, String shippingCountry, String shippingPhone, String ccName, String ccType, String ccNumber, int ccExpMonth, int ccExpYear, String ccVerNumber, String comments)
static ShoppingOrder	updateOrder(long orderId, String ppTxnId, String ppPaymentStatus, double ppPaymentGross, String ppReceiverEmail, String ppPayerEmail)
static ShoppingOrder	updateOrder(long orderId, String billingFirstName, String billingLastName, String billingEmailAddress, String billingCompany, String billingStreet, String billingCity, String billingState, String billingZip, String billingCountry, String billingPhone, boolean shipToBilling, String shippingFirstName, String shippingLastName, String shippingEmailAddress, String shippingCompany, String shippingStreet, String shippingCity, String shippingState, String shippingZip, String shippingCountry, String shippingPhone, String ccName, String ccType, String ccNumber, int ccExpMonth, int ccExpYear, String ccVerNumber, String comments)
static ShoppingOrder	updateShoppingOrder(ShoppingOrder shoppingOrder) Updates the shopping order in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShoppingOrderLocalServiceUtil

public ShoppingOrderLocalServiceUtil()

Method Detail

addShoppingOrder

public static ShoppingOrder addShoppingOrder(ShoppingOrder shoppingOrder)
                                      throws SystemException

Adds the shopping order to the database. Also notifies the appropriate model listeners.

Parameters:

shoppingOrder - the shopping order

Returns:

the shopping order that was added

Throws:

SystemException - if a system exception occurred

createShoppingOrder

public static ShoppingOrder createShoppingOrder(long orderId)

Creates a new shopping order with the primary key. Does not add the shopping order to the database.

Parameters:

orderId - the primary key for the new shopping order

Returns:

the new shopping order

deleteShoppingOrder

public static ShoppingOrder deleteShoppingOrder(long orderId)
                                         throws PortalException,
                                                SystemException

Deletes the shopping order with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

orderId - the primary key of the shopping order

Returns:

the shopping order that was removed

Throws:

PortalException - if a shopping order with the primary key could not be found

SystemException - if a system exception occurred

deleteShoppingOrder

public static ShoppingOrder deleteShoppingOrder(ShoppingOrder shoppingOrder)
                                         throws SystemException

Deletes the shopping order from the database. Also notifies the appropriate model listeners.

Parameters:

shoppingOrder - the shopping order

Returns:

the shopping order that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingOrderModelImpl. If both orderByComparator 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingOrderModelImpl. If both orderByComparator 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchShoppingOrder

public static ShoppingOrder fetchShoppingOrder(long orderId)
                                        throws SystemException

Throws:

SystemException

getShoppingOrder

public static ShoppingOrder getShoppingOrder(long orderId)
                                      throws PortalException,
                                             SystemException

Returns the shopping order with the primary key.

Parameters:

orderId - the primary key of the shopping order

Returns:

the shopping order

Throws:

PortalException - if a shopping order with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getShoppingOrders

public static List<ShoppingOrder> getShoppingOrders(int start,
                                                    int end)
                                             throws SystemException

Returns a range of all the shopping orders.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingOrderModelImpl. If both orderByComparator 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.

Parameters:

start - the lower bound of the range of shopping orders

end - the upper bound of the range of shopping orders (not inclusive)

Returns:

the range of shopping orders

Throws:

SystemException - if a system exception occurred

getShoppingOrdersCount

public static int getShoppingOrdersCount()
                                  throws SystemException

Returns the number of shopping orders.

Returns:

the number of shopping orders

Throws:

SystemException - if a system exception occurred

updateShoppingOrder

public static ShoppingOrder updateShoppingOrder(ShoppingOrder shoppingOrder)
                                         throws SystemException

Updates the shopping order in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

shoppingOrder - the shopping order

Returns:

the shopping order that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addLatestOrder

public static ShoppingOrder addLatestOrder(long userId,
                                           long groupId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

completeOrder

public static void completeOrder(String number,
                                 String ppTxnId,
                                 String ppPaymentStatus,
                                 double ppPaymentGross,
                                 String ppReceiverEmail,
                                 String ppPayerEmail,
                                 boolean updateInventory,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deleteOrder

public static void deleteOrder(long orderId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteOrder

public static void deleteOrder(ShoppingOrder order)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteOrders

public static void deleteOrders(long groupId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getLatestOrder

public static ShoppingOrder getLatestOrder(long userId,
                                           long groupId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getOrder

public static ShoppingOrder getOrder(long orderId)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getOrder

public static ShoppingOrder getOrder(String number)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getPayPalTxnIdOrder

public static ShoppingOrder getPayPalTxnIdOrder(String ppTxnId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

saveLatestOrder

public static ShoppingOrder saveLatestOrder(ShoppingCart cart)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

search

public static List<ShoppingOrder> search(long groupId,
                                         long companyId,
                                         long userId,
                                         String number,
                                         String billingFirstName,
                                         String billingLastName,
                                         String billingEmailAddress,
                                         String shippingFirstName,
                                         String shippingLastName,
                                         String shippingEmailAddress,
                                         String ppPaymentStatus,
                                         boolean andOperator,
                                         int start,
                                         int end)
                                  throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(long groupId,
                              long companyId,
                              long userId,
                              String number,
                              String billingFirstName,
                              String billingLastName,
                              String billingEmailAddress,
                              String shippingFirstName,
                              String shippingLastName,
                              String shippingEmailAddress,
                              String ppPaymentStatus,
                              boolean andOperator)
                       throws SystemException

Throws:

SystemException

sendEmail

public static void sendEmail(long orderId,
                             String emailType,
                             ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

sendEmail

public static void sendEmail(ShoppingOrder order,
                             String emailType,
                             ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

updateLatestOrder

public static ShoppingOrder updateLatestOrder(long userId,
                                              long groupId,
                                              String billingFirstName,
                                              String billingLastName,
                                              String billingEmailAddress,
                                              String billingCompany,
                                              String billingStreet,
                                              String billingCity,
                                              String billingState,
                                              String billingZip,
                                              String billingCountry,
                                              String billingPhone,
                                              boolean shipToBilling,
                                              String shippingFirstName,
                                              String shippingLastName,
                                              String shippingEmailAddress,
                                              String shippingCompany,
                                              String shippingStreet,
                                              String shippingCity,
                                              String shippingState,
                                              String shippingZip,
                                              String shippingCountry,
                                              String shippingPhone,
                                              String ccName,
                                              String ccType,
                                              String ccNumber,
                                              int ccExpMonth,
                                              int ccExpYear,
                                              String ccVerNumber,
                                              String comments)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

updateOrder

public static ShoppingOrder updateOrder(long orderId,
                                        String ppTxnId,
                                        String ppPaymentStatus,
                                        double ppPaymentGross,
                                        String ppReceiverEmail,
                                        String ppPayerEmail)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

updateOrder

public static ShoppingOrder updateOrder(long orderId,
                                        String billingFirstName,
                                        String billingLastName,
                                        String billingEmailAddress,
                                        String billingCompany,
                                        String billingStreet,
                                        String billingCity,
                                        String billingState,
                                        String billingZip,
                                        String billingCountry,
                                        String billingPhone,
                                        boolean shipToBilling,
                                        String shippingFirstName,
                                        String shippingLastName,
                                        String shippingEmailAddress,
                                        String shippingCompany,
                                        String shippingStreet,
                                        String shippingCity,
                                        String shippingState,
                                        String shippingZip,
                                        String shippingCountry,
                                        String shippingPhone,
                                        String ccName,
                                        String ccType,
                                        String ccNumber,
                                        int ccExpMonth,
                                        int ccExpYear,
                                        String ccVerNumber,
                                        String comments)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getService

public static ShoppingOrderLocalService getService()

setService

public void setService(ShoppingOrderLocalService service)

Deprecated. As of 6.2.0