com.liferay.portal.kernel.service

Class AddressLocalServiceUtil

Object

com.liferay.portal.kernel.service.AddressLocalServiceUtil

public class AddressLocalServiceUtil
extends Object

Provides the local service utility for Address. This utility wraps com.liferay.portal.service.impl.AddressLocalServiceImpl and is an 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.

Author:

Brian Wing Shun Chan

See Also:

AddressLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
AddressLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Address	addAddress(Address address) Adds the address to the database.
static Address	addAddress(String externalReferenceCode, long userId, String className, long classPK, String name, String description, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary, String phoneNumber, ServiceContext serviceContext)
static Address	copyAddress(long addressId, String className, long classPK, ServiceContext serviceContext)
static Address	createAddress(long addressId) Creates a new address with the primary key.
static PersistedModel	createPersistedModel(Serializable primaryKeyObj)
static Address	deleteAddress(Address address) Deletes the address from the database.
static Address	deleteAddress(long addressId) Deletes the address with the primary key from the database.
static void	deleteAddresses(long companyId, String className, long classPK)
static void	deleteCountryAddresses(long countryId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static void	deleteRegionAddresses(long regionId)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> 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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static Address	fetchAddress(long addressId)
static Address	fetchAddressByExternalReferenceCode(String externalReferenceCode, long companyId)
static Address	fetchAddressByUuidAndCompanyId(String uuid, long companyId) Returns the address with the matching UUID and company.
static ActionableDynamicQuery	getActionableDynamicQuery()
static Address	getAddress(long addressId) Returns the address with the primary key.
static Address	getAddressByExternalReferenceCode(String externalReferenceCode, long companyId)
static Address	getAddressByUuidAndCompanyId(String uuid, long companyId) Returns the address with the matching UUID and company.
static List<Address>	getAddresses()
static List<Address>	getAddresses(int start, int end) Returns a range of all the addresses.
static List<Address>	getAddresses(long companyId, String className, long classPK)
static List<Address>	getAddresses(long companyId, String className, long classPK, int start, int end, OrderByComparator<Address> orderByComparator)
static int	getAddressesCount() Returns the number of addresses.
static int	getAddressesCount(long companyId, String className, long classPK)
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static List<Address>	getListTypeAddresses(long companyId, String className, long classPK, long[] listTypeIds)
static List<Address>	getListTypeAddresses(long companyId, String className, long classPK, long[] listTypeIds, int start, int end, OrderByComparator<Address> orderByComparator)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static AddressLocalService	getService()
static BaseModelSearchResult<Address>	searchAddresses(long companyId, String className, long classPK, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort)
static Address	updateAddress(Address address) Updates the address in the database or adds it if it does not yet exist.
static Address	updateAddress(long addressId, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary)
static Address	updateAddress(long addressId, String name, String description, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long listTypeId, boolean mailing, boolean primary, String phoneNumber)

Methods inherited from class Object

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

Constructor Detail

AddressLocalServiceUtil

public AddressLocalServiceUtil()

Method Detail

addAddress

public static Address addAddress(Address address)

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

Important: Inspect AddressLocalServiceImpl 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:

address - the address

Returns:

the address that was added

addAddress

public static Address addAddress(String externalReferenceCode,
                                 long userId,
                                 String className,
                                 long classPK,
                                 String name,
                                 String description,
                                 String street1,
                                 String street2,
                                 String street3,
                                 String city,
                                 String zip,
                                 long regionId,
                                 long countryId,
                                 long listTypeId,
                                 boolean mailing,
                                 boolean primary,
                                 String phoneNumber,
                                 ServiceContext serviceContext)
                          throws PortalException

Throws:

PortalException

copyAddress

public static Address copyAddress(long addressId,
                                  String className,
                                  long classPK,
                                  ServiceContext serviceContext)
                           throws PortalException

Throws:

PortalException

createAddress

public static Address createAddress(long addressId)

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

Parameters:

addressId - the primary key for the new address

Returns:

the new address

createPersistedModel

public static PersistedModel createPersistedModel(Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteAddress

public static Address deleteAddress(Address address)

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

Important: Inspect AddressLocalServiceImpl 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:

address - the address

Returns:

the address that was removed

deleteAddress

public static Address deleteAddress(long addressId)
                             throws PortalException

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

Important: Inspect AddressLocalServiceImpl 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:

addressId - the primary key of the address

Returns:

the address that was removed

Throws:

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

deleteAddresses

public static void deleteAddresses(long companyId,
                                   String className,
                                   long classPK)

deleteCountryAddresses

public static void deleteCountryAddresses(long countryId)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteRegionAddresses

public static void deleteRegionAddresses(long regionId)

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

public static <T> 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.AddressModelImpl.

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> 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.AddressModelImpl.

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(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(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

fetchAddress

public static Address fetchAddress(long addressId)

fetchAddressByExternalReferenceCode

public static Address fetchAddressByExternalReferenceCode(String externalReferenceCode,
                                                          long companyId)

fetchAddressByUuidAndCompanyId

public static Address fetchAddressByUuidAndCompanyId(String uuid,
                                                     long companyId)

Returns the address with the matching UUID and company.

Parameters:

uuid - the address's UUID

companyId - the primary key of the company

Returns:

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

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getAddress

public static Address getAddress(long addressId)
                          throws PortalException

Returns the address with the primary key.

Parameters:

addressId - the primary key of the address

Returns:

the address

Throws:

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

getAddressByExternalReferenceCode

public static Address getAddressByExternalReferenceCode(String externalReferenceCode,
                                                        long companyId)
                                                 throws PortalException

Throws:

PortalException

getAddressByUuidAndCompanyId

public static Address getAddressByUuidAndCompanyId(String uuid,
                                                   long companyId)
                                            throws PortalException

Returns the address with the matching UUID and company.

Parameters:

uuid - the address's UUID

companyId - the primary key of the company

Returns:

the matching address

Throws:

PortalException - if a matching address could not be found

getAddresses

public static List<Address> getAddresses()

getAddresses

public static List<Address> getAddresses(int start,
                                         int end)

Returns a range of all the 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 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.AddressModelImpl.

Parameters:

start - the lower bound of the range of addresses

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

Returns:

the range of addresses

getAddresses

public static List<Address> getAddresses(long companyId,
                                         String className,
                                         long classPK)

getAddresses

public static List<Address> getAddresses(long companyId,
                                         String className,
                                         long classPK,
                                         int start,
                                         int end,
                                         OrderByComparator<Address> orderByComparator)

getAddressesCount

public static int getAddressesCount()

Returns the number of addresses.

Returns:

the number of addresses

getAddressesCount

public static int getAddressesCount(long companyId,
                                    String className,
                                    long classPK)

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getListTypeAddresses

public static List<Address> getListTypeAddresses(long companyId,
                                                 String className,
                                                 long classPK,
                                                 long[] listTypeIds)

getListTypeAddresses

public static List<Address> getListTypeAddresses(long companyId,
                                                 String className,
                                                 long classPK,
                                                 long[] listTypeIds,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<Address> orderByComparator)

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

searchAddresses

public static BaseModelSearchResult<Address> searchAddresses(long companyId,
                                                             String className,
                                                             long classPK,
                                                             String keywords,
                                                             LinkedHashMap<String,Object> params,
                                                             int start,
                                                             int end,
                                                             Sort sort)
                                                      throws PortalException

Throws:

PortalException

updateAddress

public static Address updateAddress(Address address)

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

Important: Inspect AddressLocalServiceImpl 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:

address - the address

Returns:

the address that was updated

updateAddress

public static Address updateAddress(long addressId,
                                    String street1,
                                    String street2,
                                    String street3,
                                    String city,
                                    String zip,
                                    long regionId,
                                    long countryId,
                                    long listTypeId,
                                    boolean mailing,
                                    boolean primary)
                             throws PortalException

Throws:

PortalException

updateAddress

public static Address updateAddress(long addressId,
                                    String name,
                                    String description,
                                    String street1,
                                    String street2,
                                    String street3,
                                    String city,
                                    String zip,
                                    long regionId,
                                    long countryId,
                                    long listTypeId,
                                    boolean mailing,
                                    boolean primary,
                                    String phoneNumber)
                             throws PortalException

Throws:

PortalException

getService

public static AddressLocalService getService()