Liferay 6.0.5

com.liferay.portlet.shopping.service
Class ShoppingItemLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.shopping.service.ShoppingItemLocalServiceUtil

public class ShoppingItemLocalServiceUtil
extends Object

The utility for the shopping item local service. This utility wraps ShoppingItemLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to ShoppingItemLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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:
ShoppingItemLocalService, ShoppingItemLocalServiceBaseImpl, ShoppingItemLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
ShoppingItemLocalServiceUtil()
           
 
Method Summary
static void addBookItems(long userId, long groupId, long categoryId, String[] isbns)
           
static 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 smallFile, boolean mediumImage, String mediumImageURL, File mediumFile, boolean largeImage, String largeImageURL, File largeFile, List<ShoppingItemField> itemFields, List<ShoppingItemPrice> itemPrices, ServiceContext serviceContext)
           
static void addItemResources(long itemId, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static void addItemResources(long itemId, String[] communityPermissions, String[] guestPermissions)
           
static void addItemResources(ShoppingItem item, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static void addItemResources(ShoppingItem item, String[] communityPermissions, String[] guestPermissions)
           
static ShoppingItem addShoppingItem(ShoppingItem shoppingItem)
          Adds the shopping item to the database.
static ShoppingItem createShoppingItem(long itemId)
          Creates a new shopping item with the primary key.
static void deleteItem(long itemId)
           
static void deleteItem(ShoppingItem item)
           
static void deleteItems(long groupId, long categoryId)
           
static void deleteShoppingItem(long itemId)
          Deletes the shopping item with the primary key from the database.
static void deleteShoppingItem(ShoppingItem shoppingItem)
          Deletes the shopping item from the database.
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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)
          Counts the number of rows that match the dynamic query.
static int getCategoriesItemsCount(long groupId, List<Long> categoryIds)
           
static List<ShoppingItem> getFeaturedItems(long groupId, long categoryId, int numOfItems)
           
static ShoppingItem getItem(long itemId)
           
static ShoppingItem getItem(long companyId, String sku)
           
static ShoppingItem getItemByLargeImageId(long largeImageId)
           
static ShoppingItem getItemByMediumImageId(long mediumImageId)
           
static ShoppingItem getItemBySmallImageId(long smallImageId)
           
static List<ShoppingItem> getItems(long groupId, long categoryId)
           
static List<ShoppingItem> getItems(long groupId, long categoryId, int start, int end, OrderByComparator obc)
           
static int getItemsCount(long groupId, long categoryId)
           
static ShoppingItem[] getItemsPrevAndNext(long itemId, OrderByComparator obc)
           
static List<ShoppingItem> getSaleItems(long groupId, long categoryId, int numOfItems)
           
static ShoppingItemLocalService getService()
           
static ShoppingItem getShoppingItem(long itemId)
          Gets the shopping item with the primary key.
static List<ShoppingItem> getShoppingItems(int start, int end)
          Gets a range of all the shopping items.
static int getShoppingItemsCount()
          Gets the number of shopping items.
static List<ShoppingItem> search(long groupId, long[] categoryIds, String keywords, int start, int end)
           
static int searchCount(long groupId, long[] categoryIds, String keywords)
           
 void setService(ShoppingItemLocalService service)
           
static 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 smallFile, boolean mediumImage, String mediumImageURL, File mediumFile, boolean largeImage, String largeImageURL, File largeFile, List<ShoppingItemField> itemFields, List<ShoppingItemPrice> itemPrices, ServiceContext serviceContext)
           
static ShoppingItem updateShoppingItem(ShoppingItem shoppingItem)
          Updates the shopping item in the database.
static ShoppingItem updateShoppingItem(ShoppingItem shoppingItem, boolean merge)
          Updates the shopping item in the database.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ShoppingItemLocalServiceUtil

public ShoppingItemLocalServiceUtil()
Method Detail

addShoppingItem

public static ShoppingItem addShoppingItem(ShoppingItem shoppingItem)
                                    throws SystemException
Adds the shopping item to the database. Also notifies the appropriate model listeners.

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

createShoppingItem

public static 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

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

deleteShoppingItem

public static void deleteShoppingItem(ShoppingItem shoppingItem)
                               throws SystemException
Deletes the shopping item from the database. Also notifies the appropriate model listeners.

Parameters:
shoppingItem - the shopping item to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static 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

public static 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

public static 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

public static 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

getShoppingItem

public static ShoppingItem getShoppingItem(long itemId)
                                    throws PortalException,
                                           SystemException
Gets the shopping item with the primary key.

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

getShoppingItems

public static List<ShoppingItem> getShoppingItems(int start,
                                                  int end)
                                           throws SystemException
