com.liferay.portlet.shopping.service
Class ShoppingCouponLocalServiceUtil

java.lang.Object
  com.liferay.portlet.shopping.service.ShoppingCouponLocalServiceUtil

@ProviderType
public class ShoppingCouponLocalServiceUtil
extends Object

Provides the local service utility for ShoppingCoupon. This utility wraps com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl and is the primary 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:

ShoppingCouponLocalService, com.liferay.portlet.shopping.service.base.ShoppingCouponLocalServiceBaseImpl, com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl

Constructor Summary

ShoppingCouponLocalServiceUtil()

Method Summary

static ShoppingCoupon	addCoupon(long userId, String code, boolean autoCode, String name, String description, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int endDateMonth, int endDateDay, int endDateYear, int endDateHour, int endDateMinute, boolean neverExpire, boolean active, String limitCategories, String limitSkus, double minOrder, double discount, String discountType, ServiceContext serviceContext)
static ShoppingCoupon	addShoppingCoupon(ShoppingCoupon shoppingCoupon) Adds the shopping coupon to the database.
static ShoppingCoupon	createShoppingCoupon(long couponId) Creates a new shopping coupon with the primary key.
static void	deleteCoupon(long couponId)
static void	deleteCoupon(ShoppingCoupon coupon)
static void	deleteCoupons(long groupId)
static ShoppingCoupon	deleteShoppingCoupon(long couponId) Deletes the shopping coupon with the primary key from the database.
static ShoppingCoupon	deleteShoppingCoupon(ShoppingCoupon shoppingCoupon) Deletes the shopping coupon from the database.
static DynamicQuery	dynamicQuery()
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) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static ShoppingCoupon	fetchShoppingCoupon(long couponId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static ShoppingCoupon	getCoupon(long couponId)
static ShoppingCoupon	getCoupon(String code)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ShoppingCouponLocalService	getService()
static ShoppingCoupon	getShoppingCoupon(long couponId) Returns the shopping coupon with the primary key.
static List<ShoppingCoupon>	getShoppingCoupons(int start, int end) Returns a range of all the shopping coupons.
static int	getShoppingCouponsCount() Returns the number of shopping coupons.
static List<ShoppingCoupon>	search(long groupId, long companyId, String code, boolean active, String discountType, boolean andOperator, int start, int end)
static int	searchCount(long groupId, long companyId, String code, boolean active, String discountType, boolean andOperator)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(ShoppingCouponLocalService service) Deprecated. As of 6.2.0
static ShoppingCoupon	updateCoupon(long userId, long couponId, String name, String description, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int endDateMonth, int endDateDay, int endDateYear, int endDateHour, int endDateMinute, boolean neverExpire, boolean active, String limitCategories, String limitSkus, double minOrder, double discount, String discountType, ServiceContext serviceContext)
static ShoppingCoupon	updateShoppingCoupon(ShoppingCoupon shoppingCoupon) Updates the shopping coupon 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

ShoppingCouponLocalServiceUtil

public ShoppingCouponLocalServiceUtil()

Method Detail

addShoppingCoupon

public static ShoppingCoupon addShoppingCoupon(ShoppingCoupon shoppingCoupon)
                                        throws SystemException

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

Parameters:

shoppingCoupon - the shopping coupon

Returns:

the shopping coupon that was added

Throws:

SystemException - if a system exception occurred

createShoppingCoupon

public static ShoppingCoupon createShoppingCoupon(long couponId)

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

Parameters:

couponId - the primary key for the new shopping coupon

Returns:

the new shopping coupon

deleteShoppingCoupon

public static ShoppingCoupon deleteShoppingCoupon(long couponId)
                                           throws PortalException,
                                                  SystemException

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

Parameters:

couponId - the primary key of the shopping coupon

Returns:

the shopping coupon that was removed

Throws:

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

SystemException - if a system exception occurred

deleteShoppingCoupon

public static ShoppingCoupon deleteShoppingCoupon(ShoppingCoupon shoppingCoupon)
                                           throws SystemException

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

Parameters:

shoppingCoupon - the shopping coupon

Returns:

the shopping coupon that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

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

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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingCouponModelImpl. 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

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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingCouponModelImpl. 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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchShoppingCoupon

public static ShoppingCoupon fetchShoppingCoupon(long couponId)
                                          throws SystemException

Throws:

SystemException

getShoppingCoupon

public static ShoppingCoupon getShoppingCoupon(long couponId)
                                        throws PortalException,
                                               SystemException

Returns the shopping coupon with the primary key.

Parameters:

couponId - the primary key of the shopping coupon

Returns:

the shopping coupon

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getShoppingCoupons

public static List<ShoppingCoupon> getShoppingCoupons(int start,
                                                      int end)
                                               throws SystemException

Returns a range of all the shopping coupons.

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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingCouponModelImpl. 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 coupons

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

Returns:

the range of shopping coupons

Throws:

SystemException - if a system exception occurred

getShoppingCouponsCount

public static int getShoppingCouponsCount()
                                   throws SystemException

Returns the number of shopping coupons.

Returns:

the number of shopping coupons

Throws:

SystemException - if a system exception occurred

updateShoppingCoupon

public static ShoppingCoupon updateShoppingCoupon(ShoppingCoupon shoppingCoupon)
                                           throws SystemException

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

Parameters:

shoppingCoupon - the shopping coupon

Returns:

the shopping coupon that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addCoupon

public static ShoppingCoupon addCoupon(long userId,
                                       String code,
                                       boolean autoCode,
                                       String name,
                                       String description,
                                       int startDateMonth,
                                       int startDateDay,
                                       int startDateYear,
                                       int startDateHour,
                                       int startDateMinute,
                                       int endDateMonth,
                                       int endDateDay,
                                       int endDateYear,
                                       int endDateHour,
                                       int endDateMinute,
                                       boolean neverExpire,
                                       boolean active,
                                       String limitCategories,
                                       String limitSkus,
                                       double minOrder,
                                       double discount,
                                       String discountType,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

deleteCoupon

public static void deleteCoupon(long couponId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deleteCoupon

public static void deleteCoupon(ShoppingCoupon coupon)
                         throws SystemException

Throws:

SystemException

deleteCoupons

public static void deleteCoupons(long groupId)
                          throws SystemException

Throws:

SystemException

getCoupon

public static ShoppingCoupon getCoupon(long couponId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getCoupon

public static ShoppingCoupon getCoupon(String code)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

search

public static List<ShoppingCoupon> search(long groupId,
                                          long companyId,
                                          String code,
                                          boolean active,
                                          String discountType,
                                          boolean andOperator,
                                          int start,
                                          int end)
                                   throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(long groupId,
                              long companyId,
                              String code,
                              boolean active,
                              String discountType,
                              boolean andOperator)
                       throws SystemException

Throws:

SystemException

updateCoupon

public static ShoppingCoupon updateCoupon(long userId,
                                          long couponId,
                                          String name,
                                          String description,
                                          int startDateMonth,
                                          int startDateDay,
                                          int startDateYear,
                                          int startDateHour,
                                          int startDateMinute,
                                          int endDateMonth,
                                          int endDateDay,
                                          int endDateYear,
                                          int endDateHour,
                                          int endDateMinute,
                                          boolean neverExpire,
                                          boolean active,
                                          String limitCategories,
                                          String limitSkus,
                                          double minOrder,
                                          double discount,
                                          String discountType,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getService

public static ShoppingCouponLocalService getService()

setService

public void setService(ShoppingCouponLocalService service)

Deprecated. As of 6.2.0