com.liferay.portal.service.persistence
Class CountryUtil

java.lang.Object
  com.liferay.portal.service.persistence.CountryUtil

@ProviderType
public class CountryUtil
extends Object

The persistence utility for the country service. This utility wraps CountryPersistenceImpl 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:

CountryPersistence, CountryPersistenceImpl

Constructor Summary

CountryUtil()

Method Summary

static void	cacheResult(Country country) Caches the country in the entity cache if it is enabled.
static void	cacheResult(List<Country> countries) Caches the countries in the entity cache if it is enabled.
static void	clearCache()
static void	clearCache(Country country)
static int	countAll() Returns the number of countries.
static int	countByA2(String a2) Returns the number of countries where a2 = ?.
static int	countByA3(String a3) Returns the number of countries where a3 = ?.
static int	countByActive(boolean active) Returns the number of countries where active = ?.
static int	countByName(String name) Returns the number of countries where name = ?.
static long	countWithDynamicQuery(DynamicQuery dynamicQuery)
static Country	create(long countryId) Creates a new country with the primary key.
static Country	fetchByA2(String a2) Returns the country where a2 = ? or returns null if it could not be found.
static Country	fetchByA2(String a2, boolean retrieveFromCache) Returns the country where a2 = ? or returns null if it could not be found, optionally using the finder cache.
static Country	fetchByA3(String a3) Returns the country where a3 = ? or returns null if it could not be found.
static Country	fetchByA3(String a3, boolean retrieveFromCache) Returns the country where a3 = ? or returns null if it could not be found, optionally using the finder cache.
static Country	fetchByActive_First(boolean active, OrderByComparator orderByComparator) Returns the first country in the ordered set where active = ?.
static Country	fetchByActive_Last(boolean active, OrderByComparator orderByComparator) Returns the last country in the ordered set where active = ?.
static Country	fetchByName(String name) Returns the country where name = ? or returns null if it could not be found.
static Country	fetchByName(String name, boolean retrieveFromCache) Returns the country where name = ? or returns null if it could not be found, optionally using the finder cache.
static Country	fetchByPrimaryKey(long countryId) Returns the country with the primary key or returns null if it could not be found.
static List<Country>	findAll() Returns all the countries.
static List<Country>	findAll(int start, int end) Returns a range of all the countries.
static List<Country>	findAll(int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the countries.
static Country	findByA2(String a2) Returns the country where a2 = ? or throws a NoSuchCountryException if it could not be found.
static Country	findByA3(String a3) Returns the country where a3 = ? or throws a NoSuchCountryException if it could not be found.
static Country	findByActive_First(boolean active, OrderByComparator orderByComparator) Returns the first country in the ordered set where active = ?.
static Country	findByActive_Last(boolean active, OrderByComparator orderByComparator) Returns the last country in the ordered set where active = ?.
static Country[]	findByActive_PrevAndNext(long countryId, boolean active, OrderByComparator orderByComparator) Returns the countries before and after the current country in the ordered set where active = ?.
static List<Country>	findByActive(boolean active) Returns all the countries where active = ?.
static List<Country>	findByActive(boolean active, int start, int end) Returns a range of all the countries where active = ?.
static List<Country>	findByActive(boolean active, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the countries where active = ?.
static Country	findByName(String name) Returns the country where name = ? or throws a NoSuchCountryException if it could not be found.
static Country	findByPrimaryKey(long countryId) Returns the country with the primary key or throws a NoSuchCountryException if it could not be found.
static List<Country>	findWithDynamicQuery(DynamicQuery dynamicQuery)
static List<Country>	findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
static List<Country>	findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
static CountryPersistence	getPersistence()
static Country	remove(long countryId) Removes the country with the primary key from the database.
static void	removeAll() Removes all the countries from the database.
static Country	removeByA2(String a2) Removes the country where a2 = ? from the database.
static Country	removeByA3(String a3) Removes the country where a3 = ? from the database.
static void	removeByActive(boolean active) Removes all the countries where active = ? from the database.
static Country	removeByName(String name) Removes the country where name = ? from the database.
void	setPersistence(CountryPersistence persistence) Deprecated. As of 6.2.0
static Country	update(Country country)
static Country	update(Country country, ServiceContext serviceContext)
static Country	updateImpl(Country country)

Methods inherited from class java.lang.Object

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

Constructor Detail

CountryUtil

public CountryUtil()

Method Detail

clearCache

public static void clearCache()

See Also:

BasePersistence.clearCache()

clearCache

public static void clearCache(Country country)

See Also:

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

countWithDynamicQuery

public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
                                  throws SystemException

Throws:

SystemException

See Also:

BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Country> findWithDynamicQuery(DynamicQuery dynamicQuery)
                                          throws SystemException

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Country> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)
                                          throws SystemException

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static List<Country> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator orderByComparator)
                                          throws SystemException

Throws:

SystemException

See Also:

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

update

public static Country update(Country country)
                      throws SystemException

Throws:

SystemException

See Also:

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

update

