com.liferay.shopping.service

Interface ShoppingCartLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

ShoppingCartLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface ShoppingCartLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for ShoppingCart. 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:

ShoppingCartLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
ShoppingCart	addShoppingCart(ShoppingCart shoppingCart) Adds the shopping cart to the database.
ShoppingCart	createShoppingCart(long cartId) Creates a new shopping cart with the primary key.
void	deleteGroupCarts(long groupId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
ShoppingCart	deleteShoppingCart(long cartId) Deletes the shopping cart with the primary key from the database.
ShoppingCart	deleteShoppingCart(ShoppingCart shoppingCart) Deletes the shopping cart from the database.
void	deleteUserCarts(long userId)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<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.
<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.
<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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
ShoppingCart	fetchShoppingCart(long cartId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
ShoppingCart	getCart(long userId, long groupId)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.util.Map<ShoppingCartItem,java.lang.Integer>	getItems(long groupId, java.lang.String itemIds)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
ShoppingCart	getShoppingCart(long cartId) Returns the shopping cart with the primary key.
java.util.List<ShoppingCart>	getShoppingCarts(int start, int end) Returns a range of all the shopping carts.
int	getShoppingCartsCount() Returns the number of shopping carts.
ShoppingCart	updateCart(long userId, long groupId, java.lang.String itemIds, java.lang.String couponCodes, int altShipping, boolean insure)
ShoppingCart	updateShoppingCart(ShoppingCart shoppingCart) Updates the shopping cart in the database or adds it if it does not yet exist.

Method Detail

addShoppingCart

@Indexable(type=REINDEX)
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

@Transactional(enabled=false)
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

void deleteGroupCarts(long groupId)

deletePersistedModel

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

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteShoppingCart

@Indexable(type=DELETE)
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:

com.liferay.portal.kernel.exception.PortalException - if a shopping cart with the primary key could not be found

deleteShoppingCart

@Indexable(type=DELETE)
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

void deleteUserCarts(long userId)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCart fetchShoppingCart(long cartId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCart

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCart getCart(long userId,
                                                                                        long groupId)
                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.Map<ShoppingCartItem,java.lang.Integer> getItems(long groupId,
                                                                                                                              java.lang.String itemIds)

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getShoppingCart

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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:

com.liferay.portal.kernel.exception.PortalException - if a shopping cart with the primary key could not be found

getShoppingCarts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getShoppingCartsCount()

Returns the number of shopping carts.

Returns:

the number of shopping carts

updateCart

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

@Indexable(type=REINDEX)
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