com.liferay.portal.kernel.service

Class EmailAddressServiceUtil

Object

com.liferay.portal.kernel.service.EmailAddressServiceUtil

@ProviderType
public class EmailAddressServiceUtil
extends Object

Provides the remote service utility for EmailAddress. This utility wraps EmailAddressServiceImpl and is the primary 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:

EmailAddressService, EmailAddressServiceBaseImpl, EmailAddressServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
EmailAddressServiceUtil()

Method Summary

Modifier and Type	Method and Description
static EmailAddress	addEmailAddress(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	getEmailAddress(long emailAddressId)
static List<EmailAddress>	getEmailAddresses(String className, long classPK)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static EmailAddressService	getService()
static EmailAddress	updateEmailAddress(long emailAddressId, String address, long typeId, boolean primary)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmailAddressServiceUtil

public EmailAddressServiceUtil()

Method Detail

addEmailAddress

public static EmailAddress addEmailAddress(String className,
                                           long classPK,
                                           String address,
                                           long typeId,
                                           boolean primary,
                                           ServiceContext serviceContext)
                                    throws PortalException

Throws:

PortalException

deleteEmailAddress

public static void deleteEmailAddress(long emailAddressId)
                               throws PortalException

Throws:

PortalException

fetchEmailAddress

public static 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

getEmailAddress

public static EmailAddress getEmailAddress(long emailAddressId)
                                    throws PortalException

Throws:

PortalException

getEmailAddresses

public static List<EmailAddress> getEmailAddresses(String className,
                                                   long classPK)
                                            throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

updateEmailAddress

public static EmailAddress updateEmailAddress(long emailAddressId,
                                              String address,
                                              long typeId,
                                              boolean primary)
                                       throws PortalException

Throws:

PortalException

getService

public static EmailAddressService getService()