Files
ofbiz-framework/framework/entity/dtd/entity-eca.xsd
T
Deepak Dixit aae3cebccc Improved: Add ability to disable entity eca rule (OFBIZ-9897)
We have enabled flag in EntityEcaRule class, if its set false then entity eca rule will not be execute.
But there is not way to disable entity eca.

We can add enabled flag in Entity ECA definition to disable the existing entity eca rule.

    Add new attribute on entity eca tag named enabled
    Default value will be true for this.
    If user want to disable existing OOTB entity eca rule, then user can define same rule in custom component and set the enabled=false

Also as per current flow if same seca rule is define more then once, system will execute all the rule, ideally it should not execute same rule (same rule, condition and action) if its defined more than one.

Also need to ovride hasCode, equals and toString method for EntityEcaRule, EntityEcaAction and EntityEcaCondition class file.


git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1814160 13f79535-47bb-0310-9956-ffa450edef68
2017-11-03 10:28:05 +00:00

257 lines
11 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xs:element name="entity-eca">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="eca"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="eca">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="condition"/>
<xs:element ref="condition-field"/>
</xs:choice>
<xs:choice minOccurs="1" maxOccurs="unbounded">
<xs:element ref="set"/>
<xs:element ref="action"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="attlist.eca"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.eca">
<xs:attribute type="xs:string" name="entity" use="required"/>
<xs:attribute name="operation" use="required">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="create"/>
<xs:enumeration value="store"/>
<xs:enumeration value="remove"/>
<xs:enumeration value="find"/>
<xs:enumeration value="create-store"/>
<xs:enumeration value="create-remove"/>
<xs:enumeration value="store-remove"/>
<xs:enumeration value="create-store-remove"/>
<xs:enumeration value="any"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="event" use="required">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="validate"/>
<xs:enumeration value="run"/>
<xs:enumeration value="return"/>
<xs:enumeration value="cache-check"/>
<xs:enumeration value="cache-put"/>
<xs:enumeration value="cache-clear"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="run-on-error" default="false">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="enabled" default="true">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="condition">
<xs:complexType>
<xs:attributeGroup ref="attlist.condition"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.condition">
<xs:attribute type="xs:string" name="field-name" use="required"/>
<xs:attribute name="operator" use="required">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="less"/>
<xs:enumeration value="greater"/>
<xs:enumeration value="less-equals"/>
<xs:enumeration value="greater-equals"/>
<xs:enumeration value="equals"/>
<xs:enumeration value="not-equals"/>
<xs:enumeration value="is-empty"/>
<xs:enumeration value="is-not-empty"/>
<xs:enumeration value="contains"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute type="xs:string" name="value"/>
<xs:attribute name="type" default="String">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="PlainString"/>
<xs:enumeration value="String"/>
<xs:enumeration value="BigDecimal"/>
<xs:enumeration value="Double"/>
<xs:enumeration value="Float"/>
<xs:enumeration value="Long"/>
<xs:enumeration value="Integer"/>
<xs:enumeration value="Date"/>
<xs:enumeration value="Time"/>
<xs:enumeration value="Timestamp"/>
<xs:enumeration value="Boolean"/>
<xs:enumeration value="Object"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute type="xs:string" name="format"/>
</xs:attributeGroup>
<xs:element name="condition-field">
<xs:complexType>
<xs:attributeGroup ref="attlist.condition-field"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.condition-field">
<xs:attribute type="xs:string" name="field-name" use="required"/>
<xs:attribute name="operator" use="required">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="less"/>
<xs:enumeration value="greater"/>
<xs:enumeration value="less-equals"/>
<xs:enumeration value="greater-equals"/>
<xs:enumeration value="equals"/>
<xs:enumeration value="not-equals"/>
<xs:enumeration value="contains"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute type="xs:string" name="to-field-name"/>
<xs:attribute name="type" default="String">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="PlainString"/>
<xs:enumeration value="String"/>
<xs:enumeration value="BigDecimal"/>
<xs:enumeration value="Double"/>
<xs:enumeration value="Float"/>
<xs:enumeration value="Long"/>
<xs:enumeration value="Integer"/>
<xs:enumeration value="Date"/>
<xs:enumeration value="Time"/>
<xs:enumeration value="Timestamp"/>
<xs:enumeration value="Boolean"/>
<xs:enumeration value="Object"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute type="xs:string" name="format"/>
</xs:attributeGroup>
<xs:element name="set">
<xs:complexType>
<xs:attributeGroup ref="attlist.set"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.set">
<xs:attribute type="xs:string" name="field-name" use="required"/>
<xs:attribute type="xs:string" name="env-name"/>
<xs:attribute type="xs:string" name="value"/>
<xs:attribute name="format">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="append"/>
<xs:enumeration value="to-upper"/>
<xs:enumeration value="to-lower"/>
<xs:enumeration value="hash-code"/>
<xs:enumeration value="long"/>
<xs:enumeration value="double"/>
<xs:enumeration value="upper-first-char"/>
<xs:enumeration value="lower-first-char"/>
<xs:enumeration value="db-to-java"/>
<xs:enumeration value="java-to-db"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="action">
<xs:complexType>
<xs:attributeGroup ref="attlist.action"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.action">
<xs:attribute type="xs:string" name="service" use="required"/>
<xs:attribute name="mode" use="required">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="sync"/>
<xs:enumeration value="async"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="result-to-value" default="true">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="abort-on-error" default="false">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="rollback-on-error" default="false">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="persist" default="false">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute type="xs:string" name="run-as-user" default="system"/>
<xs:attribute type="xs:string" name="value-attr">
<xs:annotation>
<xs:documentation>
if value-attr is specified the generic value object corresponding to the entity in question will be passed
to the action service
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
</xs:schema>