com.liferay.object.service.ObjectFieldLocalService 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;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.object.model.ObjectField;
import com.liferay.object.model.ObjectFieldSetting;
import com.liferay.petra.sql.dsl.Column;
import com.liferay.petra.sql.dsl.Table;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
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.model.PersistedModel;
import com.liferay.portal.kernel.model.SystemEventConstants;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.systemevent.SystemEvent;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for ObjectField. 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.
*
* @author Marco Leo
* @see ObjectFieldLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface ObjectFieldLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.object.service.impl.ObjectFieldLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the object field local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link ObjectFieldLocalServiceUtil} if injection and service tracking are not available.
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectField addCustomObjectField(
String externalReferenceCode, long userId,
long listTypeDefinitionId, long objectDefinitionId,
String businessType, String dbType, boolean indexed,
boolean indexedAsKeyword, String indexedLanguageId,
Map labelMap, boolean localized, String name,
String readOnly, String readOnlyConditionExpression,
boolean required, boolean state,
List objectFieldSettings)
throws PortalException;
/**
* 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)
public ObjectField addObjectField(ObjectField objectField);
@Indexable(type = IndexableType.REINDEX)
public ObjectField addOrUpdateCustomObjectField(
String externalReferenceCode, long objectFieldId, long userId,
long listTypeDefinitionId, long objectDefinitionId,
String businessType, String dbType, boolean indexed,
boolean indexedAsKeyword, String indexedLanguageId,
Map labelMap, boolean localized, String name,
String readOnly, String readOnlyConditionExpression,
boolean required, boolean state,
List objectFieldSettings)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public ObjectField addOrUpdateSystemObjectField(
String externalReferenceCode, long userId,
long listTypeDefinitionId, long objectDefinitionId,
String businessType, String dbColumnName, String dbTableName,
String dbType, boolean indexed, boolean indexedAsKeyword,
String indexedLanguageId, Map labelMap,
boolean localized, String name, String readOnly,
String readOnlyConditionExpression, boolean required, boolean state,
List objectFieldSettings)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public ObjectField addSystemObjectField(
String externalReferenceCode, long userId,
long listTypeDefinitionId, long objectDefinitionId,
String businessType, String dbColumnName, String dbTableName,
String dbType, boolean indexed, boolean indexedAsKeyword,
String indexedLanguageId, Map labelMap,
boolean localized, String name, String readOnly,
String readOnlyConditionExpression, boolean required, boolean state,
List objectFieldSettings)
throws PortalException;
/**
* 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
*/
@Transactional(enabled = false)
public ObjectField createObjectField(long objectFieldId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* 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)
public ObjectField deleteObjectField(long objectFieldId)
throws PortalException;
/**
* 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)
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public ObjectField deleteObjectField(ObjectField objectField)
throws PortalException;
public void deleteObjectFieldByObjectDefinitionId(Long objectDefinitionId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@Indexable(type = IndexableType.DELETE)
public ObjectField deleteRelationshipTypeObjectField(long objectFieldId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public T dslQuery(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int dslQueryCount(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectField fetchObjectField(long objectFieldId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectField fetchObjectField(long objectDefinitionId, String name);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectField fetchObjectField(
String externalReferenceCode, long objectDefinitionId);
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectField fetchObjectFieldByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getActiveObjectFields(
List objectFields)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Column getColumn(long objectDefinitionId, String name);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCustomObjectFields(long objectDefinitionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getListTypeDefinitionObjectFields(
long listTypeDefinitionId, boolean state);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLocalizedObjectFields(long objectDefinitionId);
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectField getObjectField(long objectFieldId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectField getObjectField(long objectDefinitionId, String name)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectField getObjectField(
String externalReferenceCode, long objectDefinitionId)
throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectField getObjectFieldByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectFields(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectFields(long objectDefinitionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectFields(
long objectDefinitionId, boolean system);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectFields(
long objectDefinitionId, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectFields(
long objectDefinitionId, String dbTableName);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectFieldsByBusinessType(
long objectDefinitionId, String businessType);
/**
* Returns the number of object fields.
*
* @return the number of object fields
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectFieldsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectFieldsCount(long objectDefinitionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectFieldsCount(long objectDefinitionId, boolean system);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectFieldsCountByListTypeDefinitionId(
long listTypeDefinitionId);
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* @throws PortalException
*/
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Table getTable(long objectDefinitionId, String name)
throws PortalException;
/**
* 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)
public ObjectField updateObjectField(ObjectField objectField);
public ObjectField updateObjectField(
String externalReferenceCode, long objectFieldId, long userId,
long listTypeDefinitionId, long objectDefinitionId,
String businessType, String dbColumnName, String dbTableName,
String dbType, boolean indexed, boolean indexedAsKeyword,
String indexedLanguageId, Map labelMap,
boolean localized, String name, String readOnly,
String readOnlyConditionExpression, boolean required, boolean state,
boolean system, List objectFieldSettings)
throws PortalException;
@Indexable(type = IndexableType.REINDEX)
public ObjectField updateRequired(long objectFieldId, boolean required)
throws PortalException;
public void updateUserId(long companyId, long oldUserId, long newUserId)
throws PortalException;
public void validateExternalReferenceCode(
String externalReferenceCode, long objectFieldId, long companyId,
long objectDefinitionId)
throws PortalException;
public void validateReadOnlyAndReadOnlyConditionExpression(
String businessType, String readOnly,
String readOnlyConditionExpression, boolean required)
throws PortalException;
public void validateRequired(
String businessType, boolean objectDefinitionApproved,
ObjectField oldObjectField, boolean required)
throws PortalException;
}