com.liferay.portal.kernel.service

Interface CountryLocalService

All Superinterfaces:

BaseLocalService, CTService<Country>, PersistedModelLocalService

All Known Implementing Classes:

CountryLocalServiceWrapper

@CTAware
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface CountryLocalService
extends BaseLocalService, CTService<Country>, PersistedModelLocalService

Provides the local service interface for Country. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

CountryLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
Country	addCountry(Country country) Adds the country to the database.
Country	addCountry(java.lang.String a2, java.lang.String a3, boolean active, boolean billingAllowed, java.lang.String idd, java.lang.String name, java.lang.String number, double position, boolean shippingAllowed, boolean subjectToVAT, boolean zipRequired, ServiceContext serviceContext)
Country	createCountry(long countryId) Creates a new country with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
void	deleteCompanyCountries(long companyId)
Country	deleteCountry(Country country) Deletes the country from the database.
Country	deleteCountry(long countryId) Deletes the country with the primary key from the database.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
Country	fetchCountry(long countryId)
Country	fetchCountryByA2(long companyId, java.lang.String a2)
Country	fetchCountryByA3(long companyId, java.lang.String a3)
Country	fetchCountryByName(long companyId, java.lang.String name)
Country	fetchCountryByNumber(long companyId, java.lang.String number)
Country	fetchCountryByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the country with the matching UUID and company.
CountryLocalization	fetchCountryLocalization(long countryId, java.lang.String languageId)
ActionableDynamicQuery	getActionableDynamicQuery()
java.util.List<Country>	getCompanyCountries(long companyId)
java.util.List<Country>	getCompanyCountries(long companyId, boolean active)
java.util.List<Country>	getCompanyCountries(long companyId, boolean active, int start, int end, OrderByComparator<Country> orderByComparator)
java.util.List<Country>	getCompanyCountries(long companyId, int start, int end, OrderByComparator<Country> orderByComparator)
int	getCompanyCountriesCount(long companyId)
int	getCompanyCountriesCount(long companyId, boolean active)
java.util.List<Country>	getCountries(int start, int end) Returns a range of all the countries.
int	getCountriesCount() Returns the number of countries.
Country	getCountry(long countryId) Returns the country with the primary key.
Country	getCountryByA2(long companyId, java.lang.String a2)
Country	getCountryByA3(long companyId, java.lang.String a3)
Country	getCountryByName(long companyId, java.lang.String name)
Country	getCountryByNumber(long companyId, java.lang.String number)
Country	getCountryByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the country with the matching UUID and company.
CountryLocalization	getCountryLocalization(long countryId, java.lang.String languageId)
java.util.List<CountryLocalization>	getCountryLocalizations(long countryId)
CTPersistence<Country>	getCTPersistence()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.Class<Country>	getModelClass()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
BaseModelSearchResult<Country>	searchCountries(long companyId, java.lang.Boolean active, java.lang.String keywords, int start, int end, OrderByComparator<Country> orderByComparator)
Country	updateActive(long countryId, boolean active)
Country	updateCountry(Country country) Updates the country in the database or adds it if it does not yet exist.
Country	updateCountry(long countryId, java.lang.String a2, java.lang.String a3, boolean active, boolean billingAllowed, java.lang.String idd, java.lang.String name, java.lang.String number, double position, boolean shippingAllowed, boolean subjectToVAT)
CountryLocalization	updateCountryLocalization(Country country, java.lang.String languageId, java.lang.String title)
java.util.List<CountryLocalization>	updateCountryLocalizations(Country country, java.util.Map<java.lang.String,java.lang.String> titleMap)
Country	updateGroupFilterEnabled(long countryId, boolean groupFilterEnabled)
<R,E extends java.lang.Throwable> R	updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Country>,R,E> updateUnsafeFunction)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addCountry

@Indexable(type=REINDEX)
Country addCountry(Country country)

Adds the country to the database. Also notifies the appropriate model listeners.

Important: Inspect CountryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

country - the country

Returns:

the country that was added

addCountry

Country addCountry(java.lang.String a2,
                   java.lang.String a3,
                   boolean active,
                   boolean billingAllowed,
                   java.lang.String idd,
                   java.lang.String name,
                   java.lang.String number,
                   double position,
                   boolean shippingAllowed,
                   boolean subjectToVAT,
                   boolean zipRequired,
                   ServiceContext serviceContext)
            throws PortalException

Throws:

PortalException

createCountry

@Transactional(enabled=false)
Country createCountry(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

createPersistedModel

PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteCompanyCountries

void deleteCompanyCountries(long companyId)
                     throws PortalException

Throws:

PortalException

deleteCountry

@Indexable(type=DELETE)
 @SystemEvent(type=1)
Country deleteCountry(Country country)
                                                             throws PortalException

Deletes the country from the database. Also notifies the appropriate model listeners.

Important: Inspect CountryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

country - the country

Returns:

the country that was removed

Throws:

PortalException

deleteCountry

@Indexable(type=DELETE)
Country deleteCountry(long countryId)
                                       throws PortalException

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

Important: Inspect CountryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

countryId - the primary key of the country

Returns:

the country that was removed

Throws:

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface PersistedModelLocalService

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface PersistedModelLocalService

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end)

Performs a dynamic query on the database and returns a range of the matching rows.

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 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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.CountryModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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 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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.CountryModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

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

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchCountry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country fetchCountry(long countryId)

fetchCountryByA2

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country fetchCountryByA2(long companyId,
                                                                                            java.lang.String a2)

fetchCountryByA3

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country fetchCountryByA3(long companyId,
                                                                                            java.lang.String a3)

fetchCountryByName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country fetchCountryByName(long companyId,
                                                                                              java.lang.String name)

fetchCountryByNumber

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country fetchCountryByNumber(long companyId,
                                                                                                java.lang.String number)

fetchCountryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country fetchCountryByUuidAndCompanyId(java.lang.String uuid,
                                                                                                          long companyId)

Returns the country with the matching UUID and company.

Parameters:

uuid - the country's UUID

companyId - the primary key of the company

Returns:

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

fetchCountryLocalization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CountryLocalization fetchCountryLocalization(long countryId,
                                                                                                                java.lang.String languageId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getCompanyCountries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Country> getCompanyCountries(long companyId)

getCompanyCountries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Country> getCompanyCountries(long companyId,
                                                                                                               boolean active)

getCompanyCountries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Country> getCompanyCountries(long companyId,
                                                                                                               boolean active,
                                                                                                               int start,
                                                                                                               int end,
                                                                                                               OrderByComparator<Country> orderByComparator)

getCompanyCountries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Country> getCompanyCountries(long companyId,
                                                                                                               int start,
                                                                                                               int end,
                                                                                                               OrderByComparator<Country> orderByComparator)

getCompanyCountriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyCountriesCount(long companyId)

getCompanyCountriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyCountriesCount(long companyId,
                                                                                                boolean active)

getCountries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Country> getCountries(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 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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.CountryModelImpl.

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

getCountriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCountriesCount()

Returns the number of countries.

Returns:

the number of countries

getCountry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country getCountry(long countryId)
                                                                               throws PortalException

Returns the country with the primary key.

Parameters:

countryId - the primary key of the country

Returns:

the country

Throws:

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

getCountryByA2

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country getCountryByA2(long companyId,
                                                                                          java.lang.String a2)
                                                                                   throws PortalException

Throws:

PortalException

getCountryByA3

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country getCountryByA3(long companyId,
                                                                                          java.lang.String a3)
                                                                                   throws PortalException

Throws:

PortalException

getCountryByName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country getCountryByName(long companyId,
                                                                                            java.lang.String name)
                                                                                     throws PortalException

Throws:

PortalException

getCountryByNumber

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country getCountryByNumber(long companyId,
                                                                                              java.lang.String number)
                                                                                       throws PortalException

Throws:

PortalException

getCountryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Country getCountryByUuidAndCompanyId(java.lang.String uuid,
                                                                                                        long companyId)
                                                                                                 throws PortalException

Returns the country with the matching UUID and company.

Parameters:

uuid - the country's UUID

companyId - the primary key of the company

Returns:

the matching country

Throws:

PortalException - if a matching country could not be found

getCountryLocalization

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CountryLocalization getCountryLocalization(long countryId,
                                                                                                              java.lang.String languageId)
                                                                                                       throws PortalException

Throws:

PortalException

getCountryLocalizations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CountryLocalization> getCountryLocalizations(long countryId)

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

searchCountries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<Country> searchCountries(long companyId,
                                                                                                                  java.lang.Boolean active,
                                                                                                                  java.lang.String keywords,
                                                                                                                  int start,
                                                                                                                  int end,
                                                                                                                  OrderByComparator<Country> orderByComparator)
                                                                                                           throws PortalException

Throws:

PortalException

updateActive

Country updateActive(long countryId,
                     boolean active)
              throws PortalException

Throws:

PortalException

updateCountry

@Indexable(type=REINDEX)
Country updateCountry(Country country)

Updates the country in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect CountryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

country - the country

Returns:

the country that was updated

updateCountry

Country updateCountry(long countryId,
                      java.lang.String a2,
                      java.lang.String a3,
                      boolean active,
                      boolean billingAllowed,
                      java.lang.String idd,
                      java.lang.String name,
                      java.lang.String number,
                      double position,
                      boolean shippingAllowed,
                      boolean subjectToVAT)
               throws PortalException

Throws:

PortalException

updateCountryLocalization

CountryLocalization updateCountryLocalization(Country country,
                                              java.lang.String languageId,
                                              java.lang.String title)
                                       throws PortalException

Throws:

PortalException

updateCountryLocalizations

java.util.List<CountryLocalization> updateCountryLocalizations(Country country,
                                                               java.util.Map<java.lang.String,java.lang.String> titleMap)
                                                        throws PortalException

Throws:

PortalException

updateGroupFilterEnabled

Country updateGroupFilterEnabled(long countryId,
                                 boolean groupFilterEnabled)
                          throws PortalException

Throws:

PortalException

getCTPersistence

@Transactional(enabled=false)
CTPersistence<Country> getCTPersistence()

Specified by:

getCTPersistence in interface CTService<Country>

getModelClass

@Transactional(enabled=false)
java.lang.Class<Country> getModelClass()

Specified by:

getModelClass in interface CTService<Country>

updateWithUnsafeFunction

@Transactional(rollbackFor=java.lang.Throwable.class)
<R,E extends java.lang.Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Country>,R,E> updateUnsafeFunction)
                                                                                                            throws E extends java.lang.Throwable

Specified by:

updateWithUnsafeFunction in interface CTService<Country>

Throws:

E extends java.lang.Throwable