com.liferay.portal.service.base.EmailAddressLocalServiceBaseImpl Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present 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.base;
import com.liferay.exportimport.kernel.lar.ExportImportHelperUtil;
import com.liferay.exportimport.kernel.lar.ManifestSummary;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerUtil;
import com.liferay.exportimport.kernel.lar.StagedModelType;
import com.liferay.petra.function.UnsafeFunction;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.bean.BeanReference;
import com.liferay.portal.kernel.dao.db.DB;
import com.liferay.portal.kernel.dao.db.DBManagerUtil;
import com.liferay.portal.kernel.dao.jdbc.SqlUpdate;
import com.liferay.portal.kernel.dao.jdbc.SqlUpdateFactoryUtil;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DefaultActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQueryFactoryUtil;
import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.dao.orm.Property;
import com.liferay.portal.kernel.dao.orm.PropertyFactoryUtil;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.model.EmailAddress;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalServiceImpl;
import com.liferay.portal.kernel.service.EmailAddressLocalService;
import com.liferay.portal.kernel.service.EmailAddressLocalServiceUtil;
import com.liferay.portal.kernel.service.PersistedModelLocalServiceRegistry;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
import com.liferay.portal.kernel.service.persistence.EmailAddressPersistence;
import com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.portal.kernel.util.PortalUtil;
import java.io.Serializable;
import java.lang.reflect.Field;
import java.util.List;
import javax.sql.DataSource;
/**
* Provides the base implementation for the email address local service.
*
*
* This implementation exists only as a container for the default service methods generated by ServiceBuilder. All custom service methods should be put in {@link com.liferay.portal.service.impl.EmailAddressLocalServiceImpl}.
*
*
* @author Brian Wing Shun Chan
* @see com.liferay.portal.service.impl.EmailAddressLocalServiceImpl
* @generated
*/
public abstract class EmailAddressLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements EmailAddressLocalService, IdentifiableOSGiService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use EmailAddressLocalService via injection or a org.osgi.util.tracker.ServiceTracker or use EmailAddressLocalServiceUtil.
*/
/**
* Adds the email address to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect EmailAddressLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
*
*
* @param emailAddress the email address
* @return the email address that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public EmailAddress addEmailAddress(EmailAddress emailAddress) {
emailAddress.setNew(true);
return emailAddressPersistence.update(emailAddress);
}
/**
* 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
*/
@Override
@Transactional(enabled = false)
public EmailAddress createEmailAddress(long emailAddressId) {
return emailAddressPersistence.create(emailAddressId);
}
/**
* Deletes the email address with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect EmailAddressLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
*
*
* @param emailAddressId the primary key of the email address
* @return the email address that was removed
* @throws PortalException if a email address with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public EmailAddress deleteEmailAddress(long emailAddressId)
throws PortalException {
return emailAddressPersistence.remove(emailAddressId);
}
/**
* Deletes the email address from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect EmailAddressLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
*
*
* @param emailAddress the email address
* @return the email address that was removed
*/
@Indexable(type = IndexableType.DELETE)
@Override
public EmailAddress deleteEmailAddress(EmailAddress emailAddress) {
return emailAddressPersistence.remove(emailAddress);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return emailAddressPersistence.dslQuery(dslQuery);
}
@Override
public int dslQueryCount(DSLQuery dslQuery) {
Long count = dslQuery(dslQuery);
return count.intValue();
}
@Override
public DynamicQuery dynamicQuery() {
Class> clazz = getClass();
return DynamicQueryFactoryUtil.forClass(
EmailAddress.class, clazz.getClassLoader());
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Override
public List dynamicQuery(DynamicQuery dynamicQuery) {
return emailAddressPersistence.findWithDynamicQuery(dynamicQuery);
}
/**
* 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.EmailAddressModelImpl.
*
*
* @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
*/
@Override
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end) {
return emailAddressPersistence.findWithDynamicQuery(
dynamicQuery, start, end);
}
/**
* 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.EmailAddressModelImpl.
*
*
* @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 null)
* @return the ordered range of matching rows
*/
@Override
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator) {
return emailAddressPersistence.findWithDynamicQuery(
dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Override
public long dynamicQueryCount(DynamicQuery dynamicQuery) {
return emailAddressPersistence.countWithDynamicQuery(dynamicQuery);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
@Override
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection) {
return emailAddressPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public EmailAddress fetchEmailAddress(long emailAddressId) {
return emailAddressPersistence.fetchByPrimaryKey(emailAddressId);
}
/**
* Returns the email address with the matching UUID and company.
*
* @param uuid the email address's UUID
* @param companyId the primary key of the company
* @return the matching email address, or null if a matching email address could not be found
*/
@Override
public EmailAddress fetchEmailAddressByUuidAndCompanyId(
String uuid, long companyId) {
return emailAddressPersistence.fetchByUuid_C_First(
uuid, companyId, null);
}
/**
* 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
*/
@Override
public EmailAddress getEmailAddress(long emailAddressId)
throws PortalException {
return emailAddressPersistence.findByPrimaryKey(emailAddressId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(emailAddressLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(EmailAddress.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("emailAddressId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
emailAddressLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(EmailAddress.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"emailAddressId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(emailAddressLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(EmailAddress.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("emailAddressId");
}
@Override
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
final PortletDataContext portletDataContext) {
final ExportActionableDynamicQuery exportActionableDynamicQuery =
new ExportActionableDynamicQuery() {
@Override
public long performCount() throws PortalException {
ManifestSummary manifestSummary =
portletDataContext.getManifestSummary();
StagedModelType stagedModelType = getStagedModelType();
long modelAdditionCount = super.performCount();
manifestSummary.addModelAdditionCount(
stagedModelType, modelAdditionCount);
long modelDeletionCount =
ExportImportHelperUtil.getModelDeletionCount(
portletDataContext, stagedModelType);
manifestSummary.addModelDeletionCount(
stagedModelType, modelDeletionCount);
return modelAdditionCount;
}
};
initActionableDynamicQuery(exportActionableDynamicQuery);
exportActionableDynamicQuery.setAddCriteriaMethod(
new ActionableDynamicQuery.AddCriteriaMethod() {
@Override
public void addCriteria(DynamicQuery dynamicQuery) {
portletDataContext.addDateRangeCriteria(
dynamicQuery, "modifiedDate");
StagedModelType stagedModelType =
exportActionableDynamicQuery.getStagedModelType();
long referrerClassNameId =
stagedModelType.getReferrerClassNameId();
Property classNameIdProperty = PropertyFactoryUtil.forName(
"classNameId");
if ((referrerClassNameId !=
StagedModelType.REFERRER_CLASS_NAME_ID_ALL) &&
(referrerClassNameId !=
StagedModelType.REFERRER_CLASS_NAME_ID_ANY)) {
dynamicQuery.add(
classNameIdProperty.eq(
stagedModelType.getReferrerClassNameId()));
}
else if (referrerClassNameId ==
StagedModelType.REFERRER_CLASS_NAME_ID_ANY) {
dynamicQuery.add(classNameIdProperty.isNotNull());
}
}
});
exportActionableDynamicQuery.setCompanyId(
portletDataContext.getCompanyId());
exportActionableDynamicQuery.setPerformActionMethod(
new ActionableDynamicQuery.PerformActionMethod() {
@Override
public void performAction(EmailAddress emailAddress)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, emailAddress);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(EmailAddress.class.getName()),
StagedModelType.REFERRER_CLASS_NAME_ID_ALL));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return emailAddressPersistence.create(
((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement EmailAddressLocalServiceImpl#deleteEmailAddress(EmailAddress) to avoid orphaned data");
}
return emailAddressLocalService.deleteEmailAddress(
(EmailAddress)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return emailAddressPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return emailAddressPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns the email address with the matching UUID and company.
*
* @param uuid the email address's UUID
* @param companyId the primary key of the company
* @return the matching email address
* @throws PortalException if a matching email address could not be found
*/
@Override
public EmailAddress getEmailAddressByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException {
return emailAddressPersistence.findByUuid_C_First(
uuid, companyId, null);
}
/**
* 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.EmailAddressModelImpl.
*
*
* @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
*/
@Override
public List getEmailAddresses(int start, int end) {
return emailAddressPersistence.findAll(start, end);
}
/**
* Returns the number of email addresses.
*
* @return the number of email addresses
*/
@Override
public int getEmailAddressesCount() {
return emailAddressPersistence.countAll();
}
/**
* Updates the email address in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect EmailAddressLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
*
*
* @param emailAddress the email address
* @return the email address that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public EmailAddress updateEmailAddress(EmailAddress emailAddress) {
return emailAddressPersistence.update(emailAddress);
}
/**
* Returns the email address local service.
*
* @return the email address local service
*/
public EmailAddressLocalService getEmailAddressLocalService() {
return emailAddressLocalService;
}
/**
* Sets the email address local service.
*
* @param emailAddressLocalService the email address local service
*/
public void setEmailAddressLocalService(
EmailAddressLocalService emailAddressLocalService) {
this.emailAddressLocalService = emailAddressLocalService;
}
/**
* Returns the email address persistence.
*
* @return the email address persistence
*/
public EmailAddressPersistence getEmailAddressPersistence() {
return emailAddressPersistence;
}
/**
* Sets the email address persistence.
*
* @param emailAddressPersistence the email address persistence
*/
public void setEmailAddressPersistence(
EmailAddressPersistence emailAddressPersistence) {
this.emailAddressPersistence = emailAddressPersistence;
}
/**
* Returns the counter local service.
*
* @return the counter local service
*/
public com.liferay.counter.kernel.service.CounterLocalService
getCounterLocalService() {
return counterLocalService;
}
/**
* Sets the counter local service.
*
* @param counterLocalService the counter local service
*/
public void setCounterLocalService(
com.liferay.counter.kernel.service.CounterLocalService
counterLocalService) {
this.counterLocalService = counterLocalService;
}
public void afterPropertiesSet() {
persistedModelLocalServiceRegistry.register(
"com.liferay.portal.kernel.model.EmailAddress",
emailAddressLocalService);
_setLocalServiceUtilService(emailAddressLocalService);
}
public void destroy() {
persistedModelLocalServiceRegistry.unregister(
"com.liferay.portal.kernel.model.EmailAddress");
_setLocalServiceUtilService(null);
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return EmailAddressLocalService.class.getName();
}
@Override
public CTPersistence getCTPersistence() {
return emailAddressPersistence;
}
@Override
public Class getModelClass() {
return EmailAddress.class;
}
@Override
public R updateWithUnsafeFunction(
UnsafeFunction, R, E>
updateUnsafeFunction)
throws E {
return updateUnsafeFunction.apply(emailAddressPersistence);
}
protected String getModelClassName() {
return EmailAddress.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = emailAddressPersistence.getDataSource();
DB db = DBManagerUtil.getDB();
sql = db.buildSQL(sql);
sql = PortalUtil.transformSQL(sql);
SqlUpdate sqlUpdate = SqlUpdateFactoryUtil.getSqlUpdate(
dataSource, sql);
sqlUpdate.update();
}
catch (Exception exception) {
throw new SystemException(exception);
}
}
private void _setLocalServiceUtilService(
EmailAddressLocalService emailAddressLocalService) {
try {
Field field = EmailAddressLocalServiceUtil.class.getDeclaredField(
"_service");
field.setAccessible(true);
field.set(null, emailAddressLocalService);
}
catch (ReflectiveOperationException reflectiveOperationException) {
throw new RuntimeException(reflectiveOperationException);
}
}
@BeanReference(type = EmailAddressLocalService.class)
protected EmailAddressLocalService emailAddressLocalService;
@BeanReference(type = EmailAddressPersistence.class)
protected EmailAddressPersistence emailAddressPersistence;
@BeanReference(
type = com.liferay.counter.kernel.service.CounterLocalService.class
)
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
EmailAddressLocalServiceBaseImpl.class);
@BeanReference(type = PersistedModelLocalServiceRegistry.class)
protected PersistedModelLocalServiceRegistry
persistedModelLocalServiceRegistry;
}