com.liferay.portal.kernel.service

Interface AddressLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

AddressLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AddressLocalService
extends BaseLocalService, PersistedModelLocalService

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

AddressLocalServiceUtil, AddressLocalServiceBaseImpl, AddressLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Address	addAddress(Address address) Adds the address to the database.
Address	addAddress(long userId, String className, long classPK, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long typeId, boolean mailing, boolean primary, ServiceContext serviceContext)
Address	createAddress(long addressId) Creates a new address with the primary key.
Address	deleteAddress(Address address) Deletes the address from the database.
Address	deleteAddress(long addressId) Deletes the address with the primary key from the database.
void	deleteAddresses(long companyId, String className, long classPK)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
Address	fetchAddress(long addressId)
Address	fetchAddressByUuidAndCompanyId(String uuid, long companyId) Returns the address with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
Address	getAddress(long addressId) Returns the address with the primary key.
Address	getAddressByUuidAndCompanyId(String uuid, long companyId) Returns the address with the matching UUID and company.
List<Address>	getAddresses()
List<Address>	getAddresses(int start, int end) Returns a range of all the addresses.
List<Address>	getAddresses(long companyId, String className, long classPK)
int	getAddressesCount() Returns the number of addresses.
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
Address	updateAddress(Address address) Updates the address in the database or adds it if it does not yet exist.
Address	updateAddress(long addressId, String street1, String street2, String street3, String city, String zip, long regionId, long countryId, long typeId, boolean mailing, boolean primary)

Method Detail

addAddress

@Indexable(type=REINDEX)
Address addAddress(Address address)

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

Parameters:

address - the address

Returns:

the address that was added

addAddress

Address addAddress(long userId,
                   String className,
                   long classPK,
                   String street1,
                   String street2,
                   String street3,
                   String city,
                   String zip,
                   long regionId,
                   long countryId,
                   long typeId,
                   boolean mailing,
                   boolean primary,
                   ServiceContext serviceContext)
            throws PortalException

Throws:

PortalException

createAddress

@Transactional(enabled=false)
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

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
Address deleteAddress(Address address)

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

Parameters:

address - the address

Returns:

the address that was removed

deleteAddress

@Indexable(type=DELETE)
Address deleteAddress(long addressId)
                                       throws PortalException

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

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

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 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 AddressModelImpl. 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 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 AddressModelImpl. 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Address fetchAddress(long addressId)

fetchAddressByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getAddress

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getAddressByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Address> getAddresses()

getAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 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 AddressModelImpl. 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 addresses

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

Returns:

the range of addresses

getAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Address> getAddresses(long companyId,
                                                                                              String className,
                                                                                              long classPK)

getAddressesCount

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

Returns the number of addresses.

Returns:

the number of addresses

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

updateAddress

@Indexable(type=REINDEX)
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.

Parameters:

address - the address

Returns:

the address that was updated

updateAddress

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

Throws:

PortalException