|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@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.
EmailAddressLocalServiceUtil
,
EmailAddressLocalServiceBaseImpl
,
EmailAddressLocalServiceImpl
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 |
---|
EmailAddress addEmailAddress(EmailAddress emailAddress) throws SystemException
emailAddress
- the email address to add
SystemException
- if a system exception occurredEmailAddress createEmailAddress(long emailAddressId)
emailAddressId
- the primary key for the new email address
void deleteEmailAddress(long emailAddressId) throws PortalException, SystemException
emailAddressId
- the primary key of the email address to delete
PortalException
- if a email address with the primary key could not be found
SystemException
- if a system exception occurredvoid deleteEmailAddress(EmailAddress emailAddress) throws SystemException
emailAddress
- the email address to delete
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) EmailAddress getEmailAddress(long emailAddressId) throws PortalException, SystemException
emailAddressId
- the primary key of the email address to get
PortalException
- if a email address with the primary key could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<EmailAddress> getEmailAddresses(int start, int end) throws SystemException
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.
start
- the lower bound of the range of email addresses to returnend
- the upper bound of the range of email addresses to return (not inclusive)
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getEmailAddressesCount() throws SystemException
SystemException
- if a system exception occurredEmailAddress updateEmailAddress(EmailAddress emailAddress) throws SystemException
emailAddress
- the email address to update
SystemException
- if a system exception occurredEmailAddress updateEmailAddress(EmailAddress emailAddress, boolean merge) throws SystemException
emailAddress
- the email address to updatemerge
- 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.
SystemException
- if a system exception occurredEmailAddress addEmailAddress(long userId, String className, long classPK, String address, int typeId, boolean primary) throws PortalException, SystemException
PortalException
SystemException
void deleteEmailAddresses(long companyId, String className, long classPK) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<EmailAddress> getEmailAddresses() throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<EmailAddress> getEmailAddresses(long companyId, String className, long classPK) throws SystemException
SystemException
EmailAddress updateEmailAddress(long emailAddressId, String address, int typeId, boolean primary) throws PortalException, SystemException
PortalException
SystemException
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |