com.liferay.shopping.service.persistence

Class ShoppingCouponUtil

java.lang.Object

com.liferay.shopping.service.persistence.ShoppingCouponUtil

@ProviderType
public class ShoppingCouponUtil
extends java.lang.Object

The persistence utility for the shopping coupon service. This utility wraps com.liferay.shopping.service.persistence.impl.ShoppingCouponPersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.

Caching information and settings can be found in portal.properties

See Also:

ShoppingCouponPersistence

Generated:

Constructor Summary

Constructors

Constructor and Description
ShoppingCouponUtil()

Method Summary

Modifier and Type	Method and Description
static void	cacheResult(java.util.List<ShoppingCoupon> shoppingCoupons) Caches the shopping coupons in the entity cache if it is enabled.
static void	cacheResult(ShoppingCoupon shoppingCoupon) Caches the shopping coupon in the entity cache if it is enabled.
static void	clearCache()
static void	clearCache(ShoppingCoupon shoppingCoupon)
static int	countAll() Returns the number of shopping coupons.
static int	countByCode(java.lang.String code) Returns the number of shopping coupons where code = ?.
static int	countByGroupId(long groupId) Returns the number of shopping coupons where groupId = ?.
static long	countWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
static ShoppingCoupon	create(long couponId) Creates a new shopping coupon with the primary key.
static ShoppingCoupon	fetchByCode(java.lang.String code) Returns the shopping coupon where code = ? or returns null if it could not be found.
static ShoppingCoupon	fetchByCode(java.lang.String code, boolean retrieveFromCache) Returns the shopping coupon where code = ? or returns null if it could not be found, optionally using the finder cache.
static ShoppingCoupon	fetchByGroupId_First(long groupId, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator) Returns the first shopping coupon in the ordered set where groupId = ?.
static ShoppingCoupon	fetchByGroupId_Last(long groupId, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator) Returns the last shopping coupon in the ordered set where groupId = ?.
static ShoppingCoupon	fetchByPrimaryKey(long couponId) Returns the shopping coupon with the primary key or returns null if it could not be found.
static java.util.Map<java.io.Serializable,ShoppingCoupon>	fetchByPrimaryKeys(java.util.Set<java.io.Serializable> primaryKeys)
static java.util.List<ShoppingCoupon>	findAll() Returns all the shopping coupons.
static java.util.List<ShoppingCoupon>	findAll(int start, int end) Returns a range of all the shopping coupons.
static java.util.List<ShoppingCoupon>	findAll(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator) Returns an ordered range of all the shopping coupons.
static java.util.List<ShoppingCoupon>	findAll(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the shopping coupons.
static ShoppingCoupon	findByCode(java.lang.String code) Returns the shopping coupon where code = ? or throws a NoSuchCouponException if it could not be found.
static ShoppingCoupon	findByGroupId_First(long groupId, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator) Returns the first shopping coupon in the ordered set where groupId = ?.
static ShoppingCoupon	findByGroupId_Last(long groupId, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator) Returns the last shopping coupon in the ordered set where groupId = ?.
static ShoppingCoupon[]	findByGroupId_PrevAndNext(long couponId, long groupId, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator) Returns the shopping coupons before and after the current shopping coupon in the ordered set where groupId = ?.
static java.util.List<ShoppingCoupon>	findByGroupId(long groupId) Returns all the shopping coupons where groupId = ?.
static java.util.List<ShoppingCoupon>	findByGroupId(long groupId, int start, int end) Returns a range of all the shopping coupons where groupId = ?.
static java.util.List<ShoppingCoupon>	findByGroupId(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator) Returns an ordered range of all the shopping coupons where groupId = ?.
static java.util.List<ShoppingCoupon>	findByGroupId(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the shopping coupons where groupId = ?.
static ShoppingCoupon	findByPrimaryKey(long couponId) Returns the shopping coupon with the primary key or throws a NoSuchCouponException if it could not be found.
static java.util.List<ShoppingCoupon>	findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
static java.util.List<ShoppingCoupon>	findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
static java.util.List<ShoppingCoupon>	findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator)
static java.util.Set<java.lang.String>	getBadColumnNames()
static ShoppingCouponPersistence	getPersistence()
static ShoppingCoupon	remove(long couponId) Removes the shopping coupon with the primary key from the database.
static void	removeAll() Removes all the shopping coupons from the database.
static ShoppingCoupon	removeByCode(java.lang.String code) Removes the shopping coupon where code = ? from the database.
static void	removeByGroupId(long groupId) Removes all the shopping coupons where groupId = ? from the database.
static ShoppingCoupon	update(ShoppingCoupon shoppingCoupon)
static ShoppingCoupon	update(ShoppingCoupon shoppingCoupon, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static ShoppingCoupon	updateImpl(ShoppingCoupon shoppingCoupon)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShoppingCouponUtil

public ShoppingCouponUtil()

Method Detail

clearCache

public static void clearCache()

See Also:

BasePersistence.clearCache()

clearCache

public static void clearCache(ShoppingCoupon shoppingCoupon)

See Also:

BasePersistence.clearCache(com.liferay.portal.kernel.model.BaseModel)

countWithDynamicQuery

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

See Also:

BasePersistence.countWithDynamicQuery(DynamicQuery)

fetchByPrimaryKeys

public static java.util.Map<java.io.Serializable,ShoppingCoupon> fetchByPrimaryKeys(java.util.Set<java.io.Serializable> primaryKeys)

See Also:

BasePersistence.fetchByPrimaryKeys(Set)

findWithDynamicQuery

public static java.util.List<ShoppingCoupon> findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static java.util.List<ShoppingCoupon> findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                  int start,
                                                                  int end)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static java.util.List<ShoppingCoupon> findWithDynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                  int start,
                                                                  int end,
                                                                  com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static ShoppingCoupon update(ShoppingCoupon shoppingCoupon)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel)

update

public static ShoppingCoupon update(ShoppingCoupon shoppingCoupon,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel, ServiceContext)

findByGroupId

public static java.util.List<ShoppingCoupon> findByGroupId(long groupId)

Returns all the shopping coupons where groupId = ?.

Parameters:

groupId - the group ID

Returns:

the matching shopping coupons

findByGroupId

public static java.util.List<ShoppingCoupon> findByGroupId(long groupId,
                                                           int start,
                                                           int end)

Returns a range of all the shopping coupons where groupId = ?.

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:

groupId - the group ID

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 matching shopping coupons

findByGroupId

public static java.util.List<ShoppingCoupon> findByGroupId(long groupId,
                                                           int start,
                                                           int end,
                                                           com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator)

Returns an ordered range of all the shopping coupons where groupId = ?.

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:

groupId - the group ID

start - the lower bound of the range of shopping coupons

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching shopping coupons

findByGroupId

public static java.util.List<ShoppingCoupon> findByGroupId(long groupId,
                                                           int start,
                                                           int end,
                                                           com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator,
                                                           boolean retrieveFromCache)

Returns an ordered range of all the shopping coupons where groupId = ?.

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:

groupId - the group ID

start - the lower bound of the range of shopping coupons

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

orderByComparator - the comparator to order the results by (optionally null)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of matching shopping coupons

findByGroupId_First

public static ShoppingCoupon findByGroupId_First(long groupId,
                                                 com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator)
                                          throws NoSuchCouponException

Returns the first shopping coupon in the ordered set where groupId = ?.

Parameters:

groupId - the group ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching shopping coupon

Throws:

NoSuchCouponException - if a matching shopping coupon could not be found

fetchByGroupId_First

public static ShoppingCoupon fetchByGroupId_First(long groupId,
                                                  com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator)

Returns the first shopping coupon in the ordered set where groupId = ?.

Parameters:

groupId - the group ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching shopping coupon, or null if a matching shopping coupon could not be found

findByGroupId_Last

public static ShoppingCoupon findByGroupId_Last(long groupId,
                                                com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator)
                                         throws NoSuchCouponException

Returns the last shopping coupon in the ordered set where groupId = ?.

Parameters:

groupId - the group ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching shopping coupon

Throws:

NoSuchCouponException - if a matching shopping coupon could not be found

fetchByGroupId_Last

public static ShoppingCoupon fetchByGroupId_Last(long groupId,
                                                 com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator)

Returns the last shopping coupon in the ordered set where groupId = ?.

Parameters:

groupId - the group ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching shopping coupon, or null if a matching shopping coupon could not be found

findByGroupId_PrevAndNext

public static ShoppingCoupon[] findByGroupId_PrevAndNext(long couponId,
                                                         long groupId,
                                                         com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator)
                                                  throws NoSuchCouponException

Returns the shopping coupons before and after the current shopping coupon in the ordered set where groupId = ?.

Parameters:

couponId - the primary key of the current shopping coupon

groupId - the group ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the previous, current, and next shopping coupon

Throws:

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

removeByGroupId

public static void removeByGroupId(long groupId)

Removes all the shopping coupons where groupId = ? from the database.

Parameters:

groupId - the group ID

countByGroupId

public static int countByGroupId(long groupId)

Returns the number of shopping coupons where groupId = ?.

Parameters:

groupId - the group ID

Returns:

the number of matching shopping coupons

findByCode

public static ShoppingCoupon findByCode(java.lang.String code)
                                 throws NoSuchCouponException

Returns the shopping coupon where code = ? or throws a NoSuchCouponException if it could not be found.

Parameters:

code - the code

Returns:

the matching shopping coupon

Throws:

NoSuchCouponException - if a matching shopping coupon could not be found

fetchByCode

public static ShoppingCoupon fetchByCode(java.lang.String code)

Returns the shopping coupon where code = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

code - the code

Returns:

the matching shopping coupon, or null if a matching shopping coupon could not be found

fetchByCode

public static ShoppingCoupon fetchByCode(java.lang.String code,
                                         boolean retrieveFromCache)

Returns the shopping coupon where code = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

code - the code

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the matching shopping coupon, or null if a matching shopping coupon could not be found

removeByCode

public static ShoppingCoupon removeByCode(java.lang.String code)
                                   throws NoSuchCouponException

Removes the shopping coupon where code = ? from the database.

Parameters:

code - the code

Returns:

the shopping coupon that was removed

Throws:

NoSuchCouponException

countByCode

public static int countByCode(java.lang.String code)

Returns the number of shopping coupons where code = ?.

Parameters:

code - the code

Returns:

the number of matching shopping coupons

cacheResult

public static void cacheResult(ShoppingCoupon shoppingCoupon)

Caches the shopping coupon in the entity cache if it is enabled.

Parameters:

shoppingCoupon - the shopping coupon

cacheResult

public static void cacheResult(java.util.List<ShoppingCoupon> shoppingCoupons)

Caches the shopping coupons in the entity cache if it is enabled.

Parameters:

shoppingCoupons - the shopping coupons

create

public static ShoppingCoupon create(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

remove

public static ShoppingCoupon remove(long couponId)
                             throws NoSuchCouponException

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

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

updateImpl

public static ShoppingCoupon updateImpl(ShoppingCoupon shoppingCoupon)

findByPrimaryKey

public static ShoppingCoupon findByPrimaryKey(long couponId)
                                       throws NoSuchCouponException

Returns the shopping coupon with the primary key or throws a NoSuchCouponException if it could not be found.

Parameters:

couponId - the primary key of the shopping coupon

Returns:

the shopping coupon

Throws:

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

fetchByPrimaryKey

public static ShoppingCoupon fetchByPrimaryKey(long couponId)

Returns the shopping coupon with the primary key or returns null if it could not be found.

Parameters:

couponId - the primary key of the shopping coupon

Returns:

the shopping coupon, or null if a shopping coupon with the primary key could not be found

findAll

public static java.util.List<ShoppingCoupon> findAll()

Returns all the shopping coupons.

Returns:

the shopping coupons

findAll

public static java.util.List<ShoppingCoupon> findAll(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 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

findAll

public static java.util.List<ShoppingCoupon> findAll(int start,
                                                     int end,
                                                     com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator)

Returns an ordered 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)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of shopping coupons

findAll

public static java.util.List<ShoppingCoupon> findAll(int start,
                                                     int end,
                                                     com.liferay.portal.kernel.util.OrderByComparator<ShoppingCoupon> orderByComparator,
                                                     boolean retrieveFromCache)

Returns an ordered 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)

orderByComparator - the comparator to order the results by (optionally null)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of shopping coupons

removeAll

public static void removeAll()

Removes all the shopping coupons from the database.

countAll

public static int countAll()

Returns the number of shopping coupons.

Returns:

the number of shopping coupons

getBadColumnNames

public static java.util.Set<java.lang.String> getBadColumnNames()

getPersistence

public static ShoppingCouponPersistence getPersistence()