public static Country update(Country country,
                             ServiceContext serviceContext)
                      throws SystemException

Throws:

SystemException

See Also:

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

findByName

public static Country findByName(String name)
                          throws NoSuchCountryException,
                                 SystemException

Returns the country where name = ? or throws a NoSuchCountryException if it could not be found.

Parameters:

name - the name

Returns:

the matching country

Throws:

NoSuchCountryException - if a matching country could not be found

SystemException - if a system exception occurred

fetchByName

public static Country fetchByName(String name)
                           throws SystemException

Returns the country where name = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

name - the name

Returns:

the matching country, or null if a matching country could not be found

Throws:

SystemException - if a system exception occurred

fetchByName

public static Country fetchByName(String name,
                                  boolean retrieveFromCache)
                           throws SystemException

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

Parameters:

name - the name

retrieveFromCache - whether to use the finder cache

Returns:

the matching country, or null if a matching country could not be found

Throws:

SystemException - if a system exception occurred

removeByName

public static Country removeByName(String name)
                            throws NoSuchCountryException,
                                   SystemException

Removes the country where name = ? from the database.

Parameters:

name - the name

Returns:

the country that was removed

Throws:

SystemException - if a system exception occurred

NoSuchCountryException

countByName

public static int countByName(String name)
                       throws SystemException

Returns the number of countries where name = ?.

Parameters:

name - the name

Returns:

the number of matching countries

Throws:

SystemException - if a system exception occurred

findByA2

public static Country findByA2(String a2)
                        throws NoSuchCountryException,
                               SystemException

Returns the country where a2 = ? or throws a NoSuchCountryException if it could not be found.

Parameters:

a2 - the a2

Returns:

the matching country

Throws:

NoSuchCountryException - if a matching country could not be found

SystemException - if a system exception occurred

fetchByA2

public static Country fetchByA2(String a2)
                         throws SystemException

Returns the country where a2 = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

a2 - the a2

Returns:

the matching country, or null if a matching country could not be found

Throws:

SystemException - if a system exception occurred

fetchByA2

public static Country fetchByA2(String a2,
                                boolean retrieveFromCache)
                         throws SystemException

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

Parameters:

a2 - the a2

retrieveFromCache - whether to use the finder cache

Returns:

the matching country, or null if a matching country could not be found

Throws:

SystemException - if a system exception occurred

removeByA2

public static Country removeByA2(String a2)
                          throws NoSuchCountryException,
                                 SystemException

Removes the country where a2 = ? from the database.

Parameters:

a2 - the a2

Returns:

the country that was removed

Throws:

SystemException - if a system exception occurred

NoSuchCountryException

countByA2

public static int countByA2(String a2)
                     throws SystemException

Returns the number of countries where a2 = ?.

Parameters:

a2 - the a2

Returns:

the number of matching countries

Throws:

SystemException - if a system exception occurred

findByA3

public static Country findByA3(String a3)
                        throws NoSuchCountryException,
                               SystemException

Returns the country where a3 = ? or throws a NoSuchCountryException if it could not be found.

Parameters:

a3 - the a3

Returns:

the matching country

Throws:

NoSuchCountryException - if a matching country could not be found

SystemException - if a system exception occurred

fetchByA3

public static Country fetchByA3(String a3)
                         throws SystemException

Returns the country where a3 = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

a3 - the a3

Returns:

the matching country, or null if a matching country could not be found

Throws:

SystemException - if a system exception occurred

fetchByA3

public static Country fetchByA3(String a3,
                                boolean retrieveFromCache)
                         throws SystemException

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

Parameters:

a3 - the a3

retrieveFromCache - whether to use the finder cache

Returns:

the matching country, or null if a matching country could not be found

Throws:

SystemException - if a system exception occurred

removeByA3

public static Country removeByA3(String a3)
                          throws NoSuchCountryException,
                                 SystemException

Removes the country where a3 = ? from the database.

Parameters:

a3 - the a3

Returns:

the country that was removed

Throws:

SystemException - if a system exception occurred

NoSuchCountryException

countByA3

public static int countByA3(String a3)
                     throws SystemException

Returns the number of countries where a3 = ?.

Parameters:

a3 - the a3

Returns:

the number of matching countries

Throws:

SystemException - if a system exception occurred

findByActive

public static List<Country> findByActive(boolean active)
                                  throws SystemException

Returns all the countries where active = ?.

Parameters:

active - the active

Returns:

the matching countries

Throws:

SystemException - if a system exception occurred

findByActive

public static List<Country> findByActive(boolean active,
                                         int start,
                                         int end)
                                  throws SystemException

Returns a range of all the countries where active = ?.

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

active - the active

start - the lower bound of the range of countries

end - the upper bound of the range of countries (not inclusive)

Returns:

the range of matching countries

Throws:

SystemException - if a system exception occurred

findByActive

public static List<Country> findByActive(boolean active,
                                         int start,
                                         int end,
                                         OrderByComparator orderByComparator)
                                  throws SystemException

