com.liferay.commerce.service

Interface CommerceRegionLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

CommerceRegionLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface CommerceRegionLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for CommerceRegion. 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.

See Also:

CommerceRegionLocalServiceUtil, com.liferay.commerce.service.base.CommerceRegionLocalServiceBaseImpl, com.liferay.commerce.service.impl.CommerceRegionLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
CommerceRegion	addCommerceRegion(CommerceRegion commerceRegion) Adds the commerce region to the database.
CommerceRegion	addCommerceRegion(long commerceCountryId, java.lang.String name, java.lang.String code, double priority, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext)
CommerceRegion	createCommerceRegion(long commerceRegionId) Creates a new commerce region with the primary key.
CommerceRegion	deleteCommerceRegion(CommerceRegion commerceRegion) Deletes the commerce region from the database.
CommerceRegion	deleteCommerceRegion(long commerceRegionId) Deletes the commerce region with the primary key from the database.
void	deleteCommerceRegions(long commerceCountryId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
CommerceRegion	fetchCommerceRegion(long commerceRegionId)
CommerceRegion	fetchCommerceRegionByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the commerce region matching the UUID and group.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
CommerceRegion	getCommerceRegion(long commerceRegionId) Returns the commerce region with the primary key.
CommerceRegion	getCommerceRegion(long commerceCountryId, java.lang.String code)
CommerceRegion	getCommerceRegionByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the commerce region matching the UUID and group.
java.util.List<CommerceRegion>	getCommerceRegions(int start, int end) Returns a range of all the commerce regions.
java.util.List<CommerceRegion>	getCommerceRegions(long commerceCountryId, boolean active)
java.util.List<CommerceRegion>	getCommerceRegions(long commerceCountryId, boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceRegion> orderByComparator)
java.util.List<CommerceRegion>	getCommerceRegions(long commerceCountryId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceRegion> orderByComparator)
java.util.List<CommerceRegion>	getCommerceRegionsByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the commerce regions matching the UUID and company.
java.util.List<CommerceRegion>	getCommerceRegionsByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceRegion> orderByComparator) Returns a range of commerce regions matching the UUID and company.
int	getCommerceRegionsCount() Returns the number of commerce regions.
int	getCommerceRegionsCount(long commerceCountryId)
int	getCommerceRegionsCount(long commerceCountryId, boolean active)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
CommerceRegion	setActive(long commerceRegionId, boolean active)
CommerceRegion	updateCommerceRegion(CommerceRegion commerceRegion) Updates the commerce region in the database or adds it if it does not yet exist.
CommerceRegion	updateCommerceRegion(long commerceRegionId, java.lang.String name, java.lang.String code, double priority, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Method Detail

addCommerceRegion

@Indexable(type=REINDEX)
CommerceRegion addCommerceRegion(CommerceRegion commerceRegion)

Adds the commerce region to the database. Also notifies the appropriate model listeners.

Parameters:

commerceRegion - the commerce region

Returns:

the commerce region that was added

addCommerceRegion

CommerceRegion addCommerceRegion(long commerceCountryId,
                                 java.lang.String name,
                                 java.lang.String code,
                                 double priority,
                                 boolean active,
                                 com.liferay.portal.kernel.service.ServiceContext serviceContext)
                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceRegion

@Transactional(enabled=false)
CommerceRegion createCommerceRegion(long commerceRegionId)

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

Parameters:

commerceRegionId - the primary key for the new commerce region

Returns:

the new commerce region

deleteCommerceRegion

@Indexable(type=DELETE)
 @SystemEvent(type=1)
CommerceRegion deleteCommerceRegion(CommerceRegion commerceRegion)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Deletes the commerce region from the database. Also notifies the appropriate model listeners.

Parameters:

commerceRegion - the commerce region

Returns:

the commerce region that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceRegion

@Indexable(type=DELETE)
CommerceRegion deleteCommerceRegion(long commerceRegionId)
                                                     throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

commerceRegionId - the primary key of the commerce region

Returns:

the commerce region that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a commerce region with the primary key could not be found

deleteCommerceRegions

void deleteCommerceRegions(long commerceCountryId)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 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 com.liferay.commerce.model.impl.CommerceRegionModelImpl. 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:

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

<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                   int start,
                                   int end,
                                   com.liferay.portal.kernel.util.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 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 com.liferay.commerce.model.impl.CommerceRegionModelImpl. 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:

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

long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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

long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                       com.liferay.portal.kernel.dao.orm.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

fetchCommerceRegion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceRegion fetchCommerceRegion(long commerceRegionId)

fetchCommerceRegionByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceRegion fetchCommerceRegionByUuidAndGroupId(java.lang.String uuid,
                                                                                                                      long groupId)

Returns the commerce region matching the UUID and group.

Parameters:

uuid - the commerce region's UUID

groupId - the primary key of the group

Returns:

the matching commerce region, or null if a matching commerce region could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCommerceRegion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceRegion getCommerceRegion(long commerceRegionId)
                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce region with the primary key.

Parameters:

commerceRegionId - the primary key of the commerce region

Returns:

the commerce region

Throws:

com.liferay.portal.kernel.exception.PortalException - if a commerce region with the primary key could not be found

getCommerceRegion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceRegion getCommerceRegion(long commerceCountryId,
                                                                                                    java.lang.String code)
                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceRegionByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceRegion getCommerceRegionByUuidAndGroupId(java.lang.String uuid,
                                                                                                                    long groupId)
                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce region matching the UUID and group.

Parameters:

uuid - the commerce region's UUID

groupId - the primary key of the group

Returns:

the matching commerce region

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching commerce region could not be found

getCommerceRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceRegion> getCommerceRegions(int start,
                                                                                                                     int end)

Returns a range of all the commerce 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. 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 com.liferay.commerce.model.impl.CommerceRegionModelImpl. 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 commerce regions

end - the upper bound of the range of commerce regions (not inclusive)

Returns:

the range of commerce regions

getCommerceRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceRegion> getCommerceRegions(long commerceCountryId,
                                                                                                                     boolean active)

getCommerceRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceRegion> getCommerceRegions(long commerceCountryId,
                                                                                                                     boolean active,
                                                                                                                     int start,
                                                                                                                     int end,
                                                                                                                     com.liferay.portal.kernel.util.OrderByComparator<CommerceRegion> orderByComparator)

getCommerceRegions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceRegion> getCommerceRegions(long commerceCountryId,
                                                                                                                     int start,
                                                                                                                     int end,
                                                                                                                     com.liferay.portal.kernel.util.OrderByComparator<CommerceRegion> orderByComparator)

getCommerceRegionsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceRegion> getCommerceRegionsByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                       long companyId)

