com.liferay.portlet.shopping.service

Class ShoppingCartLocalServiceUtil

java.lang.Object

com.liferay.portlet.shopping.service.ShoppingCartLocalServiceUtil

@ProviderType
public class ShoppingCartLocalServiceUtil
extends java.lang.Object

Provides the local service utility for ShoppingCart. This utility wraps com.liferay.portlet.shopping.service.impl.ShoppingCartLocalServiceImpl 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.

Author:

Brian Wing Shun Chan

See Also:

ShoppingCartLocalService, com.liferay.portlet.shopping.service.base.ShoppingCartLocalServiceBaseImpl, com.liferay.portlet.shopping.service.impl.ShoppingCartLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
ShoppingCartLocalServiceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static ShoppingCart	addShoppingCart(ShoppingCart shoppingCart) Adds the shopping cart to the database.
static ShoppingCart	createShoppingCart(long cartId) Creates a new shopping cart with the primary key.
static void	deleteGroupCarts(long groupId)
static ShoppingCart	deleteShoppingCart(long cartId) Deletes the shopping cart with the primary key from the database.
static ShoppingCart	deleteShoppingCart(ShoppingCart shoppingCart) Deletes the shopping cart from the database.
static void	deleteUserCarts(long userId)
static DynamicQuery	dynamicQuery()
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static java.util.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 ShoppingCart	fetchShoppingCart(long cartId)
static java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static ShoppingCart	getCart(long userId, long groupId)
static java.util.Map<ShoppingCartItem,java.lang.Integer>	getItems(long groupId, java.lang.String itemIds)
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static ShoppingCartLocalService	getService()
static ShoppingCart	getShoppingCart(long cartId) Returns the shopping cart with the primary key.
static java.util.List<ShoppingCart>	getShoppingCarts(int start, int end) Returns a range of all the shopping carts.
static int	getShoppingCartsCount() Returns the number of shopping carts.
static void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(ShoppingCartLocalService service) Deprecated. As of 6.2.0
static ShoppingCart	updateCart(long userId, long groupId, java.lang.String itemIds, java.lang.String couponCodes, int altShipping, boolean insure)
static ShoppingCart	updateShoppingCart(ShoppingCart shoppingCart) Updates the shopping cart 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

ShoppingCartLocalServiceUtil

public ShoppingCartLocalServiceUtil()

Method Detail

addShoppingCart

public static ShoppingCart addShoppingCart(ShoppingCart shoppingCart)
                                    throws SystemException

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

Parameters:

shoppingCart - the shopping cart

Returns:

the shopping cart that was added

Throws:

SystemException - if a system exception occurred

createShoppingCart

public static ShoppingCart createShoppingCart(long cartId)

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

Parameters:

cartId - the primary key for the new shopping cart

Returns:

the new shopping cart

deleteShoppingCart

public static ShoppingCart deleteShoppingCart(long cartId)
                                       throws PortalException,
                                              SystemException

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

Parameters:

cartId - the primary key of the shopping cart

Returns:

the shopping cart that was removed

Throws:

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

SystemException - if a system exception occurred

deleteShoppingCart

public static ShoppingCart deleteShoppingCart(ShoppingCart shoppingCart)
                                       throws SystemException

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

Parameters:

shoppingCart - the shopping cart

Returns:

the shopping cart that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static java.util.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 java.util.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 ShoppingCartModelImpl. 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 java.util.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 ShoppingCartModelImpl. 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

fetchShoppingCart

public static ShoppingCart fetchShoppingCart(long cartId)
                                      throws SystemException

Throws:

SystemException

getShoppingCart

public static ShoppingCart getShoppingCart(long cartId)
                                    throws PortalException,
                                           SystemException

Returns the shopping cart with the primary key.

Parameters:

cartId - the primary key of the shopping cart

Returns:

the shopping cart

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

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

Throws:

PortalException

SystemException

getShoppingCarts

public static java.util.List<ShoppingCart> getShoppingCarts(int start,
                                            int end)
                                                     throws SystemException

Returns a range of all the shopping carts.

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 ShoppingCartModelImpl. 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 carts

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

Returns:

the range of shopping carts

Throws:

SystemException - if a system exception occurred

getShoppingCartsCount

public static int getShoppingCartsCount()
                                 throws SystemException

Returns the number of shopping carts.

Returns:

the number of shopping carts

Throws:

SystemException - if a system exception occurred

updateShoppingCart

public static ShoppingCart updateShoppingCart(ShoppingCart shoppingCart)
                                       throws SystemException

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

Parameters:

shoppingCart - the shopping cart

Returns:

the shopping cart that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

deleteGroupCarts

public static void deleteGroupCarts(long groupId)
                             throws SystemException

Throws:

SystemException

deleteUserCarts

public static void deleteUserCarts(long userId)
                            throws SystemException

Throws:

SystemException

getCart

public static ShoppingCart getCart(long userId,
                   long groupId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getItems

public static java.util.Map<ShoppingCartItem,java.lang.Integer> getItems(long groupId,
                                                         java.lang.String itemIds)
                                                                  throws SystemException

Throws:

SystemException

updateCart

public static ShoppingCart updateCart(long userId,
                      long groupId,
                      java.lang.String itemIds,
                      java.lang.String couponCodes,
                      int altShipping,
                      boolean insure)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getService

public static ShoppingCartLocalService getService()

setService

public void setService(ShoppingCartLocalService service)

Deprecated. As of 6.2.0