Returns an ordered range of all the countries where active = ?.

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

active - the active

start - the lower bound of the range of countries

end - the upper bound of the range of countries (not inclusive)

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

Returns:

the ordered range of matching countries

Throws:

SystemException - if a system exception occurred

findByActive_First

public static Country findByActive_First(boolean active,
                                         OrderByComparator orderByComparator)
                                  throws NoSuchCountryException,
                                         SystemException

Returns the first country in the ordered set where active = ?.

Parameters:

active - the active

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

Returns:

the first matching country

Throws:

NoSuchCountryException - if a matching country could not be found

SystemException - if a system exception occurred

fetchByActive_First

public static Country fetchByActive_First(boolean active,
                                          OrderByComparator orderByComparator)
                                   throws SystemException

Returns the first country in the ordered set where active = ?.

Parameters:

active - the active

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

Returns:

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

Throws:

SystemException - if a system exception occurred

findByActive_Last

public static Country findByActive_Last(boolean active,
                                        OrderByComparator orderByComparator)
                                 throws NoSuchCountryException,
                                        SystemException

Returns the last country in the ordered set where active = ?.

Parameters:

active - the active

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

Returns:

the last matching country

Throws:

NoSuchCountryException - if a matching country could not be found

SystemException - if a system exception occurred

fetchByActive_Last

public static Country fetchByActive_Last(boolean active,
                                         OrderByComparator orderByComparator)
                                  throws SystemException

Returns the last country in the ordered set where active = ?.

Parameters:

active - the active

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

Returns:

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

Throws:

SystemException - if a system exception occurred

findByActive_PrevAndNext

public static Country[] findByActive_PrevAndNext(long countryId,
                                                 boolean active,
                                                 OrderByComparator orderByComparator)
                                          throws NoSuchCountryException,
                                                 SystemException

Returns the countries before and after the current country in the ordered set where active = ?.

Parameters:

countryId - the primary key of the current country

active - the active

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

Returns:

the previous, current, and next country

Throws:

NoSuchCountryException - if a country with the primary key could not be found

SystemException - if a system exception occurred

removeByActive

public static void removeByActive(boolean active)
                           throws SystemException

Removes all the countries where active = ? from the database.

Parameters:

active - the active

Throws:

SystemException - if a system exception occurred

countByActive

public static int countByActive(boolean active)
                         throws SystemException

Returns the number of countries where active = ?.

Parameters:

active - the active

Returns:

the number of matching countries

Throws:

SystemException - if a system exception occurred

cacheResult

public static void cacheResult(Country country)

Caches the country in the entity cache if it is enabled.

Parameters:

country - the country

cacheResult

public static void cacheResult(List<Country> countries)

Caches the countries in the entity cache if it is enabled.

Parameters:

countries - the countries

create

public static Country create(long countryId)

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

Parameters:

countryId - the primary key for the new country

Returns:

the new country

remove

public static Country remove(long countryId)
                      throws NoSuchCountryException,
                             SystemException

Removes the country with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

countryId - the primary key of the country

Returns:

the country that was removed

Throws:

NoSuchCountryException - if a country with the primary key could not be found

SystemException - if a system exception occurred

updateImpl

public static Country updateImpl(Country country)
                          throws SystemException

Throws:

SystemException

findByPrimaryKey

public static Country findByPrimaryKey(long countryId)
                                throws NoSuchCountryException,
                                       SystemException

Returns the country with the primary key or throws a NoSuchCountryException if it could not be found.

Parameters:

countryId - the primary key of the country

Returns:

the country

Throws:

NoSuchCountryException - if a country with the primary key could not be found

SystemException - if a system exception occurred

fetchByPrimaryKey

public static Country fetchByPrimaryKey(long countryId)
                                 throws SystemException

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

Parameters:

countryId - the primary key of the country

Returns:

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

Throws:

SystemException - if a system exception occurred

findAll

public static List<Country> findAll()
                             throws SystemException

Returns all the countries.

Returns:

the countries

Throws:

SystemException - if a system exception occurred

findAll

public static List<Country> findAll(int start,
                                    int end)
                             throws SystemException

Returns a range of all the countries.

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

end - the upper bound of the range of countries (not inclusive)

Returns:

the range of countries

Throws:

SystemException - if a system exception occurred

findAll

public static List<Country> findAll(int start,
                                    int end,
                                    OrderByComparator orderByComparator)
                             throws SystemException

Returns an ordered range of all the countries.

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

end - the upper bound of the range of countries (not inclusive)

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

Returns:

the ordered range of countries

Throws:

SystemException - if a system exception occurred

removeAll

public static void removeAll()
                      throws SystemException

Removes all the countries from the database.

Throws:

SystemException - if a system exception occurred

countAll

public static int countAll()
                    throws SystemException

Returns the number of countries.

Returns:

the number of countries

Throws:

SystemException - if a system exception occurred

getPersistence

public static CountryPersistence getPersistence()

setPersistence

public void setPersistence(CountryPersistence persistence)

Deprecated. As of 6.2.0