com.liferay.portal.service
Class AddressLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.AddressLocalServiceUtil

public class AddressLocalServiceUtil
extends Object

The utility for the address local service. This utility wraps AddressLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to AddressLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

This is a local service. 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:

AddressLocalService, AddressLocalServiceBaseImpl, AddressLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

AddressLocalServiceUtil()

Method Summary

static Address	addAddress(Address address) Adds the address to the database.
static Address	addAddress(long userId, String className, long classPK, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, int typeId, boolean mailing, boolean primary)
static Address	createAddress(long addressId) Creates a new address with the primary key.
static void	deleteAddress(Address address) Deletes the address from the database.
static void	deleteAddress(long addressId) Deletes the address with the primary key from the database.
static void	deleteAddresses(long companyId, String className, long classPK)
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
static Address	getAddress(long addressId) Gets the address with the primary key.
static List<Address>	getAddresses()
static List<Address>	getAddresses(int start, int end) Gets a range of all the addresses.
static List<Address>	getAddresses(long companyId, String className, long classPK)
static int	getAddressesCount() Gets the number of addresses.
static AddressLocalService	getService()
void	setService(AddressLocalService service)
static Address	updateAddress(Address address) Updates the address in the database.
static Address	updateAddress(Address address, boolean merge) Updates the address in the database.
static Address	updateAddress(long addressId, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, int typeId, boolean mailing, boolean primary)

Methods inherited from class java.lang.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)
                          throws SystemException

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

Parameters:

address - the address to add

Returns:

the address that was added

Throws:

SystemException - if a system exception occurred

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

deleteAddress

public static void deleteAddress(long addressId)
                          throws PortalException,
                                 SystemException

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

Parameters:

addressId - the primary key of the address to delete

Throws:

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

SystemException - if a system exception occurred

deleteAddress

public static void deleteAddress(Address address)
                          throws SystemException

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

Parameters:

address - the address to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

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

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

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

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getAddress

public static Address getAddress(long addressId)
                          throws PortalException,
                                 SystemException

Gets the address with the primary key.

Parameters:

addressId - the primary key of the address to get

Returns:

the address

Throws:

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

SystemException - if a system exception occurred

getAddresses

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

Gets 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 QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of addresses to return

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

Returns:

the range of addresses

Throws:

SystemException - if a system exception occurred

getAddressesCount

public static int getAddressesCount()
                             throws SystemException

Gets the number of addresses.

Returns:

the number of addresses

Throws:

SystemException - if a system exception occurred

updateAddress

public static Address updateAddress(Address address)
                             throws SystemException

Updates the address in the database. Also notifies the appropriate model listeners.

Parameters:

address - the address to update

Returns:

the address that was updated

Throws:

SystemException - if a system exception occurred

updateAddress

public static Address updateAddress(Address address,
                                    boolean merge)
                             throws SystemException

Updates the address in the database. Also notifies the appropriate model listeners.

Parameters:

address - the address to update

merge - whether to merge the address with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the address that was updated

Throws:

SystemException - if a system exception occurred

addAddress

public static Address addAddress(long userId,
                                 String className,
                                 long classPK,
                                 String street1,
                                 String street2,
                                 String street3,
                                 String city,
                                 String zip,
                                 long regionId,
                                 long countryId,
                                 int typeId,
                                 boolean mailing,
                                 boolean primary)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deleteAddresses

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

Throws:

SystemException

getAddresses

public static List<Address> getAddresses()
                                  throws SystemException

Throws:

SystemException

getAddresses

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

Throws:

SystemException

updateAddress

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

Throws:

PortalException

SystemException

getService

public static AddressLocalService getService()

setService

public void setService(AddressLocalService service)