Liferay 6.0.5

com.liferay.portlet.shopping.service
Interface ShoppingCartLocalService

All Known Implementing Classes:
ShoppingCartLocalServiceBaseImpl, ShoppingCartLocalServiceImpl, ShoppingCartLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ShoppingCartLocalService

The interface for the shopping cart local service.

Never modify or reference this interface directly. Always use ShoppingCartLocalServiceUtil to access the shopping cart local service. Add custom service methods to ShoppingCartLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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, ShoppingCartLocalServiceBaseImpl, ShoppingCartLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 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)
           
 void deleteShoppingCart(long cartId)
          Deletes the shopping cart with the primary key from the database.
 void deleteShoppingCart(ShoppingCart shoppingCart)
          Deletes the shopping cart from the database.
 void deleteUserCarts(long userId)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 ShoppingCart getCart(long userId, long groupId)
           
 Map<ShoppingCartItem,Integer> getItems(long groupId, String itemIds)
           
 ShoppingCart getShoppingCart(long cartId)
          Gets the shopping cart with the primary key.
 List<ShoppingCart> getShoppingCarts(int start, int end)
          Gets a range of all the shopping carts.
 int getShoppingCartsCount()
          Gets the number of shopping carts.
 ShoppingCart updateCart(long userId, long groupId, String itemIds, String couponCodes, int altShipping, boolean insure)
           
 ShoppingCart updateShoppingCart(ShoppingCart shoppingCart)
          Updates the shopping cart in the database.
 ShoppingCart updateShoppingCart(ShoppingCart shoppingCart, boolean merge)
          Updates the shopping cart in the database.
 

Method Detail

addShoppingCart

ShoppingCart addShoppingCart(ShoppingCart shoppingCart)
                             throws SystemException
Adds the shopping cart to the database. Also notifies the appropriate model listeners.

Parameters:
shoppingCart - the shopping cart to add
Returns:
the shopping cart that was added
Throws:
SystemException - if a system exception occurred

createShoppingCart

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

void 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 to delete
Throws:
PortalException - if a shopping cart with the primary key could not be found
SystemException - if a system exception occurred

deleteShoppingCart

void deleteShoppingCart(ShoppingCart shoppingCart)
                        throws SystemException
Deletes the shopping cart from the database. Also notifies the appropriate model listeners.

Parameters:
shoppingCart - the shopping cart to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getShoppingCart

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCart getShoppingCart(long cartId)
                             throws PortalException,
                                    SystemException
Gets the shopping cart with the primary key.

Parameters:
cartId - the primary key of the shopping cart to get
Returns:
the shopping cart
Throws:
PortalException - if a shopping cart with the primary key could not be found
SystemException - if a system exception occurred

getShoppingCarts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCart> getShoppingCarts(int start,
                                                                             int end)
                                    throws SystemException
Gets 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.

Parameters:
start - the lower bound of the range of shopping carts to return
end - the upper bound of the range of shopping carts to return (not inclusive)
Returns:
the range of shopping carts
Throws:
SystemException - if a system exception occurred

getShoppingCartsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getShoppingCartsCount()
                          throws SystemException
Gets the number of shopping carts.

Returns:
the number of shopping carts
Throws:
SystemException - if a system exception occurred

updateShoppingCart

ShoppingCart updateShoppingCart(ShoppingCart shoppingCart)
                                throws SystemException
Updates the shopping cart in the database. Also notifies the appropriate model listeners.

Parameters:
shoppingCart - the shopping cart to update
Returns:
the shopping cart that was updated
Throws:
SystemException - if a system exception occurred

updateShoppingCart

ShoppingCart updateShoppingCart(ShoppingCart shoppingCart,
                                boolean merge)
                                throws SystemException
Updates the shopping cart in the database. Also notifies the appropriate model listeners.

Parameters:
shoppingCart - the shopping cart to update
merge - whether to merge the shopping cart with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the shopping cart that was updated
Throws:
SystemException - if a system exception occurred

deleteGroupCarts

void deleteGroupCarts(long groupId)
                      throws SystemException
Throws:
SystemException

deleteUserCarts

void deleteUserCarts(long userId)
                     throws SystemException
Throws:
SystemException

getCart

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCart getCart(long userId,
                                                              long groupId)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

getItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<ShoppingCartItem,Integer> getItems(long groupId,
                                                                                String itemIds)
                                       throws SystemException
Throws:
SystemException

updateCart

ShoppingCart updateCart(long userId,
                        long groupId,
                        String itemIds,
                        String couponCodes,
                        int altShipping,
                        boolean insure)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5