Interface EmailAddressService
- All Superinterfaces:
BaseService
- All Known Implementing Classes:
EmailAddressServiceWrapper
@AccessControlled
@CTAware
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface EmailAddressService
extends BaseService
Provides the remote service interface for EmailAddress. 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 TypeMethodDescriptionaddEmailAddress
(String externalReferenceCode, String className, long classPK, String address, long typeId, boolean primary, ServiceContext serviceContext) void
deleteEmailAddress
(long emailAddressId) fetchEmailAddress
(long emailAddressId) Returns the email address with the primary key.fetchEmailAddressByExternalReferenceCode
(String externalReferenceCode, long companyId) getEmailAddress
(long emailAddressId) getEmailAddresses
(String className, long classPK) Returns the OSGi service identifier.updateEmailAddress
(String externalReferenceCode, long emailAddressId, String address, long typeId, boolean primary)
-
Method Details
-
addEmailAddress
EmailAddress addEmailAddress(String externalReferenceCode, String className, long classPK, String address, long typeId, boolean primary, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
deleteEmailAddress
- Throws:
PortalException
-
fetchEmailAddress
@Transactional(propagation=SUPPORTS, readOnly=true) EmailAddress fetchEmailAddress(long emailAddressId) throws PortalException Returns the email address with the primary key.- Parameters:
emailAddressId
- the primary key of the email address- Returns:
- the email address with the primary key, or
null
if an email address with the primary key could not be found or if the user did not have permission to view the email address - Throws:
PortalException
-
fetchEmailAddressByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) EmailAddress fetchEmailAddressByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getEmailAddress
@Transactional(propagation=SUPPORTS, readOnly=true) EmailAddress getEmailAddress(long emailAddressId) throws PortalException - Throws:
PortalException
-
getEmailAddresses
@Transactional(propagation=SUPPORTS, readOnly=true) List<EmailAddress> getEmailAddresses(String className, long classPK) throws PortalException - Throws:
PortalException
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
updateEmailAddress
EmailAddress updateEmailAddress(String externalReferenceCode, long emailAddressId, String address, long typeId, boolean primary) throws PortalException - Throws:
PortalException
-