com.liferay.shopping.service

Class ShoppingCartLocalServiceUtil

java.lang.Object

com.liferay.shopping.service.ShoppingCartLocalServiceUtil

@ProviderType
public class ShoppingCartLocalServiceUtil
extends java.lang.Object

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

ShoppingCartLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
ShoppingCartLocalServiceUtil()

Method Summary

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 com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
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 com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static ShoppingCart	fetchShoppingCart(long cartId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static ShoppingCart	getCart(long userId, long groupId)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.util.Map<ShoppingCartItem,java.lang.Integer>	getItems(long groupId, java.lang.String itemIds)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.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 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)

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

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

deleteGroupCarts

public static void deleteGroupCarts(long groupId)

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

deleteShoppingCart

public static ShoppingCart deleteShoppingCart(long cartId)
                                       throws com.liferay.portal.kernel.exception.PortalException

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

deleteShoppingCart

public static ShoppingCart deleteShoppingCart(ShoppingCart shoppingCart)

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

deleteUserCarts

public static void deleteUserCarts(long userId)

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.shopping.model.impl.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

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.shopping.model.impl.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

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchShoppingCart

public static ShoppingCart fetchShoppingCart(long cartId)

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCart

public static ShoppingCart getCart(long userId,
                                   long groupId)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getItems

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

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getShoppingCart

public static ShoppingCart getShoppingCart(long cartId)
                                    throws com.liferay.portal.kernel.exception.PortalException

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

getShoppingCarts

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

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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.shopping.model.impl.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

getShoppingCartsCount

public static int getShoppingCartsCount()

Returns the number of shopping carts.

Returns:

the number of shopping carts

updateCart

public static ShoppingCart updateCart(long userId,
                                      long groupId,
                                      java.lang.String itemIds,
                                      java.lang.String couponCodes,
                                      int altShipping,
                                      boolean insure)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateShoppingCart

public static ShoppingCart updateShoppingCart(ShoppingCart shoppingCart)

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

getService

public static ShoppingCartLocalService getService()