/portal-service/src/com/liferay/portal/service/EmailAddressLocalService.java
https://github.com/linyuqun/liferay-portal-1 · Java · 261 lines · 87 code · 25 blank · 149 comment · 0 complexity · a1fff20b2e3ae2d3f3de2b9a65f72aa0 MD5 · raw file
- /**
- * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
- *
- * This library is free software; you can redistribute it and/or modify it under
- * the terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation; either version 2.1 of the License, or (at your option)
- * any later version.
- *
- * This library is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
- * details.
- */
- package com.liferay.portal.service;
- import com.liferay.portal.kernel.exception.PortalException;
- import com.liferay.portal.kernel.exception.SystemException;
- import com.liferay.portal.kernel.transaction.Isolation;
- import com.liferay.portal.kernel.transaction.Propagation;
- import com.liferay.portal.kernel.transaction.Transactional;
- /**
- * The interface for the email address local service.
- *
- * <p>
- * 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.
- * </p>
- *
- * @author Brian Wing Shun Chan
- * @see EmailAddressLocalServiceUtil
- * @see com.liferay.portal.service.base.EmailAddressLocalServiceBaseImpl
- * @see com.liferay.portal.service.impl.EmailAddressLocalServiceImpl
- * @generated
- */
- @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
- PortalException.class, SystemException.class})
- public interface EmailAddressLocalService extends PersistedModelLocalService {
- /*
- * NOTE FOR DEVELOPERS:
- *
- * Never modify or reference this interface directly. Always use {@link EmailAddressLocalServiceUtil} to access the email address local service. Add custom service methods to {@link com.liferay.portal.service.impl.EmailAddressLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
- */
- /**
- * Adds the email address to the database. Also notifies the appropriate model listeners.
- *
- * @param emailAddress the email address
- * @return the email address that was added
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.EmailAddress addEmailAddress(
- com.liferay.portal.model.EmailAddress emailAddress)
- throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Creates a new email address with the primary key. Does not add the email address to the database.
- *
- * @param emailAddressId the primary key for the new email address
- * @return the new email address
- */
- public com.liferay.portal.model.EmailAddress createEmailAddress(
- long emailAddressId);
- /**
- * Deletes the email address with the primary key from the database. Also notifies the appropriate model listeners.
- *
- * @param emailAddressId the primary key of the email address
- * @throws PortalException if a email address with the primary key could not be found
- * @throws SystemException if a system exception occurred
- */
- public void deleteEmailAddress(long emailAddressId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException;
- /**
- * Deletes the email address from the database. Also notifies the appropriate model listeners.
- *
- * @param emailAddress the email address
- * @throws SystemException if a system exception occurred
- */
- public void deleteEmailAddress(
- com.liferay.portal.model.EmailAddress emailAddress)
- throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Performs a dynamic query on the database and returns the matching rows.
- *
- * @param dynamicQuery the dynamic query
- * @return the matching rows
- * @throws SystemException if a system exception occurred
- */
- @SuppressWarnings("rawtypes")
- public java.util.List dynamicQuery(
- com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
- throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Performs a dynamic query on the database and returns a range of the matching rows.
- *
- * <p>
- * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
- * </p>
- *
- * @param dynamicQuery the dynamic query
- * @param start the lower bound of the range of model instances
- * @param end the upper bound of the range of model instances (not inclusive)
- * @return the range of matching rows
- * @throws SystemException if a system exception occurred
- */
- @SuppressWarnings("rawtypes")
- public java.util.List dynamicQuery(
- com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
- int end) throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Performs a dynamic query on the database and returns an ordered range of the matching rows.
- *
- * <p>
- * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
- * </p>
- *
- * @param dynamicQuery the dynamic query
- * @param start the lower bound of the range of model instances
- * @param end the upper bound of the range of model instances (not inclusive)
- * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
- * @return the ordered range of matching rows
- * @throws SystemException if a system exception occurred
- */
- @SuppressWarnings("rawtypes")
- public java.util.List dynamicQuery(
- com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
- int end,
- com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
- throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Returns the number of rows that match the dynamic query.
- *
- * @param dynamicQuery the dynamic query
- * @return the number of rows that match the dynamic query
- * @throws SystemException if a system exception occurred
- */
- public long dynamicQueryCount(
- com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
- throws com.liferay.portal.kernel.exception.SystemException;
- @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
- public com.liferay.portal.model.EmailAddress fetchEmailAddress(
- long emailAddressId)
- throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Returns the email address with the primary key.
- *
- * @param emailAddressId the primary key of the email address
- * @return the email address
- * @throws PortalException if a email address with the primary key could not be found
- * @throws SystemException if a system exception occurred
- */
- @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
- public com.liferay.portal.model.EmailAddress getEmailAddress(
- long emailAddressId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException;
- @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
- public com.liferay.portal.model.PersistedModel getPersistedModel(
- java.io.Serializable primaryKeyObj)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException;
- /**
- * Returns a range of all the email addresses.
- *
- * <p>
- * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
- * </p>
- *
- * @param start the lower bound of the range of email addresses
- * @param end the upper bound of the range of email addresses (not inclusive)
- * @return the range of email addresses
- * @throws SystemException if a system exception occurred
- */
- @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
- public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses(
- int start, int end)
- throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Returns the number of email addresses.
- *
- * @return the number of email addresses
- * @throws SystemException if a system exception occurred
- */
- @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
- public int getEmailAddressesCount()
- throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Updates the email address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
- *
- * @param emailAddress the email address
- * @return the email address that was updated
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.EmailAddress updateEmailAddress(
- com.liferay.portal.model.EmailAddress emailAddress)
- throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Updates the email address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
- *
- * @param emailAddress the email address
- * @param merge whether to merge the email address with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
- * @return the email address that was updated
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.EmailAddress updateEmailAddress(
- com.liferay.portal.model.EmailAddress emailAddress, boolean merge)
- throws com.liferay.portal.kernel.exception.SystemException;
- /**
- * Returns the Spring bean ID for this bean.
- *
- * @return the Spring bean ID for this bean
- */
- public java.lang.String getBeanIdentifier();
- /**
- * Sets the Spring bean ID for this bean.
- *
- * @param beanIdentifier the Spring bean ID for this bean
- */
- public void setBeanIdentifier(java.lang.String beanIdentifier);
- public com.liferay.portal.model.EmailAddress addEmailAddress(long userId,
- java.lang.String className, long classPK, java.lang.String address,
- int typeId, boolean primary)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException;
- public void deleteEmailAddresses(long companyId,
- java.lang.String className, long classPK)
- throws com.liferay.portal.kernel.exception.SystemException;
- @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
- public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses()
- throws com.liferay.portal.kernel.exception.SystemException;
- @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
- public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses(
- long companyId, java.lang.String className, long classPK)
- throws com.liferay.portal.kernel.exception.SystemException;
- public com.liferay.portal.model.EmailAddress updateEmailAddress(
- long emailAddressId, java.lang.String address, int typeId,
- boolean primary)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException;
- }