com.liferay.portal.kernel.service

Interface EmailAddressLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

EmailAddressLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface EmailAddressLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for EmailAddress. 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.

Author:

Brian Wing Shun Chan

See Also:

EmailAddressLocalServiceUtil, EmailAddressLocalServiceBaseImpl, EmailAddressLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
EmailAddress	addEmailAddress(EmailAddress emailAddress) Adds the email address to the database.
EmailAddress	addEmailAddress(long userId, String className, long classPK, String address, long typeId, boolean primary, ServiceContext serviceContext)
EmailAddress	createEmailAddress(long emailAddressId) Creates a new email address with the primary key.
EmailAddress	deleteEmailAddress(EmailAddress emailAddress) Deletes the email address from the database.
EmailAddress	deleteEmailAddress(long emailAddressId) Deletes the email address with the primary key from the database.
void	deleteEmailAddresses(long companyId, String className, long classPK)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
EmailAddress	fetchEmailAddress(long emailAddressId)
EmailAddress	fetchEmailAddressByUuidAndCompanyId(String uuid, long companyId) Returns the email address with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
EmailAddress	getEmailAddress(long emailAddressId) Returns the email address with the primary key.
EmailAddress	getEmailAddressByUuidAndCompanyId(String uuid, long companyId) Returns the email address with the matching UUID and company.
List<EmailAddress>	getEmailAddresses()
List<EmailAddress>	getEmailAddresses(int start, int end) Returns a range of all the email addresses.
List<EmailAddress>	getEmailAddresses(long companyId, String className, long classPK)
int	getEmailAddressesCount() Returns the number of email addresses.
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
EmailAddress	updateEmailAddress(EmailAddress emailAddress) Updates the email address in the database or adds it if it does not yet exist.
EmailAddress	updateEmailAddress(long emailAddressId, String address, long typeId, boolean primary)

Method Detail

addEmailAddress

@Indexable(type=REINDEX)
EmailAddress addEmailAddress(EmailAddress emailAddress)

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

addEmailAddress

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

Throws:

PortalException

createEmailAddress

@Transactional(enabled=false)
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

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
EmailAddress deleteEmailAddress(EmailAddress emailAddress)

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

deleteEmailAddress

@Indexable(type=DELETE)
EmailAddress deleteEmailAddress(long emailAddressId)
                                                 throws PortalException

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

deleteEmailAddresses

void deleteEmailAddresses(long companyId,
                          String className,
                          long classPK)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

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

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchEmailAddress

@Transactional(propagation=SUPPORTS,
               readOnly=true)
EmailAddress fetchEmailAddress(long emailAddressId)

fetchEmailAddressByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
EmailAddress fetchEmailAddressByUuidAndCompanyId(String uuid,
                                                                                                                    long companyId)

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getEmailAddress

@Transactional(propagation=SUPPORTS,
               readOnly=true)
EmailAddress getEmailAddress(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

Throws:

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

getEmailAddressByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
EmailAddress getEmailAddressByUuidAndCompanyId(String uuid,
                                                                                                                  long companyId)
                                                                                                           throws PortalException

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

getEmailAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<EmailAddress> getEmailAddresses()

getEmailAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<EmailAddress> getEmailAddresses(int start,
                                                                                                        int end)

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

getEmailAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<EmailAddress> getEmailAddresses(long companyId,
                                                                                                        String className,
                                                                                                        long classPK)

getEmailAddressesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEmailAddressesCount()

Returns the number of email addresses.

Returns:

the number of email addresses

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

updateEmailAddress

@Indexable(type=REINDEX)
EmailAddress updateEmailAddress(EmailAddress emailAddress)

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

updateEmailAddress

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

Throws:

PortalException