Liferay 6.0.5

com.liferay.portal.service
Interface EmailAddressLocalService

All Known Implementing Classes:
EmailAddressLocalServiceBaseImpl, EmailAddressLocalServiceImpl, EmailAddressLocalServiceWrapper

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

The interface for the email address local service.

Never modify or reference this interface directly. Always use EmailAddressLocalServiceUtil to access the email address local service. Add custom service methods to EmailAddressLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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:
EmailAddressLocalServiceUtil, EmailAddressLocalServiceBaseImpl, EmailAddressLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 EmailAddress addEmailAddress(EmailAddress emailAddress)
          Adds the email address to the database.
 EmailAddress addEmailAddress(long userId, String className, long classPK, String address, int typeId, boolean primary)
           
 EmailAddress createEmailAddress(long emailAddressId)
          Creates a new email address with the primary key.
 void deleteEmailAddress(EmailAddress emailAddress)
          Deletes the email address from the database.
 void deleteEmailAddress(long emailAddressId)
          Deletes the email address with the primary key from the database.
 void deleteEmailAddresses(long companyId, String className, long classPK)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 EmailAddress getEmailAddress(long emailAddressId)
          Gets the email address with the primary key.
 List<EmailAddress> getEmailAddresses()
           
 List<EmailAddress> getEmailAddresses(int start, int end)
          Gets a range of all the email addresses.
 List<EmailAddress> getEmailAddresses(long companyId, String className, long classPK)
           
 int getEmailAddressesCount()
          Gets the number of email addresses.
 EmailAddress updateEmailAddress(EmailAddress emailAddress)
          Updates the email address in the database.
 EmailAddress updateEmailAddress(EmailAddress emailAddress, boolean merge)
          Updates the email address in the database.
 EmailAddress updateEmailAddress(long emailAddressId, String address, int typeId, boolean primary)
           
 

Method Detail

addEmailAddress

EmailAddress addEmailAddress(EmailAddress emailAddress)
                             throws SystemException
Adds the email address to the database. Also notifies the appropriate model listeners.

Parameters:
emailAddress - the email address to add
Returns:
the email address that was added
Throws:
SystemException - if a system exception occurred

createEmailAddress

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

void 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 to delete
Throws:
PortalException - if a email address with the primary key could not be found
SystemException - if a system exception occurred

deleteEmailAddress

void deleteEmailAddress(EmailAddress emailAddress)
                        throws SystemException
Deletes the email address from the database. Also notifies the appropriate model listeners.

Parameters:
emailAddress - the email address to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getEmailAddress

@Transactional(propagation=SUPPORTS,
               readOnly=true)
EmailAddress getEmailAddress(long emailAddressId)
                             throws PortalException,
                                    SystemException
Gets the email address with the primary key.

Parameters:
emailAddressId - the primary key of the email address to get
Returns:
the email address
Throws:
PortalException - if a email address with the primary key could not be found
SystemException - if a system exception occurred

getEmailAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<EmailAddress> getEmailAddresses(int start,
                                                                              int end)
                                     throws SystemException
Gets 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.

Parameters:
start - the lower bound of the range of email addresses to return
end - the upper bound of the range of email addresses to return (not inclusive)
Returns:
the range of email addresses
Throws:
SystemException - if a system exception occurred

getEmailAddressesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEmailAddressesCount()
                           throws SystemException
Gets the number of email addresses.

Returns:
the number of email addresses
Throws:
SystemException - if a system exception occurred

updateEmailAddress

EmailAddress updateEmailAddress(EmailAddress emailAddress)
                                throws SystemException
Updates the email address in the database. Also notifies the appropriate model listeners.

Parameters:
emailAddress - the email address to update
Returns:
the email address that was updated
Throws:
SystemException - if a system exception occurred

updateEmailAddress

EmailAddress updateEmailAddress(EmailAddress emailAddress,
                                boolean merge)
                                throws SystemException
Updates the email address in the database. Also notifies the appropriate model listeners.

Parameters:
emailAddress - the email address to update
merge - whether to merge the email address with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the email address that was updated
Throws:
SystemException - if a system exception occurred

addEmailAddress

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

deleteEmailAddresses

void deleteEmailAddresses(long companyId,
                          String className,
                          long classPK)
                          throws SystemException
Throws:
SystemException

getEmailAddresses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<EmailAddress> getEmailAddresses()
                                     throws SystemException
Throws:
SystemException

getEmailAddresses

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

updateEmailAddress

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

Liferay 6.0.5