Interface ObjectValidationRuleLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
ObjectValidationRuleLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface ObjectValidationRuleLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
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.
See Also:
Generated:
  • Method Details

    • addObjectValidationRule

      @Indexable(type=REINDEX) ObjectValidationRule addObjectValidationRule(ObjectValidationRule objectValidationRule)
      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.

      Parameters:
      objectValidationRule - the object validation rule
      Returns:
      the object validation rule that was added
    • addObjectValidationRule

      @Indexable(type=REINDEX) ObjectValidationRule addObjectValidationRule(String externalReferenceCode, long userId, long objectDefinitionId, boolean active, String engine, Map<Locale,String> errorLabelMap, Map<Locale,String> nameMap, String outputType, String script, boolean system, List<ObjectValidationRuleSetting> objectValidationRuleSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createObjectValidationRule

      @Transactional(enabled=false) ObjectValidationRule createObjectValidationRule(long objectValidationRuleId)
      Creates a new object validation rule with the primary key. Does not add the object validation rule to the database.
      Parameters:
      objectValidationRuleId - the primary key for the new object validation rule
      Returns:
      the new object validation rule
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectValidationRule

      @Indexable(type=DELETE) ObjectValidationRule deleteObjectValidationRule(long objectValidationRuleId) throws com.liferay.portal.kernel.exception.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.

      Parameters:
      objectValidationRuleId - the primary key of the object validation rule
      Returns:
      the object validation rule that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object validation rule with the primary key could not be found
    • deleteObjectValidationRule

      @Indexable(type=DELETE) @SystemEvent(type=1) ObjectValidationRule deleteObjectValidationRule(ObjectValidationRule objectValidationRule) throws com.liferay.portal.kernel.exception.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.

      Parameters:
      objectValidationRule - the object validation rule
      Returns:
      the object validation rule that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectValidationRules

      void deleteObjectValidationRules(Long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
      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.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      Returns:
      the range of matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
      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.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchObjectValidationRule

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectValidationRule fetchObjectValidationRule(long objectValidationRuleId)
    • fetchObjectValidationRule

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectValidationRule fetchObjectValidationRule(String externalReferenceCode, long objectDefinitionId)
    • fetchObjectValidationRuleByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectValidationRule fetchObjectValidationRuleByUuidAndCompanyId(String uuid, long companyId)
      Returns the object validation rule with the matching UUID and company.
      Parameters:
      uuid - the object validation rule's UUID
      companyId - the primary key of the company
      Returns:
      the matching object validation rule, or null if a matching object validation rule could not be found
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getObjectValidationRule

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectValidationRule getObjectValidationRule(long objectValidationRuleId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object validation rule with the primary key.
      Parameters:
      objectValidationRuleId - the primary key of the object validation rule
      Returns:
      the object validation rule
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object validation rule with the primary key could not be found
    • getObjectValidationRuleByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectValidationRule getObjectValidationRuleByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object validation rule with the matching UUID and company.
      Parameters:
      uuid - the object validation rule's UUID
      companyId - the primary key of the company
      Returns:
      the matching object validation rule
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching object validation rule could not be found
    • getObjectValidationRules

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectValidationRule> getObjectValidationRules(boolean active, String engine)
    • getObjectValidationRules

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectValidationRule> getObjectValidationRules(int start, int end)
      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.

      Parameters:
      start - the lower bound of the range of object validation rules
      end - the upper bound of the range of object validation rules (not inclusive)
      Returns:
      the range of object validation rules
    • getObjectValidationRules

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectValidationRule> getObjectValidationRules(long objectDefinitionId)
    • getObjectValidationRules

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectValidationRule> getObjectValidationRules(long objectDefinitionId, boolean active)
    • getObjectValidationRules

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectValidationRule> getObjectValidationRules(long objectDefinitionId, String engine)
    • getObjectValidationRulesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectValidationRulesCount()
      Returns the number of object validation rules.
      Returns:
      the number of object validation rules
    • getObjectValidationRulesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectValidationRulesCount(long objectDefinitionId, boolean active)
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unassociateObjectField

      void unassociateObjectField(ObjectField objectField)
    • updateObjectValidationRule

      @Indexable(type=REINDEX) ObjectValidationRule updateObjectValidationRule(ObjectValidationRule objectValidationRule)
      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.

      Parameters:
      objectValidationRule - the object validation rule
      Returns:
      the object validation rule that was updated
    • updateObjectValidationRule

      @Indexable(type=REINDEX) ObjectValidationRule updateObjectValidationRule(String externalReferenceCode, long objectValidationRuleId, boolean active, String engine, Map<Locale,String> errorLabelMap, Map<Locale,String> nameMap, String outputType, String script, List<ObjectValidationRuleSetting> objectValidationRuleSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validate

      @Transactional(readOnly=true) void validate(com.liferay.portal.kernel.model.BaseModel<?> baseModel, long objectDefinitionId, com.liferay.portal.kernel.json.JSONObject payloadJSONObject, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException