com.liferay.portal.service.persistence.CountryPersistence Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service.persistence;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.model.Country;
/**
* The persistence interface for the country service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see CountryPersistenceImpl
* @see CountryUtil
* @generated
*/
@ProviderType
public interface CountryPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link CountryUtil} to access the country persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns the country where name = ? or throws a {@link com.liferay.portal.NoSuchCountryException} if it could not be found.
*
* @param name the name
* @return the matching country
* @throws com.liferay.portal.NoSuchCountryException if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country findByName(java.lang.String name)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country where name = ? or returns null if it could not be found. Uses the finder cache.
*
* @param name the name
* @return the matching country, or null if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country fetchByName(java.lang.String name)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country where name = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param name the name
* @param retrieveFromCache whether to use the finder cache
* @return the matching country, or null if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country fetchByName(java.lang.String name,
boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the country where name = ? from the database.
*
* @param name the name
* @return the country that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country removeByName(java.lang.String name)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of countries where name = ?.
*
* @param name the name
* @return the number of matching countries
* @throws SystemException if a system exception occurred
*/
public int countByName(java.lang.String name)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country where a2 = ? or throws a {@link com.liferay.portal.NoSuchCountryException} if it could not be found.
*
* @param a2 the a2
* @return the matching country
* @throws com.liferay.portal.NoSuchCountryException if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country findByA2(java.lang.String a2)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country where a2 = ? or returns null if it could not be found. Uses the finder cache.
*
* @param a2 the a2
* @return the matching country, or null if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country fetchByA2(java.lang.String a2)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country where a2 = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param a2 the a2
* @param retrieveFromCache whether to use the finder cache
* @return the matching country, or null if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country fetchByA2(java.lang.String a2,
boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the country where a2 = ? from the database.
*
* @param a2 the a2
* @return the country that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country removeByA2(java.lang.String a2)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of countries where a2 = ?.
*
* @param a2 the a2
* @return the number of matching countries
* @throws SystemException if a system exception occurred
*/
public int countByA2(java.lang.String a2)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country where a3 = ? or throws a {@link com.liferay.portal.NoSuchCountryException} if it could not be found.
*
* @param a3 the a3
* @return the matching country
* @throws com.liferay.portal.NoSuchCountryException if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country findByA3(java.lang.String a3)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country where a3 = ? or returns null if it could not be found. Uses the finder cache.
*
* @param a3 the a3
* @return the matching country, or null if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country fetchByA3(java.lang.String a3)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country where a3 = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param a3 the a3
* @param retrieveFromCache whether to use the finder cache
* @return the matching country, or null if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country fetchByA3(java.lang.String a3,
boolean retrieveFromCache)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes the country where a3 = ? from the database.
*
* @param a3 the a3
* @return the country that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country removeByA3(java.lang.String a3)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of countries where a3 = ?.
*
* @param a3 the a3
* @return the number of matching countries
* @throws SystemException if a system exception occurred
*/
public int countByA3(java.lang.String a3)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the countries where active = ?.
*
* @param active the active
* @return the matching countries
* @throws SystemException if a system exception occurred
*/
public java.util.List findByActive(
boolean active)
throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param active the active
* @param start the lower bound of the range of countries
* @param end the upper bound of the range of countries (not inclusive)
* @return the range of matching countries
* @throws SystemException if a system exception occurred
*/
public java.util.List findByActive(
boolean active, int start, int end)
throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param active the active
* @param start the lower bound of the range of countries
* @param end the upper bound of the range of countries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching countries
* @throws SystemException if a system exception occurred
*/
public java.util.List findByActive(
boolean active, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first country in the ordered set where active = ?.
*
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching country
* @throws com.liferay.portal.NoSuchCountryException if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country findByActive_First(boolean active,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the first country in the ordered set where active = ?.
*
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching country, or null if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country fetchByActive_First(
boolean active,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last country in the ordered set where active = ?.
*
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching country
* @throws com.liferay.portal.NoSuchCountryException if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country findByActive_Last(boolean active,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the last country in the ordered set where active = ?.
*
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching country, or null if a matching country could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country fetchByActive_Last(boolean active,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the countries before and after the current country in the ordered set where active = ?.
*
* @param countryId the primary key of the current country
* @param active the active
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next country
* @throws com.liferay.portal.NoSuchCountryException if a country with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country[] findByActive_PrevAndNext(
long countryId, boolean active,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the countries where active = ? from the database.
*
* @param active the active
* @throws SystemException if a system exception occurred
*/
public void removeByActive(boolean active)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of countries where active = ?.
*
* @param active the active
* @return the number of matching countries
* @throws SystemException if a system exception occurred
*/
public int countByActive(boolean active)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Caches the country in the entity cache if it is enabled.
*
* @param country the country
*/
public void cacheResult(com.liferay.portal.model.Country country);
/**
* Caches the countries in the entity cache if it is enabled.
*
* @param countries the countries
*/
public void cacheResult(
java.util.List countries);
/**
* Creates a new country with the primary key. Does not add the country to the database.
*
* @param countryId the primary key for the new country
* @return the new country
*/
public com.liferay.portal.model.Country create(long countryId);
/**
* Removes the country with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param countryId the primary key of the country
* @return the country that was removed
* @throws com.liferay.portal.NoSuchCountryException if a country with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country remove(long countryId)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Country updateImpl(
com.liferay.portal.model.Country country)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country with the primary key or throws a {@link com.liferay.portal.NoSuchCountryException} if it could not be found.
*
* @param countryId the primary key of the country
* @return the country
* @throws com.liferay.portal.NoSuchCountryException if a country with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country findByPrimaryKey(long countryId)
throws com.liferay.portal.NoSuchCountryException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the country with the primary key or returns null if it could not be found.
*
* @param countryId the primary key of the country
* @return the country, or null if a country with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Country fetchByPrimaryKey(long countryId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns all the countries.
*
* @return the countries
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll()
throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of countries
* @param end the upper bound of the range of countries (not inclusive)
* @return the range of countries
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(int start,
int end) throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of countries
* @param end the upper bound of the range of countries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of countries
* @throws SystemException if a system exception occurred
*/
public java.util.List findAll(int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Removes all the countries from the database.
*
* @throws SystemException if a system exception occurred
*/
public void removeAll()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of countries.
*
* @return the number of countries
* @throws SystemException if a system exception occurred
*/
public int countAll()
throws com.liferay.portal.kernel.exception.SystemException;
}