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:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddAddress
(String externalReferenceCode, 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) void
deleteAddress
(long addressId) getAddress
(long addressId) getAddresses
(String className, long classPK) getListTypeAddresses
(String className, long classPK, long[] listTypeIds) Returns the OSGi service identifier.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) updateExternalReferenceCode
(long addressId, String externalReferenceCode) updateExternalReferenceCode
(Address address, String externalReferenceCode)
-
Method Details
-
addAddress
Address addAddress(String externalReferenceCode, 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
-
deleteAddress
- Throws:
PortalException
-
getAddress
@Transactional(propagation=SUPPORTS, readOnly=true) Address getAddress(long addressId) throws PortalException - Throws:
PortalException
-
getAddresses
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getAddresses(String className, long classPK) throws PortalException - Throws:
PortalException
-
getListTypeAddresses
@Transactional(propagation=SUPPORTS, readOnly=true) List<Address> getListTypeAddresses(String className, long classPK, long[] listTypeIds) throws PortalException - Throws:
PortalException
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
updateAddress
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
-
updateExternalReferenceCode
Address updateExternalReferenceCode(Address address, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateExternalReferenceCode
Address updateExternalReferenceCode(long addressId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-