com.liferay.commerce.service

Class CommerceRegionLocalServiceUtil

java.lang.Object

com.liferay.commerce.service.CommerceRegionLocalServiceUtil

@ProviderType
public class CommerceRegionLocalServiceUtil
extends java.lang.Object

Provides the local service utility for CommerceRegion. This utility wraps com.liferay.commerce.service.impl.CommerceRegionLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

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

Generated:

Constructor Summary

Constructors

Constructor and Description
CommerceRegionLocalServiceUtil()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommerceRegionLocalServiceUtil

public CommerceRegionLocalServiceUtil()

Method Detail

addCommerceRegion

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

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

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

public static 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:

PortalException

deleteCommerceRegion

public static 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:

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

deleteCommerceRegions

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePersistedModel

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

Throws:

PortalException

dynamicQuery

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

dynamicQuery

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

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

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

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

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

public static CommerceRegion fetchCommerceRegion(long commerceRegionId)

fetchCommerceRegionByUuidAndGroupId

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

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCommerceRegion

public static 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:

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

getCommerceRegion

public static CommerceRegion getCommerceRegion(long commerceCountryId,
                                               java.lang.String code)
                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceRegionByUuidAndGroupId

public static 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:

PortalException - if a matching commerce region could not be found

getCommerceRegions

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

public static java.util.List<CommerceRegion> getCommerceRegions(long commerceCountryId,
                                                                boolean active)

getCommerceRegions

public static java.util.List<CommerceRegion> getCommerceRegions(long commerceCountryId,
                                                                boolean active,
                                                                int start,
                                                                int end,
                                                                com.liferay.portal.kernel.util.OrderByComparator<CommerceRegion> orderByComparator)

getCommerceRegions

public static java.util.List<CommerceRegion> getCommerceRegions(long commerceCountryId,
                                                                int start,
                                                                int end,
                                                                com.liferay.portal.kernel.util.OrderByComparator<CommerceRegion> orderByComparator)

getCommerceRegionsByUuidAndCompanyId

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

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

public static int getCommerceRegionsCount()

Returns the number of commerce regions.

Returns:

the number of commerce regions

getCommerceRegionsCount

public static int getCommerceRegionsCount(long commerceCountryId)

getCommerceRegionsCount

public static int getCommerceRegionsCount(long commerceCountryId,
                                          boolean active)

getExportActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

setActive

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

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceRegion

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

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

getService

public static CommerceRegionLocalService getService()