com.liferay.commerce.service

Class CommerceAddressLocalServiceUtil

java.lang.Object

com.liferay.commerce.service.CommerceAddressLocalServiceUtil

@ProviderType
public class CommerceAddressLocalServiceUtil
extends java.lang.Object

Provides the local service utility for CommerceAddress. This utility wraps com.liferay.commerce.service.impl.CommerceAddressLocalServiceImpl 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:

CommerceAddressLocalService, com.liferay.commerce.service.base.CommerceAddressLocalServiceBaseImpl, com.liferay.commerce.service.impl.CommerceAddressLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
CommerceAddressLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CommerceAddress	addCommerceAddress(CommerceAddress commerceAddress) Adds the commerce address to the database.
static CommerceAddress	addCommerceAddress(java.lang.String className, long classPK, java.lang.String name, java.lang.String description, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long commerceRegionId, long commerceCountryId, java.lang.String phoneNumber, boolean defaultBilling, boolean defaultShipping, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceAddress	copyCommerceAddress(long commerceAddressId, java.lang.String className, long classPK, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceAddress	createCommerceAddress(long commerceAddressId) Creates a new commerce address with the primary key.
static CommerceAddress	deleteCommerceAddress(CommerceAddress commerceAddress) Deletes the commerce address from the database.
static CommerceAddress	deleteCommerceAddress(long commerceAddressId) Deletes the commerce address with the primary key from the database.
static void	deleteCommerceAddresses(java.lang.String className, long classPK)
static void	deleteCountryCommerceAddresses(long commerceCountryId)
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static void	deleteRegionCommerceAddresses(long commerceRegionId)
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 CommerceAddress	fetchCommerceAddress(long commerceAddressId)
static CommerceAddress	geolocateCommerceAddress(long commerceAddressId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static CommerceAddress	getCommerceAddress(long commerceAddressId) Returns the commerce address with the primary key.
static java.util.List<CommerceAddress>	getCommerceAddresses(int start, int end) Returns a range of all the commerce addresses.
static java.util.List<CommerceAddress>	getCommerceAddresses(long groupId, java.lang.String className, long classPK)
static java.util.List<CommerceAddress>	getCommerceAddresses(long groupId, java.lang.String className, long classPK, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceAddress> orderByComparator)
static int	getCommerceAddressesCount() Returns the number of commerce addresses.
static int	getCommerceAddressesCount(long groupId, java.lang.String className, long classPK)
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 CommerceAddressLocalService	getService()
static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceAddress>	searchCommerceAddresses(long companyId, long groupId, java.lang.String className, long classPK, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
static CommerceAddress	updateCommerceAddress(CommerceAddress commerceAddress) Updates the commerce address in the database or adds it if it does not yet exist.
static CommerceAddress	updateCommerceAddress(long commerceAddressId, java.lang.String name, java.lang.String description, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long commerceRegionId, long commerceCountryId, java.lang.String phoneNumber, boolean defaultBilling, boolean defaultShipping, 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

CommerceAddressLocalServiceUtil

public CommerceAddressLocalServiceUtil()

Method Detail

addCommerceAddress

public static CommerceAddress addCommerceAddress(CommerceAddress commerceAddress)

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

Parameters:

commerceAddress - the commerce address

Returns:

the commerce address that was added

addCommerceAddress

public static CommerceAddress addCommerceAddress(java.lang.String className,
                                                 long classPK,
                                                 java.lang.String name,
                                                 java.lang.String description,
                                                 java.lang.String street1,
                                                 java.lang.String street2,
                                                 java.lang.String street3,
                                                 java.lang.String city,
                                                 java.lang.String zip,
                                                 long commerceRegionId,
                                                 long commerceCountryId,
                                                 java.lang.String phoneNumber,
                                                 boolean defaultBilling,
                                                 boolean defaultShipping,
                                                 com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

copyCommerceAddress

public static CommerceAddress copyCommerceAddress(long commerceAddressId,
                                                  java.lang.String className,
                                                  long classPK,
                                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceAddress

public static CommerceAddress createCommerceAddress(long commerceAddressId)

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

Parameters:

commerceAddressId - the primary key for the new commerce address

Returns:

the new commerce address

deleteCommerceAddress

public static CommerceAddress deleteCommerceAddress(CommerceAddress commerceAddress)
                                             throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

commerceAddress - the commerce address

Returns:

the commerce address that was removed

Throws:

PortalException

deleteCommerceAddress

public static CommerceAddress deleteCommerceAddress(long commerceAddressId)
                                             throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

commerceAddressId - the primary key of the commerce address

Returns:

the commerce address that was removed

Throws:

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

deleteCommerceAddresses

public static void deleteCommerceAddresses(java.lang.String className,
                                           long classPK)
                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCountryCommerceAddresses

public static void deleteCountryCommerceAddresses(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

deleteRegionCommerceAddresses

public static void deleteRegionCommerceAddresses(long commerceRegionId)
                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.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.CommerceAddressModelImpl. 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.CommerceAddressModelImpl. 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

fetchCommerceAddress

public static CommerceAddress fetchCommerceAddress(long commerceAddressId)

geolocateCommerceAddress

public static CommerceAddress geolocateCommerceAddress(long commerceAddressId)
                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getActionableDynamicQuery

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

getCommerceAddress

public static CommerceAddress getCommerceAddress(long commerceAddressId)
                                          throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce address with the primary key.

Parameters:

commerceAddressId - the primary key of the commerce address

Returns:

the commerce address

Throws:

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

getCommerceAddresses

public static java.util.List<CommerceAddress> getCommerceAddresses(int start,
                                                                   int end)

Returns a range of all the commerce addresses.

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.CommerceAddressModelImpl. 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 addresses

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

Returns:

the range of commerce addresses

getCommerceAddresses

public static java.util.List<CommerceAddress> getCommerceAddresses(long groupId,
                                                                   java.lang.String className,
                                                                   long classPK)

getCommerceAddresses

public static java.util.List<CommerceAddress> getCommerceAddresses(long groupId,
                                                                   java.lang.String className,
                                                                   long classPK,
                                                                   int start,
                                                                   int end,
                                                                   com.liferay.portal.kernel.util.OrderByComparator<CommerceAddress> orderByComparator)

getCommerceAddressesCount

public static int getCommerceAddressesCount()

Returns the number of commerce addresses.

Returns:

the number of commerce addresses

getCommerceAddressesCount

public static int getCommerceAddressesCount(long groupId,
                                            java.lang.String className,
                                            long classPK)

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

searchCommerceAddresses

public static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceAddress> searchCommerceAddresses(long companyId,
                                                                                                              long groupId,
                                                                                                              java.lang.String className,
                                                                                                              long classPK,
                                                                                                              java.lang.String keywords,
                                                                                                              int start,
                                                                                                              int end,
                                                                                                              com.liferay.portal.kernel.search.Sort sort)
                                                                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceAddress

public static CommerceAddress updateCommerceAddress(CommerceAddress commerceAddress)

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

Parameters:

commerceAddress - the commerce address

Returns:

the commerce address that was updated

updateCommerceAddress

public static CommerceAddress updateCommerceAddress(long commerceAddressId,
                                                    java.lang.String name,
                                                    java.lang.String description,
                                                    java.lang.String street1,
                                                    java.lang.String street2,
                                                    java.lang.String street3,
                                                    java.lang.String city,
                                                    java.lang.String zip,
                                                    long commerceRegionId,
                                                    long commerceCountryId,
                                                    java.lang.String phoneNumber,
                                                    boolean defaultBilling,
                                                    boolean defaultShipping,
                                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CommerceAddressLocalService getService()