com.liferay.portal.service
Class EmailAddressLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.EmailAddressLocalServiceUtil

@ProviderType
public class EmailAddressLocalServiceUtil
extends Object

Provides the local service utility for EmailAddress. This utility wraps com.liferay.portal.service.impl.EmailAddressLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

EmailAddressLocalService, EmailAddressLocalServiceBaseImpl, com.liferay.portal.service.impl.EmailAddressLocalServiceImpl

Constructor Summary

EmailAddressLocalServiceUtil()

Method Summary

static EmailAddress	addEmailAddress(EmailAddress emailAddress) Adds the email address to the database.
static EmailAddress	addEmailAddress(long userId, String className, long classPK, String address, int typeId, boolean primary) Deprecated. As of 6.2.0, replaced by addEmailAddress(long, String, long, String, int, boolean, ServiceContext)
static EmailAddress	addEmailAddress(long userId, String className, long classPK, String address, int typeId, boolean primary, ServiceContext serviceContext)
static EmailAddress	createEmailAddress(long emailAddressId) Creates a new email address with the primary key.
static EmailAddress	deleteEmailAddress(EmailAddress emailAddress) Deletes the email address from the database.
static EmailAddress	deleteEmailAddress(long emailAddressId) Deletes the email address with the primary key from the database.
static void	deleteEmailAddresses(long companyId, String className, long classPK)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static EmailAddress	fetchEmailAddress(long emailAddressId)
static EmailAddress	fetchEmailAddressByUuidAndCompanyId(String uuid, long companyId) Returns the email address with the matching UUID and company.
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static EmailAddress	getEmailAddress(long emailAddressId) Returns the email address with the primary key.
static EmailAddress	getEmailAddressByUuidAndCompanyId(String uuid, long companyId) Returns the email address with the matching UUID and company.
static List<EmailAddress>	getEmailAddresses()
static List<EmailAddress>	getEmailAddresses(int start, int end) Returns a range of all the email addresses.
static List<EmailAddress>	getEmailAddresses(long companyId, String className, long classPK)
static int	getEmailAddressesCount() Returns the number of email addresses.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static EmailAddressLocalService	getService()
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(EmailAddressLocalService service) Deprecated. As of 6.2.0
static EmailAddress	updateEmailAddress(EmailAddress emailAddress) Updates the email address in the database or adds it if it does not yet exist.
static EmailAddress	updateEmailAddress(long emailAddressId, String address, int typeId, boolean primary)

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailAddressLocalServiceUtil

public EmailAddressLocalServiceUtil()

Method Detail

addEmailAddress

public static EmailAddress addEmailAddress(EmailAddress emailAddress)
                                    throws SystemException

Adds the email address to the database. Also notifies the appropriate model listeners.

Parameters:

emailAddress - the email address

Returns:

the email address that was added

Throws:

SystemException - if a system exception occurred

createEmailAddress

public static EmailAddress createEmailAddress(long emailAddressId)

Creates a new email address with the primary key. Does not add the email address to the database.

Parameters:

emailAddressId - the primary key for the new email address

Returns:

the new email address

deleteEmailAddress

public static EmailAddress deleteEmailAddress(long emailAddressId)
                                       throws PortalException,
                                              SystemException

Deletes the email address with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

emailAddressId - the primary key of the email address

Returns:

the email address that was removed

Throws:

PortalException - if a email address with the primary key could not be found

SystemException - if a system exception occurred

deleteEmailAddress

public static EmailAddress deleteEmailAddress(EmailAddress emailAddress)
                                       throws SystemException

Deletes the email address from the database. Also notifies the appropriate model listeners.

Parameters:

emailAddress - the email address

Returns:

the email address that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from EmailAddressModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from EmailAddressModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchEmailAddress

public static EmailAddress fetchEmailAddress(long emailAddressId)
                                      throws SystemException

Throws:

SystemException

fetchEmailAddressByUuidAndCompanyId

public static EmailAddress fetchEmailAddressByUuidAndCompanyId(String uuid,
                                                               long companyId)
                                                        throws SystemException

Returns the email address with the matching UUID and company.

Parameters:

uuid - the email address's UUID

companyId - the primary key of the company

Returns:

the matching email address, or null if a matching email address could not be found

Throws:

SystemException - if a system exception occurred

getEmailAddress

public static EmailAddress getEmailAddress(long emailAddressId)
                                    throws PortalException,
                                           SystemException

Returns the email address with the primary key.

Parameters:

emailAddressId - the primary key of the email address

Returns:

the email address

Throws:

PortalException - if a email address with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getEmailAddressByUuidAndCompanyId

public static EmailAddress getEmailAddressByUuidAndCompanyId(String uuid,
                                                             long companyId)
                                                      throws PortalException,
                                                             SystemException

Returns the email address with the matching UUID and company.

Parameters:

uuid - the email address's UUID

companyId - the primary key of the company

Returns:

the matching email address

Throws:

PortalException - if a matching email address could not be found

SystemException - if a system exception occurred

getEmailAddresses

public static List<EmailAddress> getEmailAddresses(int start,
                                                   int end)
                                            throws SystemException

Returns a range of all the email addresses.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from EmailAddressModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of email addresses

end - the upper bound of the range of email addresses (not inclusive)

Returns:

the range of email addresses

Throws:

SystemException - if a system exception occurred

getEmailAddressesCount

public static int getEmailAddressesCount()
                                  throws SystemException

Returns the number of email addresses.

Returns:

the number of email addresses

Throws:

SystemException - if a system exception occurred

updateEmailAddress

public static EmailAddress updateEmailAddress(EmailAddress emailAddress)
                                       throws SystemException

Updates the email address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

emailAddress - the email address

Returns:

the email address that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addEmailAddress

public static EmailAddress addEmailAddress(long userId,
                                           String className,
                                           long classPK,
                                           String address,
                                           int typeId,
                                           boolean primary)
                                    throws PortalException,
                                           SystemException

Deprecated. As of 6.2.0, replaced by addEmailAddress(long, String, long, String, int, boolean, ServiceContext)

Throws:

PortalException

SystemException

addEmailAddress

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

Throws:

PortalException

SystemException

deleteEmailAddresses

public static void deleteEmailAddresses(long companyId,
                                        String className,
                                        long classPK)
                                 throws SystemException

Throws:

SystemException

getEmailAddresses

public static List<EmailAddress> getEmailAddresses()
                                            throws SystemException

Throws:

SystemException

getEmailAddresses

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

Throws:

SystemException

updateEmailAddress

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

Throws:

PortalException

SystemException

getService

public static EmailAddressLocalService getService()

setService

public void setService(EmailAddressLocalService service)

Deprecated. As of 6.2.0