com.liferay.object.service.base.ObjectFieldLocalServiceBaseImpl Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.object.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.object.model.ObjectField;
import com.liferay.object.service.ObjectFieldLocalService;
import com.liferay.object.service.persistence.ObjectFieldPersistence;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.aop.AopService;
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.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.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.PersistedModelLocalService;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
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.util.List;
import javax.sql.DataSource;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;
/**
* Provides the base implementation for the object field 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.object.service.impl.ObjectFieldLocalServiceImpl}.
*
*
* @author Marco Leo
* @see com.liferay.object.service.impl.ObjectFieldLocalServiceImpl
* @generated
*/
public abstract class ObjectFieldLocalServiceBaseImpl
extends BaseLocalServiceImpl
implements AopService, IdentifiableOSGiService, ObjectFieldLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this class directly. Use ObjectFieldLocalService
via injection or a org.osgi.util.tracker.ServiceTracker
or use com.liferay.object.service.ObjectFieldLocalServiceUtil
.
*/
/**
* Adds the object field to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectFieldLocalServiceImpl 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 objectField the object field
* @return the object field that was added
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public ObjectField addObjectField(ObjectField objectField) {
objectField.setNew(true);
return objectFieldPersistence.update(objectField);
}
/**
* Creates a new object field with the primary key. Does not add the object field to the database.
*
* @param objectFieldId the primary key for the new object field
* @return the new object field
*/
@Override
@Transactional(enabled = false)
public ObjectField createObjectField(long objectFieldId) {
return objectFieldPersistence.create(objectFieldId);
}
/**
* Deletes the object field with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectFieldLocalServiceImpl 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 objectFieldId the primary key of the object field
* @return the object field that was removed
* @throws PortalException if a object field with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
@Override
public ObjectField deleteObjectField(long objectFieldId)
throws PortalException {
return objectFieldPersistence.remove(objectFieldId);
}
/**
* Deletes the object field from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectFieldLocalServiceImpl 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 objectField the object field
* @return the object field that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@Override
public ObjectField deleteObjectField(ObjectField objectField)
throws PortalException {
return objectFieldPersistence.remove(objectField);
}
@Override
public T dslQuery(DSLQuery dslQuery) {
return objectFieldPersistence.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(
ObjectField.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 objectFieldPersistence.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.object.model.impl.ObjectFieldModelImpl
.
*
*
* @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 objectFieldPersistence.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.object.model.impl.ObjectFieldModelImpl
.
*
*
* @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 objectFieldPersistence.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 objectFieldPersistence.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 objectFieldPersistence.countWithDynamicQuery(
dynamicQuery, projection);
}
@Override
public ObjectField fetchObjectField(long objectFieldId) {
return objectFieldPersistence.fetchByPrimaryKey(objectFieldId);
}
/**
* Returns the object field with the matching UUID and company.
*
* @param uuid the object field's UUID
* @param companyId the primary key of the company
* @return the matching object field, or null
if a matching object field could not be found
*/
@Override
public ObjectField fetchObjectFieldByUuidAndCompanyId(
String uuid, long companyId) {
return objectFieldPersistence.fetchByUuid_C_First(
uuid, companyId, null);
}
/**
* Returns the object field with the primary key.
*
* @param objectFieldId the primary key of the object field
* @return the object field
* @throws PortalException if a object field with the primary key could not be found
*/
@Override
public ObjectField getObjectField(long objectFieldId)
throws PortalException {
return objectFieldPersistence.findByPrimaryKey(objectFieldId);
}
@Override
public ActionableDynamicQuery getActionableDynamicQuery() {
ActionableDynamicQuery actionableDynamicQuery =
new DefaultActionableDynamicQuery();
actionableDynamicQuery.setBaseLocalService(objectFieldLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(ObjectField.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("objectFieldId");
return actionableDynamicQuery;
}
@Override
public IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
IndexableActionableDynamicQuery indexableActionableDynamicQuery =
new IndexableActionableDynamicQuery();
indexableActionableDynamicQuery.setBaseLocalService(
objectFieldLocalService);
indexableActionableDynamicQuery.setClassLoader(getClassLoader());
indexableActionableDynamicQuery.setModelClass(ObjectField.class);
indexableActionableDynamicQuery.setPrimaryKeyPropertyName(
"objectFieldId");
return indexableActionableDynamicQuery;
}
protected void initActionableDynamicQuery(
ActionableDynamicQuery actionableDynamicQuery) {
actionableDynamicQuery.setBaseLocalService(objectFieldLocalService);
actionableDynamicQuery.setClassLoader(getClassLoader());
actionableDynamicQuery.setModelClass(ObjectField.class);
actionableDynamicQuery.setPrimaryKeyPropertyName("objectFieldId");
}
@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");
}
});
exportActionableDynamicQuery.setCompanyId(
portletDataContext.getCompanyId());
exportActionableDynamicQuery.setPerformActionMethod(
new ActionableDynamicQuery.PerformActionMethod() {
@Override
public void performAction(ObjectField objectField)
throws PortalException {
StagedModelDataHandlerUtil.exportStagedModel(
portletDataContext, objectField);
}
});
exportActionableDynamicQuery.setStagedModelType(
new StagedModelType(
PortalUtil.getClassNameId(ObjectField.class.getName())));
return exportActionableDynamicQuery;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return objectFieldPersistence.create(((Long)primaryKeyObj).longValue());
}
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException {
if (_log.isWarnEnabled()) {
_log.warn(
"Implement ObjectFieldLocalServiceImpl#deleteObjectField(ObjectField) to avoid orphaned data");
}
return objectFieldLocalService.deleteObjectField(
(ObjectField)persistedModel);
}
@Override
public BasePersistence getBasePersistence() {
return objectFieldPersistence;
}
/**
* @throws PortalException
*/
@Override
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return objectFieldPersistence.findByPrimaryKey(primaryKeyObj);
}
/**
* Returns the object field with the matching UUID and company.
*
* @param uuid the object field's UUID
* @param companyId the primary key of the company
* @return the matching object field
* @throws PortalException if a matching object field could not be found
*/
@Override
public ObjectField getObjectFieldByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException {
return objectFieldPersistence.findByUuid_C_First(uuid, companyId, null);
}
/**
* Returns a range of all the object fields.
*
*
* 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.object.model.impl.ObjectFieldModelImpl
.
*
*
* @param start the lower bound of the range of object fields
* @param end the upper bound of the range of object fields (not inclusive)
* @return the range of object fields
*/
@Override
public List getObjectFields(int start, int end) {
return objectFieldPersistence.findAll(start, end);
}
/**
* Returns the number of object fields.
*
* @return the number of object fields
*/
@Override
public int getObjectFieldsCount() {
return objectFieldPersistence.countAll();
}
/**
* Updates the object field in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectFieldLocalServiceImpl 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 objectField the object field
* @return the object field that was updated
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public ObjectField updateObjectField(ObjectField objectField) {
return objectFieldPersistence.update(objectField);
}
@Deactivate
protected void deactivate() {
}
@Override
public Class>[] getAopInterfaces() {
return new Class>[] {
ObjectFieldLocalService.class, IdentifiableOSGiService.class,
PersistedModelLocalService.class
};
}
@Override
public void setAopProxy(Object aopProxy) {
objectFieldLocalService = (ObjectFieldLocalService)aopProxy;
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
@Override
public String getOSGiServiceIdentifier() {
return ObjectFieldLocalService.class.getName();
}
protected Class> getModelClass() {
return ObjectField.class;
}
protected String getModelClassName() {
return ObjectField.class.getName();
}
/**
* Performs a SQL query.
*
* @param sql the sql query
*/
protected void runSQL(String sql) {
try {
DataSource dataSource = objectFieldPersistence.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);
}
}
protected ObjectFieldLocalService objectFieldLocalService;
@Reference
protected ObjectFieldPersistence objectFieldPersistence;
@Reference
protected com.liferay.counter.kernel.service.CounterLocalService
counterLocalService;
private static final Log _log = LogFactoryUtil.getLog(
ObjectFieldLocalServiceBaseImpl.class);
}