Returns all the commerce regions matching the UUID and company.

Parameters:

uuid - the UUID of the commerce regions

companyId - the primary key of the company

Returns:

the matching commerce regions, or an empty list if no matches were found

getCommerceRegionsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceRegion> getCommerceRegionsByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                       long companyId,
                                                                                                                                       int start,
                                                                                                                                       int end,
                                                                                                                                       com.liferay.portal.kernel.util.OrderByComparator<CommerceRegion> orderByComparator)

Returns a range of commerce regions matching the UUID and company.

Parameters:

uuid - the UUID of the commerce regions

companyId - the primary key of the company

start - the lower bound of the range of commerce regions

end - the upper bound of the range of commerce regions (not inclusive)

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

Returns:

the range of matching commerce regions, or an empty list if no matches were found

getCommerceRegionsCount

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

Returns the number of commerce regions.

Returns:

the number of commerce regions

getCommerceRegionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceRegionsCount(long commerceCountryId)

getCommerceRegionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceRegionsCount(long commerceCountryId,
                                                                                               boolean active)

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

setActive

CommerceRegion setActive(long commerceRegionId,
                         boolean active)
                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceRegion

@Indexable(type=REINDEX)
CommerceRegion updateCommerceRegion(CommerceRegion commerceRegion)

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

Parameters:

commerceRegion - the commerce region

Returns:

the commerce region that was updated

updateCommerceRegion

CommerceRegion updateCommerceRegion(long commerceRegionId,
                                    java.lang.String name,
                                    java.lang.String code,
                                    double priority,
                                    boolean active,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException