Liferay 7.0-ce-m6

com.liferay.portlet.shopping.service
Interface ShoppingCouponLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ShoppingCouponLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ShoppingCouponLocalService
extends BaseLocalService, 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, com.liferay.portlet.shopping.service.base.ShoppingCouponLocalServiceBaseImpl, com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl

Method Summary
 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)
           
 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)
           
 PersistedModel deletePersistedModel(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.
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 ShoppingCoupon fetchShoppingCoupon(long couponId)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 ShoppingCoupon getCoupon(long couponId)
           
 ShoppingCoupon getCoupon(String code)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 ShoppingCoupon getShoppingCoupon(long couponId)
          Returns the shopping coupon with the primary key.
 List<ShoppingCoupon> getShoppingCoupons(int start, int end)
          Returns a range of all the shopping coupons.
 int getShoppingCouponsCount()
          Returns the number of shopping coupons.
 List<ShoppingCoupon> search(long groupId, long companyId, String code, boolean active, String discountType, boolean andOperator, int start, int end)
           
 int searchCount(long groupId, long companyId, String code, boolean active, String discountType, boolean andOperator)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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)
           
 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,
                         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
Throws:
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

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(ShoppingCoupon coupon)

deleteCoupon

void deleteCoupon(long couponId)
                  throws PortalException
Throws:
PortalException

deleteCoupons

void deleteCoupons(long groupId)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteShoppingCoupon

@Indexable(type=DELETE)
ShoppingCoupon deleteShoppingCoupon(long couponId)
                                    throws 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

@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

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

<T> List<T> dynamicQuery(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 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 com.liferay.portlet.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

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         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 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 com.liferay.portlet.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

long dynamicQueryCount(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

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       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)
ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getCoupon

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCoupon getCoupon(String code)
                         throws PortalException
Throws:
PortalException

getCoupon

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCoupon getCoupon(long couponId)
                         throws PortalException
Throws:
PortalException

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getShoppingCoupon

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCoupon getShoppingCoupon(long couponId)
                                 throws 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 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 com.liferay.portlet.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)
List<ShoppingCoupon> search(long groupId,
                                                                     long companyId,
                                                                     String code,
                                                                     boolean active,
                                                                     String discountType,
                                                                     boolean andOperator,
                                                                     int start,
                                                                     int end)

searchCount

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

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

updateCoupon

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
Throws:
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

Liferay 7.0-ce-m6