Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface EmailAddressLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
EmailAddressLocalServiceBaseImpl, EmailAddressLocalServiceImpl, 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.

See Also:
EmailAddressLocalServiceUtil, EmailAddressLocalServiceBaseImpl, EmailAddressLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it 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)
          Deprecated. As of 6.2.0, replaced by addEmailAddress(long, String, long, String, int, boolean, ServiceContext)
 EmailAddress addEmailAddress(long userId, String className, long classPK, String address, int 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)
           
 DynamicQuery dynamicQuery()
           
 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)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 EmailAddress fetchEmailAddress(long emailAddressId)
           
 EmailAddress fetchEmailAddressByUuidAndCompanyId(String uuid, long companyId)
          Returns the email address with the matching UUID and company.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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, int typeId, boolean primary)
           
 

Method Detail

addEmailAddress

@Indexable(type=REINDEX)
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

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)
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

@Indexable(type=DELETE)
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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
EmailAddress fetchEmailAddress(long emailAddressId)
                               throws SystemException
Throws:
SystemException

fetchEmailAddressByUuidAndCompanyId

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getEmailAddressByUuidAndCompanyId

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

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

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

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

updateEmailAddress

@Indexable(type=REINDEX)
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

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addEmailAddress

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

EmailAddress addEmailAddress(long userId,
                             String className,
                             long classPK,
                             String address,
                             int typeId,
                             boolean primary,
                             ServiceContext serviceContext)
                             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.2-ce-ga5