com.liferay.portlet.shopping.service
Interface ShoppingItemLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ShoppingItemLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ShoppingItemLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the shopping item local service.

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:

ShoppingItemLocalServiceUtil, com.liferay.portlet.shopping.service.base.ShoppingItemLocalServiceBaseImpl, com.liferay.portlet.shopping.service.impl.ShoppingItemLocalServiceImpl

Method Summary

void	addBookItems(long userId, long groupId, long categoryId, String[] isbns)
ShoppingItem	addItem(long userId, long groupId, long categoryId, String sku, String name, String description, String properties, String fieldsQuantities, boolean requiresShipping, int stockQuantity, boolean featured, Boolean sale, boolean smallImage, String smallImageURL, File smallImageFile, boolean mediumImage, String mediumImageURL, File mediumImageFile, boolean largeImage, String largeImageURL, File largeImageFile, List<ShoppingItemField> itemFields, List<ShoppingItemPrice> itemPrices, ServiceContext serviceContext)
void	addItemResources(long itemId, boolean addGroupPermissions, boolean addGuestPermissions)
void	addItemResources(long itemId, String[] groupPermissions, String[] guestPermissions)
void	addItemResources(ShoppingItem item, boolean addGroupPermissions, boolean addGuestPermissions)
void	addItemResources(ShoppingItem item, String[] groupPermissions, String[] guestPermissions)
ShoppingItem	addShoppingItem(ShoppingItem shoppingItem) Adds the shopping item to the database.
ShoppingItem	createShoppingItem(long itemId) Creates a new shopping item with the primary key.
void	deleteItem(long itemId)
void	deleteItem(ShoppingItem item)
void	deleteItems(long groupId, long categoryId)
ShoppingItem	deleteShoppingItem(long itemId) Deletes the shopping item with the primary key from the database.
ShoppingItem	deleteShoppingItem(ShoppingItem shoppingItem) Deletes the shopping item from the database.
DynamicQuery	dynamicQuery()
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) Returns the number of rows that match the dynamic query.
ShoppingItem	fetchShoppingItem(long itemId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
int	getCategoriesItemsCount(long groupId, List<Long> categoryIds)
List<ShoppingItem>	getFeaturedItems(long groupId, long categoryId, int numOfItems)
ShoppingItem	getItem(long itemId)
ShoppingItem	getItem(long companyId, String sku)
ShoppingItem	getItemByLargeImageId(long largeImageId)
ShoppingItem	getItemByMediumImageId(long mediumImageId)
ShoppingItem	getItemBySmallImageId(long smallImageId)
List<ShoppingItem>	getItems(long groupId, long categoryId)
List<ShoppingItem>	getItems(long groupId, long categoryId, int start, int end, OrderByComparator obc)
int	getItemsCount(long groupId, long categoryId)
ShoppingItem[]	getItemsPrevAndNext(long itemId, OrderByComparator obc)
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<ShoppingItem>	getSaleItems(long groupId, long categoryId, int numOfItems)
ShoppingItem	getShoppingItem(long itemId) Returns the shopping item with the primary key.
List<ShoppingItem>	getShoppingItems(int start, int end) Returns a range of all the shopping items.
int	getShoppingItemsCount() Returns the number of shopping items.
List<ShoppingItem>	search(long groupId, long[] categoryIds, String keywords, int start, int end)
int	searchCount(long groupId, long[] categoryIds, String keywords)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
ShoppingItem	updateItem(long userId, long itemId, long groupId, long categoryId, String sku, String name, String description, String properties, String fieldsQuantities, boolean requiresShipping, int stockQuantity, boolean featured, Boolean sale, boolean smallImage, String smallImageURL, File smallImageFile, boolean mediumImage, String mediumImageURL, File mediumImageFile, boolean largeImage, String largeImageURL, File largeImageFile, List<ShoppingItemField> itemFields, List<ShoppingItemPrice> itemPrices, ServiceContext serviceContext)
ShoppingItem	updateShoppingItem(ShoppingItem shoppingItem) Updates the shopping item in the database or adds it if it does not yet exist.
ShoppingItem	updateShoppingItem(ShoppingItem shoppingItem, boolean merge) Updates the shopping item in the database or adds it if it does not yet exist.

Method Detail

addShoppingItem

ShoppingItem addShoppingItem(ShoppingItem shoppingItem)
                             throws SystemException

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

Parameters:

shoppingItem - the shopping item

Returns:

the shopping item that was added

Throws:

SystemException - if a system exception occurred

createShoppingItem

ShoppingItem createShoppingItem(long itemId)

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

Parameters:

itemId - the primary key for the new shopping item

Returns:

the new shopping item

deleteShoppingItem

ShoppingItem deleteShoppingItem(long itemId)
                                throws PortalException,
                                       SystemException

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

Parameters:

itemId - the primary key of the shopping item

Returns:

the shopping item that was removed

Throws:

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

SystemException - if a system exception occurred

deleteShoppingItem

ShoppingItem deleteShoppingItem(ShoppingItem shoppingItem)
                                throws SystemException

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

Parameters:

shoppingItem - the shopping item

Returns:

the shopping item that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

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

fetchShoppingItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingItem fetchShoppingItem(long itemId)
                               throws SystemException

Throws:

SystemException

getShoppingItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingItem getShoppingItem(long itemId)
                             throws PortalException,
                                    SystemException

Returns the shopping item with the primary key.

Parameters:

itemId - the primary key of the shopping item

Returns:

the shopping item

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getShoppingItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingItem> getShoppingItems(int start,
                                                                             int end)
                                    throws SystemException

Returns a range of all the shopping items.

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 items

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

Returns:

the range of shopping items

Throws:

SystemException - if a system exception occurred

getShoppingItemsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getShoppingItemsCount()
                          throws SystemException

Returns the number of shopping items.

Returns:

the number of shopping items

Throws:

SystemException - if a system exception occurred

updateShoppingItem

ShoppingItem updateShoppingItem(ShoppingItem shoppingItem)
                                throws SystemException

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

Parameters:

shoppingItem - the shopping item

Returns:

the shopping item that was updated

Throws:

SystemException - if a system exception occurred

updateShoppingItem

ShoppingItem updateShoppingItem(ShoppingItem shoppingItem,
                                boolean merge)
                                throws SystemException

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

Parameters:

shoppingItem - the shopping item

merge - whether to merge the shopping item 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 item that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addBookItems

void addBookItems(long userId,
                  long groupId,
                  long categoryId,
                  String[] isbns)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

addItem

ShoppingItem addItem(long userId,
                     long groupId,
                     long categoryId,
                     String sku,
                     String name,
                     String description,
                     String properties,
                     String fieldsQuantities,
                     boolean requiresShipping,
                     int stockQuantity,
                     boolean featured,
                     Boolean sale,
                     boolean smallImage,
                     String smallImageURL,
                     File smallImageFile,
                     boolean mediumImage,
                     String mediumImageURL,
                     File mediumImageFile,
                     boolean largeImage,
                     String largeImageURL,
                     File largeImageFile,
                     List<ShoppingItemField> itemFields,
                     List<ShoppingItemPrice> itemPrices,
                     ServiceContext serviceContext)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

addItemResources

void addItemResources(long itemId,
                      boolean addGroupPermissions,
                      boolean addGuestPermissions)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

addItemResources

void addItemResources(long itemId,
                      String[] groupPermissions,
                      String[] guestPermissions)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

addItemResources

void addItemResources(ShoppingItem item,
                      boolean addGroupPermissions,
                      boolean addGuestPermissions)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

addItemResources

void addItemResources(ShoppingItem item,
                      String[] groupPermissions,
                      String[] guestPermissions)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

deleteItem

void deleteItem(long itemId)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

deleteItem

void deleteItem(ShoppingItem item)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

deleteItems

void deleteItems(long groupId,
                 long categoryId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

getCategoriesItemsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCategoriesItemsCount(long groupId,
                                                                     List<Long> categoryIds)
                            throws SystemException

Throws:

SystemException

getFeaturedItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingItem> getFeaturedItems(long groupId,
                                                                             long categoryId,
                                                                             int numOfItems)
                                    throws SystemException

Throws:

SystemException

getItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingItem getItem(long itemId)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingItem getItem(long companyId,
                                                              String sku)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getItemByLargeImageId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingItem getItemByLargeImageId(long largeImageId)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getItemByMediumImageId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingItem getItemByMediumImageId(long mediumImageId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getItemBySmallImageId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingItem getItemBySmallImageId(long smallImageId)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingItem> getItems(long groupId,
                                                                     long categoryId)
                            throws SystemException

Throws:

SystemException

getItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingItem> getItems(long groupId,
                                                                     long categoryId,
                                                                     int start,
                                                                     int end,
                                                                     OrderByComparator obc)
                            throws SystemException

Throws:

SystemException

getItemsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getItemsCount(long groupId,
                                                           long categoryId)
                  throws SystemException

Throws:

SystemException

getItemsPrevAndNext

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingItem[] getItemsPrevAndNext(long itemId,
                                                                            OrderByComparator obc)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getSaleItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingItem> getSaleItems(long groupId,
                                                                         long categoryId,
                                                                         int numOfItems)
                                throws SystemException

Throws:

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingItem> search(long groupId,
                                                                   long[] categoryIds,
                                                                   String keywords,
                                                                   int start,
                                                                   int end)
                          throws SystemException

Throws:

SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long groupId,
                                                         long[] categoryIds,
                                                         String keywords)
                throws SystemException

Throws:

SystemException

updateItem

ShoppingItem updateItem(long userId,
                        long itemId,
                        long groupId,
                        long categoryId,
                        String sku,
                        String name,
                        String description,
                        String properties,
                        String fieldsQuantities,
                        boolean requiresShipping,
                        int stockQuantity,
                        boolean featured,
                        Boolean sale,
                        boolean smallImage,
                        String smallImageURL,
                        File smallImageFile,
                        boolean mediumImage,
                        String mediumImageURL,
                        File mediumImageFile,
                        boolean largeImage,
                        String largeImageURL,
                        File largeImageFile,
                        List<ShoppingItemField> itemFields,
                        List<ShoppingItemPrice> itemPrices,
                        ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException