Class ObjectValidationRuleLocalServiceUtil
com.liferay.object.service.impl.ObjectValidationRuleLocalServiceImpl and
is an access point for service operations in application layer code running
on the local server. 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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ObjectValidationRuleaddObjectValidationRule(ObjectValidationRule objectValidationRule) Adds the object validation rule to the database.static ObjectValidationRuleaddObjectValidationRule(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) static ObjectValidationRulecreateObjectValidationRule(long objectValidationRuleId) Creates a new object validation rule with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static ObjectValidationRuledeleteObjectValidationRule(long objectValidationRuleId) Deletes the object validation rule with the primary key from the database.static ObjectValidationRuledeleteObjectValidationRule(ObjectValidationRule objectValidationRule) Deletes the object validation rule from the database.static voiddeleteObjectValidationRules(Long objectDefinitionId) static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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.static ObjectValidationRulefetchObjectValidationRule(long objectValidationRuleId) static ObjectValidationRulefetchObjectValidationRule(String externalReferenceCode, long objectDefinitionId) static ObjectValidationRulefetchObjectValidationRuleByUuidAndCompanyId(String uuid, long companyId) Returns the object validation rule with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic ObjectValidationRulegetObjectValidationRule(long objectValidationRuleId) Returns the object validation rule with the primary key.static ObjectValidationRulegetObjectValidationRuleByUuidAndCompanyId(String uuid, long companyId) Returns the object validation rule with the matching UUID and company.static List<ObjectValidationRule>getObjectValidationRules(boolean active, String engine) static List<ObjectValidationRule>getObjectValidationRules(int start, int end) Returns a range of all the object validation rules.static List<ObjectValidationRule>getObjectValidationRules(long objectDefinitionId) static List<ObjectValidationRule>getObjectValidationRules(long objectDefinitionId, boolean active) static List<ObjectValidationRule>getObjectValidationRules(long objectDefinitionId, String engine) static intReturns the number of object validation rules.static intgetObjectValidationRulesCount(long objectDefinitionId, boolean active) static StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static voidunassociateObjectField(ObjectField objectField) static ObjectValidationRuleupdateObjectValidationRule(ObjectValidationRule objectValidationRule) Updates the object validation rule in the database or adds it if it does not yet exist.static ObjectValidationRuleupdateObjectValidationRule(String externalReferenceCode, long objectValidationRuleId, boolean active, String engine, Map<Locale, String> errorLabelMap, Map<Locale, String> nameMap, String outputType, String script, List<ObjectValidationRuleSetting> objectValidationRuleSettings) static voidvalidate(com.liferay.portal.kernel.model.BaseModel<?> baseModel, long objectDefinitionId, com.liferay.portal.kernel.json.JSONObject payloadJSONObject, long userId)
-
Constructor Details
-
ObjectValidationRuleLocalServiceUtil
public ObjectValidationRuleLocalServiceUtil()
-
-
Method Details
-
addObjectValidationRule
public static 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
public static ObjectValidationRule addObjectValidationRule(String externalReferenceCode, long userId, long objectDefinitionId, boolean active, String engine, Map<Locale, String> errorLabelMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> nameMap, String outputType, String script, boolean system, List<ObjectValidationRuleSetting> objectValidationRuleSettings) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createObjectValidationRule
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
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteObjectValidationRule
public static 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
public static 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
public static void deleteObjectValidationRules(Long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public static <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.object.model.impl.ObjectValidationRuleModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.object.model.impl.ObjectValidationRuleModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public static 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
public static 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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchObjectValidationRule
-
fetchObjectValidationRule
public static ObjectValidationRule fetchObjectValidationRule(String externalReferenceCode, long objectDefinitionId) -
fetchObjectValidationRuleByUuidAndCompanyId
public static ObjectValidationRule fetchObjectValidationRuleByUuidAndCompanyId(String uuid, long companyId) Returns the object validation rule with the matching UUID and company.- Parameters:
uuid- the object validation rule's UUIDcompanyId- the primary key of the company- Returns:
- the matching object validation rule, or
nullif a matching object validation rule could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getObjectValidationRule
public static 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
public static 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 UUIDcompanyId- 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
-
getObjectValidationRules
Returns a range of all the object validation rules.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.object.model.impl.ObjectValidationRuleModelImpl.- Parameters:
start- the lower bound of the range of object validation rulesend- the upper bound of the range of object validation rules (not inclusive)- Returns:
- the range of object validation rules
-
getObjectValidationRules
-
getObjectValidationRules
public static List<ObjectValidationRule> getObjectValidationRules(long objectDefinitionId, boolean active) -
getObjectValidationRules
public static List<ObjectValidationRule> getObjectValidationRules(long objectDefinitionId, String engine) -
getObjectValidationRulesCount
public static int getObjectValidationRulesCount()Returns the number of object validation rules.- Returns:
- the number of object validation rules
-
getObjectValidationRulesCount
public static int getObjectValidationRulesCount(long objectDefinitionId, boolean active) -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unassociateObjectField
-
updateObjectValidationRule
public static 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
public static ObjectValidationRule updateObjectValidationRule(String externalReferenceCode, long objectValidationRuleId, boolean active, String engine, Map<Locale, String> errorLabelMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> nameMap, String outputType, String script, List<ObjectValidationRuleSetting> objectValidationRuleSettings) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
validate
public static 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
-
getService
-