Gets 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 to return
end - the upper bound of the range of shopping items to return (not inclusive)
Returns:
the range of shopping items
Throws:
SystemException - if a system exception occurred

getShoppingItemsCount

public static int getShoppingItemsCount()
                                 throws SystemException
Gets the number of shopping items.

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

updateShoppingItem

public static ShoppingItem updateShoppingItem(ShoppingItem shoppingItem)
                                       throws SystemException
Updates the shopping item in the database. Also notifies the appropriate model listeners.

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

updateShoppingItem

public static ShoppingItem updateShoppingItem(ShoppingItem shoppingItem,
                                              boolean merge)
                                       throws SystemException
Updates the shopping item in the database. Also notifies the appropriate model listeners.

Parameters:
shoppingItem - the shopping item to update
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

addBookItems

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

addItem

public static 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 smallFile,
                                   boolean mediumImage,
                                   String mediumImageURL,
                                   File mediumFile,
                                   boolean largeImage,
                                   String largeImageURL,
                                   File largeFile,
                                   List<ShoppingItemField> itemFields,
                                   List<ShoppingItemPrice> itemPrices,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

addItemResources

public static void addItemResources(long itemId,
                                    boolean addCommunityPermissions,
                                    boolean addGuestPermissions)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

addItemResources

public static void addItemResources(long itemId,
                                    String[] communityPermissions,
                                    String[] guestPermissions)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

addItemResources

public static void addItemResources(ShoppingItem item,
                                    boolean addCommunityPermissions,
                                    boolean addGuestPermissions)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

addItemResources

public static void addItemResources(ShoppingItem item,
                                    String[] communityPermissions,
                                    String[] guestPermissions)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

deleteItem

public static void deleteItem(long itemId)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

deleteItem

public static void deleteItem(ShoppingItem item)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

deleteItems

public static void deleteItems(long groupId,
                               long categoryId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getCategoriesItemsCount

public static int getCategoriesItemsCount(long groupId,
                                          List<Long> categoryIds)
                                   throws SystemException
Throws:
SystemException

getFeaturedItems

public static List<ShoppingItem> getFeaturedItems(long groupId,
                                                  long categoryId,
                                                  int numOfItems)
                                           throws SystemException
Throws:
SystemException

getItem

public static ShoppingItem getItem(long itemId)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getItem

public static ShoppingItem getItem(long companyId,
                                   String sku)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getItemByLargeImageId

public static ShoppingItem getItemByLargeImageId(long largeImageId)
                                          throws PortalException,
                                                 SystemException
Throws:
PortalException
SystemException

getItemByMediumImageId

public static ShoppingItem getItemByMediumImageId(long mediumImageId)
                                           throws PortalException,
                                                  SystemException
Throws:
PortalException
SystemException

getItemBySmallImageId

public static ShoppingItem getItemBySmallImageId(long smallImageId)
                                          throws PortalException,
                                                 SystemException
Throws:
PortalException
SystemException

getItems

public static List<ShoppingItem> getItems(long groupId,
                                          long categoryId)
                                   throws SystemException
Throws:
SystemException

getItems

public static List<ShoppingItem> getItems(long groupId,
                                          long categoryId,
                                          int start,
                                          int end,
                                          OrderByComparator obc)
                                   throws SystemException
Throws:
SystemException

getItemsCount

public static int getItemsCount(long groupId,
                                long categoryId)
                         throws SystemException
Throws:
SystemException

getItemsPrevAndNext

public static ShoppingItem[] getItemsPrevAndNext(long itemId,
                                                 OrderByComparator obc)
                                          throws PortalException,
                                                 SystemException
Throws:
PortalException
SystemException

getSaleItems

public static List<ShoppingItem> getSaleItems(long groupId,
                                              long categoryId,
                                              int numOfItems)
                                       throws SystemException
Throws:
SystemException

search

public static List<ShoppingItem> search(long groupId,
                                        long[] categoryIds,
                                        String keywords,
                                        int start,
                                        int end)
                                 throws SystemException
Throws:
SystemException

searchCount

public static int searchCount(long groupId,
                              long[] categoryIds,
                              String keywords)
                       throws SystemException
Throws:
SystemException

updateItem

public static 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 smallFile,
                                      boolean mediumImage,
                                      String mediumImageURL,
                                      File mediumFile,
                                      boolean largeImage,
                                      String largeImageURL,
                                      File largeFile,
                                      List<ShoppingItemField> itemFields,
                                      List<ShoppingItemPrice> itemPrices,
                                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

getService

public static ShoppingItemLocalService getService()

setService

public void setService(ShoppingItemLocalService service)

Liferay 6.0.5