com.liferay.shopping.service

Interface ShoppingCouponLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

ShoppingCouponLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface ShoppingCouponLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for ShoppingCoupon. 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:

ShoppingCouponLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
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)
ShoppingCoupon	addShoppingCoupon(ShoppingCoupon shoppingCoupon) Adds the shopping coupon to the database.
ShoppingCoupon	createShoppingCoupon(long couponId) Creates a new shopping coupon with the primary key.
void	deleteCoupon(long couponId)
void	deleteCoupon(ShoppingCoupon coupon)
void	deleteCoupons(long groupId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
ShoppingCoupon	deleteShoppingCoupon(long couponId) Deletes the shopping coupon with the primary key from the database.
ShoppingCoupon	deleteShoppingCoupon(ShoppingCoupon shoppingCoupon) Deletes the shopping coupon from the database.
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<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.
<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.
<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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
ShoppingCoupon	fetchShoppingCoupon(long couponId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
ShoppingCoupon	getCoupon(long couponId)
ShoppingCoupon	getCoupon(java.lang.String code)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
ShoppingCoupon	getShoppingCoupon(long couponId) Returns the shopping coupon with the primary key.
java.util.List<ShoppingCoupon>	getShoppingCoupons(int start, int end) Returns a range of all the shopping coupons.
int	getShoppingCouponsCount() Returns the number of shopping coupons.
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)
int	searchCount(long groupId, long companyId, java.lang.String code, boolean active, java.lang.String discountType, boolean andOperator)
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)
ShoppingCoupon	updateShoppingCoupon(ShoppingCoupon shoppingCoupon) Updates the shopping coupon in the database or adds it if it does not yet exist.

Method Detail

addCoupon

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

@Indexable(type=REINDEX)
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

@Transactional(enabled=false)
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

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCoupon

void deleteCoupon(ShoppingCoupon coupon)

deleteCoupons

void deleteCoupons(long groupId)

deletePersistedModel

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

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteShoppingCoupon

@Indexable(type=DELETE)
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:

com.liferay.portal.kernel.exception.PortalException - if a shopping coupon with the primary key could not be found

deleteShoppingCoupon

@Indexable(type=DELETE)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCoupon fetchShoppingCoupon(long couponId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCoupon

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCoupon getCoupon(long couponId)
                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCoupon

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCoupon getCoupon(java.lang.String code)
                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getShoppingCoupon

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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:

com.liferay.portal.kernel.exception.PortalException - if a shopping coupon with the primary key could not be found

getShoppingCoupons

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getShoppingCouponsCount()

Returns the number of shopping coupons.

Returns:

the number of shopping coupons

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long groupId,
                                                                                   long companyId,
                                                                                   java.lang.String code,
                                                                                   boolean active,
                                                                                   java.lang.String discountType,
                                                                                   boolean andOperator)

updateCoupon

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

@Indexable(type=REINDEX)
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