com.liferay.object.service.ObjectValidationRuleLocalService 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.ObjectValidationRule;
import com.liferay.object.model.ObjectValidationRuleSetting;
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.json.JSONObject;
import com.liferay.portal.kernel.model.BaseModel;
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 ObjectValidationRule. 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 ObjectValidationRuleLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface ObjectValidationRuleLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.object.service.impl.ObjectValidationRuleLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the object validation rule local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link ObjectValidationRuleLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the object validation rule to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectValidationRuleLocalServiceImpl 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 objectValidationRule the object validation rule
* @return the object validation rule that was added
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectValidationRule addObjectValidationRule(
ObjectValidationRule objectValidationRule);
@Indexable(type = IndexableType.REINDEX)
public ObjectValidationRule addObjectValidationRule(
String externalReferenceCode, long userId, long objectDefinitionId,
boolean active, String engine, Map errorLabelMap,
Map nameMap, String outputType, String script,
boolean system,
List objectValidationRuleSettings)
throws PortalException;
/**
* Creates a new object validation rule with the primary key. Does not add the object validation rule to the database.
*
* @param objectValidationRuleId the primary key for the new object validation rule
* @return the new object validation rule
*/
@Transactional(enabled = false)
public ObjectValidationRule createObjectValidationRule(
long objectValidationRuleId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Deletes the object validation rule with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectValidationRuleLocalServiceImpl 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 objectValidationRuleId the primary key of the object validation rule
* @return the object validation rule that was removed
* @throws PortalException if a object validation rule with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public ObjectValidationRule deleteObjectValidationRule(
long objectValidationRuleId)
throws PortalException;
/**
* Deletes the object validation rule from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectValidationRuleLocalServiceImpl 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 objectValidationRule the object validation rule
* @return the object validation rule that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public ObjectValidationRule deleteObjectValidationRule(
ObjectValidationRule objectValidationRule)
throws PortalException;
public void deleteObjectValidationRules(Long objectDefinitionId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
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.ObjectValidationRuleModelImpl.
*
*
* @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.ObjectValidationRuleModelImpl.
*
*
* @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 ObjectValidationRule fetchObjectValidationRule(
long objectValidationRuleId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectValidationRule fetchObjectValidationRule(
String externalReferenceCode, long objectDefinitionId);
/**
* Returns the object validation rule with the matching UUID and company.
*
* @param uuid the object validation rule's UUID
* @param companyId the primary key of the company
* @return the matching object validation rule, or null if a matching object validation rule could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectValidationRule fetchObjectValidationRuleByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the object validation rule with the primary key.
*
* @param objectValidationRuleId the primary key of the object validation rule
* @return the object validation rule
* @throws PortalException if a object validation rule with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectValidationRule getObjectValidationRule(
long objectValidationRuleId)
throws PortalException;
/**
* Returns the object validation rule with the matching UUID and company.
*
* @param uuid the object validation rule's UUID
* @param companyId the primary key of the company
* @return the matching object validation rule
* @throws PortalException if a matching object validation rule could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectValidationRule getObjectValidationRuleByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectValidationRules(
boolean active, String engine);
/**
* Returns a range of all the object validation rules.
*
*
* 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.ObjectValidationRuleModelImpl.
*
*
* @param start the lower bound of the range of object validation rules
* @param end the upper bound of the range of object validation rules (not inclusive)
* @return the range of object validation rules
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectValidationRules(
int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectValidationRules(
long objectDefinitionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectValidationRules(
long objectDefinitionId, boolean active);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectValidationRules(
long objectDefinitionId, String engine);
/**
* Returns the number of object validation rules.
*
* @return the number of object validation rules
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectValidationRulesCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectValidationRulesCount(
long objectDefinitionId, boolean active);
/**
* 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;
public void unassociateObjectField(ObjectField objectField);
/**
* Updates the object validation rule in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectValidationRuleLocalServiceImpl 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 objectValidationRule the object validation rule
* @return the object validation rule that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectValidationRule updateObjectValidationRule(
ObjectValidationRule objectValidationRule);
@Indexable(type = IndexableType.REINDEX)
public ObjectValidationRule updateObjectValidationRule(
String externalReferenceCode, long objectValidationRuleId,
boolean active, String engine, Map errorLabelMap,
Map nameMap, String outputType, String script,
List objectValidationRuleSettings)
throws PortalException;
@Transactional(readOnly = true)
public void validate(
BaseModel baseModel, long objectDefinitionId,
JSONObject payloadJSONObject, long userId)
throws PortalException;
}