Class EmailAddressServiceUtil
Object
com.liferay.portal.kernel.service.EmailAddressServiceUtil
Provides the remote service utility for EmailAddress. This utility wraps
com.liferay.portal.service.impl.EmailAddressServiceImpl
and is an
access point for service operations in application layer code running on a
remote server. 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}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic EmailAddress
addEmailAddress
(String externalReferenceCode, String className, long classPK, String address, long typeId, boolean primary, ServiceContext serviceContext) static void
deleteEmailAddress
(long emailAddressId) static EmailAddress
fetchEmailAddress
(long emailAddressId) Returns the email address with the primary key.static EmailAddress
fetchEmailAddressByExternalReferenceCode
(String externalReferenceCode, long companyId) static EmailAddress
getEmailAddress
(long emailAddressId) static List<EmailAddress>
getEmailAddresses
(String className, long classPK) static String
Returns the OSGi service identifier.static EmailAddressService
static void
setService
(EmailAddressService service) static EmailAddress
updateEmailAddress
(String externalReferenceCode, long emailAddressId, String address, long typeId, boolean primary)
-
Constructor Details
-
EmailAddressServiceUtil
public EmailAddressServiceUtil()
-
-
Method Details
-
addEmailAddress
public static EmailAddress addEmailAddress(String externalReferenceCode, String className, long classPK, String address, long typeId, boolean primary, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
deleteEmailAddress
- Throws:
PortalException
-
fetchEmailAddress
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
public static EmailAddress fetchEmailAddressByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getEmailAddress
- Throws:
PortalException
-
getEmailAddresses
public static List<EmailAddress> getEmailAddresses(String className, long classPK) throws PortalException - Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
updateEmailAddress
public static EmailAddress updateEmailAddress(String externalReferenceCode, long emailAddressId, String address, long typeId, boolean primary) throws PortalException - Throws:
PortalException
-
getService
-
setService
-