Liferay 7.0-ce-b4

com.liferay.portal.service.persistence
Class CountryUtil

java.lang.Object
  extended by 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<Country> orderByComparator)
          Returns the first country in the ordered set where active = ?.
static Country fetchByActive_Last(boolean active, OrderByComparator<Country> 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 Map<Serializable,Country> fetchByPrimaryKeys(Set<Serializable> primaryKeys)
           
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<Country> orderByComparator)
          Returns an ordered range of all the countries.
static List<Country> findAll(int start, int end, OrderByComparator<Country> orderByComparator, boolean retrieveFromCache)
          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<Country> orderByComparator)
          Returns the first country in the ordered set where active = ?.
static Country findByActive_Last(boolean active, OrderByComparator<Country> orderByComparator)
          Returns the last country in the ordered set where active = ?.
static Country[] findByActive_PrevAndNext(long countryId, boolean active, OrderByComparator<Country> 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<Country> orderByComparator)
          Returns an ordered range of all the countries where active = ?.
static List<Country> findByActive(boolean active, int start, int end, OrderByComparator<Country> orderByComparator, boolean retrieveFromCache)
          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<Country> orderByComparator)
           
static Set<String> getBadColumnNames()
           
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.
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)
See Also:
BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Country> findWithDynamicQuery(DynamicQuery dynamicQuery)
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Country> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static List<Country> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<Country> orderByComparator)
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static Country update(Country country)
See Also:
BasePersistence.update(com.liferay.portal.model.BaseModel)

update

public static Country update(Country country,
                             ServiceContext serviceContext)
See Also:
BasePersistence.update(com.liferay.portal.model.BaseModel, ServiceContext)

findByName

public static Country findByName(String name)
                          throws NoSuchCountryException
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

fetchByName

public static Country fetchByName(String name)
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

fetchByName

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

Parameters:
name - the name
retrieveFromCache - whether to retrieve from the finder cache
Returns:
the matching country, or null if a matching country could not be found

removeByName

public static Country removeByName(String name)
                            throws NoSuchCountryException
Removes the country where name = ? from the database.

Parameters:
name - the name
Returns:
the country that was removed
Throws:
NoSuchCountryException

countByName

public static int countByName(String name)
Returns the number of countries where name = ?.

Parameters:
name - the name
Returns:
the number of matching countries

findByA2

public static Country findByA2(String a2)
                        throws NoSuchCountryException
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

fetchByA2

public static Country fetchByA2(String a2)
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

fetchByA2

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

Parameters:
a2 - the a2
retrieveFromCache - whether to retrieve from the finder cache
Returns:
the matching country, or null if a matching country could not be found

removeByA2

public static Country removeByA2(String a2)
                          throws NoSuchCountryException
Removes the country where a2 = ? from the database.

Parameters:
a2 - the a2
Returns:
the country that was removed
Throws:
NoSuchCountryException

countByA2

public static int countByA2(String a2)
Returns the number of countries where a2 = ?.

Parameters:
a2 - the a2
Returns:
the number of matching countries

findByA3

public static Country findByA3(String a3)
                        throws NoSuchCountryException
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

fetchByA3

public static Country fetchByA3(String a3)
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

fetchByA3

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

Parameters:
a3 - the a3
retrieveFromCache - whether to retrieve from the finder cache
Returns:
the matching country, or null if a matching country could not be found

removeByA3

public static Country removeByA3(String a3)
                          throws NoSuchCountryException
Removes the country where a3 = ? from the database.

Parameters:
a3 - the a3
Returns:
the country that was removed
Throws:
NoSuchCountryException

countByA3

public static int countByA3(String a3)
Returns the number of countries where a3 = ?.

Parameters:
a3 - the a3
Returns:
the number of matching countries

findByActive

public static List<Country> findByActive(boolean active)
Returns all the countries where active = ?.

Parameters:
active - the active
Returns:
the matching countries

findByActive

public static List<Country> findByActive(boolean active,
                                         int start,
                                         int end)
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

findByActive

public static List<Country> findByActive(boolean active,
                                         int start,
                                         int end,
                                         OrderByComparator<Country> orderByComparator)
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

findByActive

public static List<Country> findByActive(boolean active,
                                         int start,
                                         int end,
                                         OrderByComparator<Country> orderByComparator,
                                         boolean retrieveFromCache)
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)
retrieveFromCache - whether to retrieve from the finder cache
Returns:
the ordered range of matching countries

findByActive_First

public static Country findByActive_First(boolean active,
                                         OrderByComparator<Country> orderByComparator)
                                  throws NoSuchCountryException
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

fetchByActive_First

public static Country fetchByActive_First(boolean active,
                                          OrderByComparator<Country> orderByComparator)
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

findByActive_Last

public static Country findByActive_Last(boolean active,
                                        OrderByComparator<Country> orderByComparator)
                                 throws NoSuchCountryException
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

fetchByActive_Last

public static Country fetchByActive_Last(boolean active,
                                         OrderByComparator<Country> orderByComparator)
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

findByActive_PrevAndNext

public static Country[] findByActive_PrevAndNext(long countryId,
                                                 boolean active,
                                                 OrderByComparator<Country> orderByComparator)
                                          throws NoSuchCountryException
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

removeByActive

public static void removeByActive(boolean active)
Removes all the countries where active = ? from the database.

Parameters:
active - the active

countByActive

public static int countByActive(boolean active)
Returns the number of countries where active = ?.

Parameters:
active - the active
Returns:
the number of matching countries

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

updateImpl

public static Country updateImpl(Country country)

findByPrimaryKey

public static Country findByPrimaryKey(long countryId)
                                throws NoSuchCountryException
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

fetchByPrimaryKey

public static Country fetchByPrimaryKey(long countryId)
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

fetchByPrimaryKeys

public static Map<Serializable,Country> fetchByPrimaryKeys(Set<Serializable> primaryKeys)

findAll

public static List<Country> findAll()
Returns all the countries.

Returns:
the countries

findAll

public static List<Country> findAll(int start,
                                    int end)
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

findAll

public static List<Country> findAll(int start,
                                    int end,
                                    OrderByComparator<Country> orderByComparator)
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

findAll

public static List<Country> findAll(int start,
                                    int end,
                                    OrderByComparator<Country> orderByComparator,
                                    boolean retrieveFromCache)
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)
retrieveFromCache - whether to retrieve from the finder cache
Returns:
the ordered range of countries

removeAll

public static void removeAll()
Removes all the countries from the database.


countAll

public static int countAll()
Returns the number of countries.

Returns:
the number of countries

getBadColumnNames

public static Set<String> getBadColumnNames()

getPersistence

public static CountryPersistence getPersistence()

Liferay 7.0-ce-b4