com.liferay.shopping.service

Class ShoppingCouponLocalServiceUtil

java.lang.Object

com.liferay.shopping.service.ShoppingCouponLocalServiceUtil

@ProviderType
public class ShoppingCouponLocalServiceUtil
extends java.lang.Object

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

Generated:

Constructor Summary

Constructors

Constructor and Description
ShoppingCouponLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static ShoppingCoupon	addCoupon(long userId, java.lang.String code, boolean autoCode, java.lang.String name, java.lang.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, java.lang.String limitCategories, java.lang.String limitSkus, double minOrder, double discount, java.lang.String discountType, com.liferay.portal.kernel.service.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 com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
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 com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <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.
static <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.
static <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.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static 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.
static ShoppingCoupon	fetchShoppingCoupon(long couponId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static ShoppingCoupon	getCoupon(long couponId)
static ShoppingCoupon	getCoupon(java.lang.String code)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static ShoppingCouponLocalService	getService()
static ShoppingCoupon	getShoppingCoupon(long couponId) Returns the shopping coupon with the primary key.
static java.util.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 java.util.List<ShoppingCoupon>	search(long groupId, long companyId, java.lang.String code, boolean active, java.lang.String discountType, boolean andOperator, int start, int end)
static int	searchCount(long groupId, long companyId, java.lang.String code, boolean active, java.lang.String discountType, boolean andOperator)
static ShoppingCoupon	updateCoupon(long userId, long couponId, java.lang.String name, java.lang.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, java.lang.String limitCategories, java.lang.String limitSkus, double minOrder, double discount, java.lang.String discountType, com.liferay.portal.kernel.service.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

addCoupon

public static ShoppingCoupon addCoupon(long userId,
                                       java.lang.String code,
                                       boolean autoCode,
                                       java.lang.String name,
                                       java.lang.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,
                                       java.lang.String limitCategories,
                                       java.lang.String limitSkus,
                                       double minOrder,
                                       double discount,
                                       java.lang.String discountType,
                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addShoppingCoupon

public static ShoppingCoupon addShoppingCoupon(ShoppingCoupon shoppingCoupon)

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

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

deleteCoupon

public static void deleteCoupon(long couponId)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCoupon

public static void deleteCoupon(ShoppingCoupon coupon)

deleteCoupons

public static void deleteCoupons(long groupId)

deletePersistedModel

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

Throws:

PortalException

deleteShoppingCoupon

public static ShoppingCoupon deleteShoppingCoupon(long couponId)
                                           throws com.liferay.portal.kernel.exception.PortalException

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

deleteShoppingCoupon

public static ShoppingCoupon deleteShoppingCoupon(ShoppingCoupon shoppingCoupon)

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

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

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

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

dynamicQuery

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

dynamicQueryCount

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

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

fetchShoppingCoupon

public static ShoppingCoupon fetchShoppingCoupon(long couponId)

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCoupon

public static ShoppingCoupon getCoupon(long couponId)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCoupon

public static ShoppingCoupon getCoupon(java.lang.String code)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getShoppingCoupon

public static ShoppingCoupon getShoppingCoupon(long couponId)
                                        throws com.liferay.portal.kernel.exception.PortalException

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

getShoppingCoupons

public static java.util.List<ShoppingCoupon> getShoppingCoupons(int start,
                                                                int end)

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 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.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

getShoppingCouponsCount

public static int getShoppingCouponsCount()

Returns the number of shopping coupons.

Returns:

the number of shopping coupons

search

public static java.util.List<ShoppingCoupon> search(long groupId,
                                                    long companyId,
                                                    java.lang.String code,
                                                    boolean active,
                                                    java.lang.String discountType,
                                                    boolean andOperator,
                                                    int start,
                                                    int end)

searchCount

public static int searchCount(long groupId,
                              long companyId,
                              java.lang.String code,
                              boolean active,
                              java.lang.String discountType,
                              boolean andOperator)

updateCoupon

public static ShoppingCoupon updateCoupon(long userId,
                                          long couponId,
                                          java.lang.String name,
                                          java.lang.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,
                                          java.lang.String limitCategories,
                                          java.lang.String limitSkus,
                                          double minOrder,
                                          double discount,
                                          java.lang.String discountType,
                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateShoppingCoupon

public static ShoppingCoupon updateShoppingCoupon(ShoppingCoupon shoppingCoupon)

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

getService

public static ShoppingCouponLocalService getService()