Liferay 6.1.2-ce-ga3

com.liferay.portal.service.persistence
Interface RegionPersistence

All Superinterfaces:
BasePersistence<Region>

public interface RegionPersistence
extends BasePersistence<Region>

The persistence interface for the region service.

Caching information and settings can be found in portal.properties

See Also:
RegionPersistenceImpl, RegionUtil

Method Summary
 void cacheResult(List<Region> regions)
          Caches the regions in the entity cache if it is enabled.
 void cacheResult(Region region)
          Caches the region in the entity cache if it is enabled.
 int countAll()
          Returns the number of regions.
 int countByActive(boolean active)
          Returns the number of regions where active = ?.
 int countByC_A(long countryId, boolean active)
          Returns the number of regions where countryId = ? and active = ?.
 int countByC_R(long countryId, String regionCode)
          Returns the number of regions where countryId = ? and regionCode = ?.
 int countByCountryId(long countryId)
          Returns the number of regions where countryId = ?.
 Region create(long regionId)
          Creates a new region with the primary key.
 Region fetchByActive_First(boolean active, OrderByComparator orderByComparator)
          Returns the first region in the ordered set where active = ?.
 Region fetchByActive_Last(boolean active, OrderByComparator orderByComparator)
          Returns the last region in the ordered set where active = ?.
 Region fetchByC_A_First(long countryId, boolean active, OrderByComparator orderByComparator)
          Returns the first region in the ordered set where countryId = ? and active = ?.
 Region fetchByC_A_Last(long countryId, boolean active, OrderByComparator orderByComparator)
          Returns the last region in the ordered set where countryId = ? and active = ?.
 Region fetchByC_R(long countryId, String regionCode)
          Returns the region where countryId = ? and regionCode = ? or returns null if it could not be found.
 Region fetchByC_R(long countryId, String regionCode, boolean retrieveFromCache)
          Returns the region where countryId = ? and regionCode = ? or returns null if it could not be found, optionally using the finder cache.
 Region fetchByCountryId_First(long countryId, OrderByComparator orderByComparator)
          Returns the first region in the ordered set where countryId = ?.
 Region fetchByCountryId_Last(long countryId, OrderByComparator orderByComparator)
          Returns the last region in the ordered set where countryId = ?.
 Region fetchByPrimaryKey(long regionId)
          Returns the region with the primary key or returns null if it could not be found.
 List<Region> findAll()
          Returns all the regions.
 List<Region> findAll(int start, int end)
          Returns a range of all the regions.
 List<Region> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the regions.
 Region findByActive_First(boolean active, OrderByComparator orderByComparator)
          Returns the first region in the ordered set where active = ?.
 Region findByActive_Last(boolean active, OrderByComparator orderByComparator)
          Returns the last region in the ordered set where active = ?.
 Region[] findByActive_PrevAndNext(long regionId, boolean active, OrderByComparator orderByComparator)
          Returns the regions before and after the current region in the ordered set where active = ?.
 List<Region> findByActive(boolean active)
          Returns all the regions where active = ?.
 List<Region> findByActive(boolean active, int start, int end)
          Returns a range of all the regions where active = ?.
 List<Region> findByActive(boolean active, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the regions where active = ?.
 Region findByC_A_First(long countryId, boolean active, OrderByComparator orderByComparator)
          Returns the first region in the ordered set where countryId = ? and active = ?.
 Region findByC_A_Last(long countryId, boolean active, OrderByComparator orderByComparator)
          Returns the last region in the ordered set where countryId = ? and active = ?.
 Region[] findByC_A_PrevAndNext(long regionId, long countryId, boolean active, OrderByComparator orderByComparator)
          Returns the regions before and after the current region in the ordered set where countryId = ? and active = ?.
 List<Region> findByC_A(long countryId, boolean active)
          Returns all the regions where countryId = ? and active = ?.
 List<Region> findByC_A(long countryId, boolean active, int start, int end)
          Returns a range of all the regions where countryId = ? and active = ?.
 List<Region> findByC_A(long countryId, boolean active, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the regions where countryId = ? and active = ?.
 Region findByC_R(long countryId, String regionCode)
          Returns the region where countryId = ? and regionCode = ? or throws a NoSuchRegionException if it could not be found.
 Region findByCountryId_First(long countryId, OrderByComparator orderByComparator)
          Returns the first region in the ordered set where countryId = ?.
 Region findByCountryId_Last(long countryId, OrderByComparator orderByComparator)
          Returns the last region in the ordered set where countryId = ?.
 Region[] findByCountryId_PrevAndNext(long regionId, long countryId, OrderByComparator orderByComparator)
          Returns the regions before and after the current region in the ordered set where countryId = ?.
 List<Region> findByCountryId(long countryId)
          Returns all the regions where countryId = ?.
 List<Region> findByCountryId(long countryId, int start, int end)
          Returns a range of all the regions where countryId = ?.
 List<Region> findByCountryId(long countryId, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the regions where countryId = ?.
 Region findByPrimaryKey(long regionId)
          Returns the region with the primary key or throws a NoSuchRegionException if it could not be found.
 Region remove(long regionId)
          Removes the region with the primary key from the database.
 void removeAll()
          Removes all the regions from the database.
 void removeByActive(boolean active)
          Removes all the regions where active = ? from the database.
 void removeByC_A(long countryId, boolean active)
          Removes all the regions where countryId = ? and active = ? from the database.
 Region removeByC_R(long countryId, String regionCode)
          Removes the region where countryId = ? and regionCode = ? from the database.
 void removeByCountryId(long countryId)
          Removes all the regions where countryId = ? from the database.
 Region updateImpl(Region region, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(Region region)
Caches the region in the entity cache if it is enabled.

Parameters:
region - the region

cacheResult

void cacheResult(List<Region> regions)
Caches the regions in the entity cache if it is enabled.

Parameters:
regions - the regions

create

Region create(long regionId)
Creates a new region with the primary key. Does not add the region to the database.

Parameters:
regionId - the primary key for the new region
Returns:
the new region

remove

Region remove(long regionId)
              throws NoSuchRegionException,
                     SystemException
Removes the region with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
regionId - the primary key of the region
Returns:
the region that was removed
Throws:
NoSuchRegionException - if a region with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

Region updateImpl(Region region,
                  boolean merge)
                  throws SystemException
Throws:
SystemException

findByPrimaryKey

Region findByPrimaryKey(long regionId)
                        throws NoSuchRegionException,
                               SystemException
Returns the region with the primary key or throws a NoSuchRegionException if it could not be found.

Parameters:
regionId - the primary key of the region
Returns:
the region
Throws:
NoSuchRegionException - if a region with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

Region fetchByPrimaryKey(long regionId)
                         throws SystemException
Returns the region with the primary key or returns null if it could not be found.

Parameters:
regionId - the primary key of the region
Returns:
the region, or null if a region with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findByCountryId

List<Region> findByCountryId(long countryId)
                             throws SystemException
Returns all the regions where countryId = ?.

Parameters:
countryId - the country ID
Returns:
the matching regions
Throws:
SystemException - if a system exception occurred

findByCountryId

List<Region> findByCountryId(long countryId,
                             int start,
                             int end)
                             throws SystemException
Returns a range of all the regions where countryId = ?.

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.

Parameters:
countryId - the country ID
start - the lower bound of the range of regions
end - the upper bound of the range of regions (not inclusive)
Returns:
the range of matching regions
Throws:
SystemException - if a system exception occurred

findByCountryId

List<Region> findByCountryId(long countryId,
                             int start,
                             int end,
                             OrderByComparator orderByComparator)
                             throws SystemException
Returns an ordered range of all the regions where countryId = ?.

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.

Parameters:
countryId - the country ID
start - the lower bound of the range of regions
end - the upper bound of the range of regions (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching regions
Throws:
SystemException - if a system exception occurred

findByCountryId_First

Region findByCountryId_First(long countryId,
                             OrderByComparator orderByComparator)
                             throws NoSuchRegionException,
                                    SystemException
Returns the first region in the ordered set where countryId = ?.

Parameters:
countryId - the country ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching region
Throws:
NoSuchRegionException - if a matching region could not be found
SystemException - if a system exception occurred

fetchByCountryId_First

Region fetchByCountryId_First(long countryId,
                              OrderByComparator orderByComparator)
                              throws SystemException
Returns the first region in the ordered set where countryId = ?.

Parameters:
countryId - the country ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching region, or null if a matching region could not be found
Throws:
SystemException - if a system exception occurred

findByCountryId_Last

Region findByCountryId_Last(long countryId,
                            OrderByComparator orderByComparator)
                            throws NoSuchRegionException,
                                   SystemException
Returns the last region in the ordered set where countryId = ?.

Parameters:
countryId - the country ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching region
Throws:
NoSuchRegionException - if a matching region could not be found
SystemException - if a system exception occurred

fetchByCountryId_Last

Region fetchByCountryId_Last(long countryId,
                             OrderByComparator orderByComparator)
                             throws SystemException
Returns the last region in the ordered set where countryId = ?.

Parameters:
countryId - the country ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching region, or null if a matching region could not be found
Throws:
SystemException - if a system exception occurred

findByCountryId_PrevAndNext

Region[] findByCountryId_PrevAndNext(long regionId,
                                     long countryId,
                                     OrderByComparator orderByComparator)
                                     throws NoSuchRegionException,
                                            SystemException
Returns the regions before and after the current region in the ordered set where countryId = ?.

Parameters:
regionId - the primary key of the current region
countryId - the country ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the previous, current, and next region
Throws:
NoSuchRegionException - if a region with the primary key could not be found
SystemException - if a system exception occurred

findByActive

List<Region> findByActive(boolean active)
                          throws SystemException
Returns all the regions where active = ?.

Parameters:
active - the active
Returns:
the matching regions
Throws:
SystemException - if a system exception occurred

findByActive

List<Region> findByActive(boolean active,
                          int start,
                          int end)
                          throws SystemException
Returns a range of all the regions 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.

Parameters:
active - the active
start - the lower bound of the range of regions
end - the upper bound of the range of regions (not inclusive)
Returns:
the range of matching regions
Throws:
SystemException - if a system exception occurred

findByActive

List<Region> findByActive(boolean active,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                          throws SystemException
Returns an ordered range of all the regions 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.

Parameters:
active - the active
start - the lower bound of the range of regions
end - the upper bound of the range of regions (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching regions
Throws:
SystemException - if a system exception occurred

findByActive_First

Region findByActive_First(boolean active,
                          OrderByComparator orderByComparator)
                          throws NoSuchRegionException,
                                 SystemException
Returns the first region in the ordered set where active = ?.

Parameters:
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching region
Throws:
NoSuchRegionException - if a matching region could not be found
SystemException - if a system exception occurred

fetchByActive_First

Region fetchByActive_First(boolean active,
                           OrderByComparator orderByComparator)
                           throws SystemException
Returns the first region in the ordered set where active = ?.

Parameters:
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching region, or null if a matching region could not be found
Throws:
SystemException - if a system exception occurred

findByActive_Last

Region findByActive_Last(boolean active,
                         OrderByComparator orderByComparator)
                         throws NoSuchRegionException,
                                SystemException
Returns the last region in the ordered set where active = ?.

Parameters:
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching region
Throws:
NoSuchRegionException - if a matching region could not be found
SystemException - if a system exception occurred

fetchByActive_Last

Region fetchByActive_Last(boolean active,
                          OrderByComparator orderByComparator)
                          throws SystemException
Returns the last region in the ordered set where active = ?.

Parameters:
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching region, or null if a matching region could not be found
Throws:
SystemException - if a system exception occurred

findByActive_PrevAndNext

Region[] findByActive_PrevAndNext(long regionId,
                                  boolean active,
                                  OrderByComparator orderByComparator)
                                  throws NoSuchRegionException,
                                         SystemException
Returns the regions before and after the current region in the ordered set where active = ?.

Parameters:
regionId - the primary key of the current region
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the previous, current, and next region
Throws:
NoSuchRegionException - if a region with the primary key could not be found
SystemException - if a system exception occurred

findByC_R

Region findByC_R(long countryId,
                 String regionCode)
                 throws NoSuchRegionException,
                        SystemException
Returns the region where countryId = ? and regionCode = ? or throws a NoSuchRegionException if it could not be found.

Parameters:
countryId - the country ID
regionCode - the region code
Returns:
the matching region
Throws:
NoSuchRegionException - if a matching region could not be found
SystemException - if a system exception occurred

fetchByC_R

Region fetchByC_R(long countryId,
                  String regionCode)
                  throws SystemException
Returns the region where countryId = ? and regionCode = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
countryId - the country ID
regionCode - the region code
Returns:
the matching region, or null if a matching region could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_R

Region fetchByC_R(long countryId,
                  String regionCode,
                  boolean retrieveFromCache)
                  throws SystemException
Returns the region where countryId = ? and regionCode = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
countryId - the country ID
regionCode - the region code
retrieveFromCache - whether to use the finder cache
Returns:
the matching region, or null if a matching region could not be found
Throws:
SystemException - if a system exception occurred

findByC_A

List<Region> findByC_A(long countryId,
                       boolean active)
                       throws SystemException
Returns all the regions where countryId = ? and active = ?.

Parameters:
countryId - the country ID
active - the active
Returns:
the matching regions
Throws:
SystemException - if a system exception occurred

findByC_A

List<Region> findByC_A(long countryId,
                       boolean active,
                       int start,
                       int end)
                       throws SystemException
Returns a range of all the regions where countryId = ? and 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.

Parameters:
countryId - the country ID
active - the active
start - the lower bound of the range of regions
end - the upper bound of the range of regions (not inclusive)
Returns:
the range of matching regions
Throws:
SystemException - if a system exception occurred

findByC_A

List<Region> findByC_A(long countryId,
                       boolean active,
                       int start,
                       int end,
                       OrderByComparator orderByComparator)
                       throws SystemException
Returns an ordered range of all the regions where countryId = ? and 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.

Parameters:
countryId - the country ID
active - the active
start - the lower bound of the range of regions
end - the upper bound of the range of regions (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching regions
Throws:
SystemException - if a system exception occurred

findByC_A_First

Region findByC_A_First(long countryId,
                       boolean active,
                       OrderByComparator orderByComparator)
                       throws NoSuchRegionException,
                              SystemException
Returns the first region in the ordered set where countryId = ? and active = ?.

Parameters:
countryId - the country ID
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching region
Throws:
NoSuchRegionException - if a matching region could not be found
SystemException - if a system exception occurred

fetchByC_A_First

Region fetchByC_A_First(long countryId,
                        boolean active,
                        OrderByComparator orderByComparator)
                        throws SystemException
Returns the first region in the ordered set where countryId = ? and active = ?.

Parameters:
countryId - the country ID
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching region, or null if a matching region could not be found
Throws:
SystemException - if a system exception occurred

findByC_A_Last

Region findByC_A_Last(long countryId,
                      boolean active,
                      OrderByComparator orderByComparator)
                      throws NoSuchRegionException,
                             SystemException
Returns the last region in the ordered set where countryId = ? and active = ?.

Parameters:
countryId - the country ID
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching region
Throws:
NoSuchRegionException - if a matching region could not be found
SystemException - if a system exception occurred

fetchByC_A_Last

Region fetchByC_A_Last(long countryId,
                       boolean active,
                       OrderByComparator orderByComparator)
                       throws SystemException
Returns the last region in the ordered set where countryId = ? and active = ?.

Parameters:
countryId - the country ID
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching region, or null if a matching region could not be found
Throws:
SystemException - if a system exception occurred

findByC_A_PrevAndNext

Region[] findByC_A_PrevAndNext(long regionId,
                               long countryId,
                               boolean active,
                               OrderByComparator orderByComparator)
                               throws NoSuchRegionException,
                                      SystemException
Returns the regions before and after the current region in the ordered set where countryId = ? and active = ?.

Parameters:
regionId - the primary key of the current region
countryId - the country ID
active - the active
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the previous, current, and next region
Throws:
NoSuchRegionException - if a region with the primary key could not be found
SystemException - if a system exception occurred

findAll

List<Region> findAll()
                     throws SystemException
Returns all the regions.

Returns:
the regions
Throws:
SystemException - if a system exception occurred

findAll

List<Region> findAll(int start,
                     int end)
                     throws SystemException
Returns a range of all the regions.

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.

Parameters:
start - the lower bound of the range of regions
end - the upper bound of the range of regions (not inclusive)
Returns:
the range of regions
Throws:
SystemException - if a system exception occurred

findAll

List<Region> findAll(int start,
                     int end,
                     OrderByComparator orderByComparator)
                     throws SystemException
Returns an ordered range of all the regions.

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.

Parameters:
start - the lower bound of the range of regions
end - the upper bound of the range of regions (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of regions
Throws:
SystemException - if a system exception occurred

removeByCountryId

void removeByCountryId(long countryId)
                       throws SystemException
Removes all the regions where countryId = ? from the database.

Parameters:
countryId - the country ID
Throws:
SystemException - if a system exception occurred

removeByActive

void removeByActive(boolean active)
                    throws SystemException
Removes all the regions where active = ? from the database.

Parameters:
active - the active
Throws:
SystemException - if a system exception occurred

removeByC_R

Region removeByC_R(long countryId,
                   String regionCode)
                   throws NoSuchRegionException,
                          SystemException
Removes the region where countryId = ? and regionCode = ? from the database.

Parameters:
countryId - the country ID
regionCode - the region code
Returns:
the region that was removed
Throws:
SystemException - if a system exception occurred
NoSuchRegionException

removeByC_A

void removeByC_A(long countryId,
                 boolean active)
                 throws SystemException
Removes all the regions where countryId = ? and active = ? from the database.

Parameters:
countryId - the country ID
active - the active
Throws:
SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException
Removes all the regions from the database.

Throws:
SystemException - if a system exception occurred

countByCountryId

int countByCountryId(long countryId)
                     throws SystemException
Returns the number of regions where countryId = ?.

Parameters:
countryId - the country ID
Returns:
the number of matching regions
Throws:
SystemException - if a system exception occurred

countByActive

int countByActive(boolean active)
                  throws SystemException
Returns the number of regions where active = ?.

Parameters:
active - the active
Returns:
the number of matching regions
Throws:
SystemException - if a system exception occurred

countByC_R

int countByC_R(long countryId,
               String regionCode)
               throws SystemException
Returns the number of regions where countryId = ? and regionCode = ?.

Parameters:
countryId - the country ID
regionCode - the region code
Returns:
the number of matching regions
Throws:
SystemException - if a system exception occurred

countByC_A

int countByC_A(long countryId,
               boolean active)
               throws SystemException
Returns the number of regions where countryId = ? and active = ?.

Parameters:
countryId - the country ID
active - the active
Returns:
the number of matching regions
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Returns the number of regions.

Returns:
the number of regions
Throws:
SystemException - if a system exception occurred

Liferay 6.1.2-ce-ga3