com.liferay.portal.kernel.service

Interface AddressService

All Superinterfaces:

BaseService

All Known Implementing Classes:

AddressServiceWrapper

@AccessControlled
 @CTAware
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AddressService
extends BaseService

Provides the remote service interface for Address. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

AddressServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
Address	addAddress(java.lang.String externalReferenceCode, 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 regionId, long countryId, long listTypeId, boolean mailing, boolean primary, java.lang.String phoneNumber, ServiceContext serviceContext)
void	deleteAddress(long addressId)
Address	getAddress(long addressId)
java.util.List<Address>	getAddresses(java.lang.String className, long classPK)
java.util.List<Address>	getListTypeAddresses(java.lang.String className, long classPK, long[] listTypeIds)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
Address	updateAddress(long addressId, 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 regionId, long countryId, long listTypeId, boolean mailing, boolean primary, java.lang.String phoneNumber)
Address	updateExternalReferenceCode(Address address, java.lang.String externalReferenceCode)
Address	updateExternalReferenceCode(long addressId, java.lang.String externalReferenceCode)

Method Detail

addAddress

Address addAddress(java.lang.String externalReferenceCode,
                   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 regionId,
                   long countryId,
                   long listTypeId,
                   boolean mailing,
                   boolean primary,
                   java.lang.String phoneNumber,
                   ServiceContext serviceContext)
            throws PortalException

Throws:

PortalException

deleteAddress

void deleteAddress(long addressId)
            throws PortalException

Throws:

PortalException

getAddress

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Address getAddress(long addressId)
                                                                               throws PortalException

Throws:

PortalException

getAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Address> getAddresses(java.lang.String className,
                                                                                                        long classPK)
                                                                                                 throws PortalException

Throws:

PortalException

getListTypeAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Address> getListTypeAddresses(java.lang.String className,
                                                                                                                long classPK,
                                                                                                                long[] listTypeIds)
                                                                                                         throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

updateAddress

Address updateAddress(long addressId,
                      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 regionId,
                      long countryId,
                      long listTypeId,
                      boolean mailing,
                      boolean primary,
                      java.lang.String phoneNumber)
               throws PortalException

Throws:

PortalException

updateExternalReferenceCode

Address updateExternalReferenceCode(Address address,
                                    java.lang.String externalReferenceCode)
                             throws PortalException

Throws:

PortalException

updateExternalReferenceCode

Address updateExternalReferenceCode(long addressId,
                                    java.lang.String externalReferenceCode)
                             throws PortalException

Throws:

PortalException