simple-methods.dtd

国外的一套开源CRM

<!ELEMENT iterate-map ( (%SimpleMethodOperations;)* )>
<!ATTLIST iterate-map
    key-name CDATA #REQUIRED
    value-name CDATA #REQUIRED
    map-name CDATA #REQUIRED
>

<!ELEMENT first-from-list EMPTY>
<!ATTLIST first-from-list
    entry-name CDATA #REQUIRED
    list-name CDATA #REQUIRED
>

<!--
These operations are used to interact with a data source through the entity
engine and facilitate related operations.
-->

<!ELEMENT transaction-begin EMPTY>
<!ATTLIST transaction-begin
    began-transaction-name CDATA "beganTransaction"
>
<!ELEMENT transaction-commit EMPTY>
<!ATTLIST transaction-commit
    began-transaction-name CDATA "beganTransaction"
>
<!ELEMENT transaction-rollback EMPTY>
<!ATTLIST transaction-rollback
    began-transaction-name CDATA "beganTransaction"
>

<!ELEMENT now-timestamp-to-env EMPTY>
<!ATTLIST now-timestamp-to-env
    env-name CDATA #REQUIRED
>
<!ELEMENT now-date-to-env EMPTY>
<!ATTLIST now-date-to-env
    env-name CDATA #REQUIRED
>
<!ELEMENT sequenced-id-to-env EMPTY>
<!ATTLIST sequenced-id-to-env
    sequence-name CDATA #REQUIRED
    env-name CDATA #REQUIRED
    to-string ( true | false ) "false"
    stagger-max CDATA #IMPLIED
>
<!ELEMENT make-next-seq-id EMPTY>
<!ATTLIST make-next-seq-id
    value-name CDATA #REQUIRED
    seq-field-name CDATA #REQUIRED
    numeric-padding CDATA "5"
    increment-by CDATA "1"
>
<!ELEMENT set-current-user-login EMPTY>
<!ATTLIST set-current-user-login
    value-name CDATA #REQUIRED
>

<!ELEMENT find-by-primary-key EMPTY>
<!ATTLIST find-by-primary-key
    entity-name CDATA #IMPLIED
    map-name CDATA #REQUIRED
    value-name CDATA #REQUIRED
    use-cache ( true | false ) "false"
    delegator-name CDATA #IMPLIED
>
<!ELEMENT find-by-and EMPTY>
<!ATTLIST find-by-and
    list-name CDATA #REQUIRED
    entity-name CDATA #REQUIRED
    map-name CDATA #REQUIRED
    order-by-list-name CDATA #IMPLIED
    delegator-name CDATA #IMPLIED
    use-cache ( true | false ) "false"
    use-iterator ( true | false ) "false"
>
<!ELEMENT get-related-one EMPTY>
<!ATTLIST get-related-one
    value-name CDATA #REQUIRED
    relation-name CDATA #REQUIRED
    use-cache ( true | false ) "false"
    to-value-name CDATA #REQUIRED
>
<!ELEMENT get-related EMPTY>
<!ATTLIST get-related
    value-name CDATA #REQUIRED
    relation-name CDATA #REQUIRED
    map-name CDATA #IMPLIED
    order-by-list-name CDATA #IMPLIED
    use-cache ( true | false ) "false"
    list-name CDATA #REQUIRED
>
<!ELEMENT order-value-list EMPTY>
<!ATTLIST order-value-list
    list-name CDATA #REQUIRED
    to-list-name CDATA #IMPLIED
    order-by-list-name CDATA #REQUIRED
>
<!ELEMENT filter-list-by-and EMPTY>
<!ATTLIST filter-list-by-and
    list-name CDATA #REQUIRED
    to-list-name CDATA #IMPLIED
    map-name CDATA #IMPLIED
>
<!ELEMENT filter-list-by-date EMPTY>
<!ATTLIST filter-list-by-date
    list-name CDATA #REQUIRED
    to-list-name CDATA #IMPLIED
    valid-date-name CDATA #IMPLIED
    from-field-name CDATA "fromDate"
    thru-field-name CDATA "thruDate"
    all-same ( true | false ) "true"
>

<!ELEMENT make-value EMPTY>
<!ATTLIST make-value
    value-name CDATA #REQUIRED
    entity-name CDATA #REQUIRED
    map-name CDATA #IMPLIED
>
<!ELEMENT clone-value EMPTY>
<!ATTLIST clone-value
    value-name CDATA #REQUIRED
    new-value-name CDATA #REQUIRED
>

<!ELEMENT create-value EMPTY>
<!ATTLIST create-value
    value-name CDATA #REQUIRED
    do-cache-clear ( true | false ) "true"
>
<!ELEMENT store-value EMPTY>
<!ATTLIST store-value
    value-name CDATA #REQUIRED
    do-cache-clear ( true | false ) "true"
>
<!ELEMENT refresh-value EMPTY>
<!ATTLIST refresh-value
    value-name CDATA #REQUIRED
    do-cache-clear ( true | false ) "true"
>
<!ELEMENT remove-value EMPTY>
<!ATTLIST remove-value
    value-name CDATA #REQUIRED
    do-cache-clear ( true | false ) "true"
>
<!ELEMENT remove-related EMPTY>
<!ATTLIST remove-related
    value-name CDATA #REQUIRED
    relation-name CDATA #REQUIRED
    do-cache-clear ( true | false ) "true"
>
<!ELEMENT remove-by-and EMPTY>
<!ATTLIST remove-by-and
    entity-name CDATA #REQUIRED
    map-name CDATA #REQUIRED
    do-cache-clear ( true | false ) "true"
>
<!ELEMENT clear-cache-line EMPTY>
<!ATTLIST clear-cache-line
    entity-name CDATA #REQUIRED
    map-name CDATA #IMPLIED
>
<!ELEMENT clear-entity-caches EMPTY>

<!ELEMENT set-pk-fields EMPTY>
<!ATTLIST set-pk-fields
    value-name CDATA #REQUIRED
    map-name CDATA #IMPLIED
    set-if-null ( true | false ) "true"
>
<!ELEMENT set-nonpk-fields EMPTY>
<!ATTLIST set-nonpk-fields
    value-name CDATA #REQUIRED
    map-name CDATA #IMPLIED
    set-if-null ( true | false ) "true"
>

<!ELEMENT store-list EMPTY>
<!ATTLIST store-list
    list-name CDATA #REQUIRED
    do-cache-clear ( true | false ) "true"
>
<!ELEMENT remove-list EMPTY>
<!ATTLIST remove-list
    list-name CDATA #REQUIRED
    do-cache-clear ( true | false ) "true"
>


<!--
Operations that conditionally execute blocks within them; they mimic the
simple-map-processor process operations that validate incoming data
-->

<!-- note that while the definitions for the if-* operations are used, the tags should be empty because of the differing semantics -->
<!ENTITY % IfConditions "or | xor | and | not | if-validate-method | if-compare | if-compare-field | if-empty | if-regexp | if-has-permission">

<!ELEMENT if ( condition, then, else-if*, else? )>
<!ELEMENT condition ( %IfConditions; )>
<!ELEMENT then ( (%SimpleMethodOperations;)* )>
<!ELEMENT else-if ( condition, then )>
<!ELEMENT else ( (%SimpleMethodOperations;)* )>

<!ELEMENT or ( (%IfConditions;)+ )>
<!ELEMENT xor ( (%IfConditions;)+ )>
<!ELEMENT and ( (%IfConditions;)+ )>
<!ELEMENT not ( %IfConditions; )>


<!-- if-validate-method calls a static Java method that takes a String and returns a boolean -->
<!ELEMENT if-validate-method ( (%SimpleMethodOperations;)*, else? )>
<!ATTLIST if-validate-method
    map-name CDATA #IMPLIED
    field-name CDATA #REQUIRED
    method CDATA #REQUIRED
    class CDATA "org.ofbiz.base.util.UtilValidate"
>

<!ELEMENT if-compare ( (%SimpleMethodOperations;)*, else? )>
<!ATTLIST if-compare
    map-name CDATA #IMPLIED
    field-name CDATA #REQUIRED
    operator ( less | greater | less-equals | greater-equals | equals | not-equals | contains ) #REQUIRED
    value CDATA #REQUIRED
    type ( PlainString | String | Double | Float | Long | Integer | Date | Time | Timestamp | Boolean | Object ) "String"
    format CDATA #IMPLIED
>

<!ELEMENT if-compare-field ( (%SimpleMethodOperations;)*, else? )>
<!ATTLIST if-compare-field
    map-name CDATA #IMPLIED
    field-name CDATA #REQUIRED
    operator ( less | greater | less-equals | greater-equals | equals | not-equals | contains ) #REQUIRED
    to-map-name CDATA #IMPLIED
    to-field-name CDATA #IMPLIED
    type ( PlainString | String | Double | Float | Long | Integer | Date | Time | Timestamp | Boolean | Object ) "String"
    format CDATA #IMPLIED
>

<!ELEMENT if-regexp ( (%SimpleMethodOperations;)*, else? )>
<!ATTLIST if-regexp
    map-name CDATA #IMPLIED
    field-name CDATA #REQUIRED
    expr CDATA #REQUIRED
>

<!ELEMENT if-empty ( (%SimpleMethodOperations;)*, else? )>
<!ATTLIST if-empty
    map-name CDATA #IMPLIED
    field-name CDATA #REQUIRED
>
<!ELEMENT if-not-empty ( (%SimpleMethodOperations;)*, else? )>
<!ATTLIST if-not-empty
    map-name CDATA #IMPLIED
    field-name CDATA #REQUIRED
>

<!ELEMENT if-has-permission ( (%SimpleMethodOperations;)*, else? )>
<!ATTLIST if-has-permission
    permission CDATA #REQUIRED
    action CDATA #IMPLIED
>

<!ELEMENT check-permission ( alt-permission*, (fail-message | fail-property) )>
<!ATTLIST check-permission
    permission CDATA #REQUIRED
    action CDATA #IMPLIED
    error-list-name CDATA "error_list"
>
	<!ELEMENT alt-permission EMPTY>
    <!ATTLIST alt-permission
	    permission CDATA #REQUIRED
	    action CDATA #IMPLIED
    >

<!ELEMENT check-id ( fail-message | fail-property )?>
<!ATTLIST check-id
    field-name CDATA #REQUIRED
    map-name CDATA #IMPLIED
    error-list-name CDATA "error_list"
>

<!-- the "Other" Operations -->

<!ELEMENT property-to-field EMPTY>
<!ATTLIST property-to-field
    resource CDATA #REQUIRED
    property CDATA #REQUIRED
    map-name CDATA #IMPLIED
    field-name CDATA #REQUIRED
    default CDATA #IMPLIED
    no-locale ( true | false ) "false"
    arg-list-name CDATA #IMPLIED
>

<!ELEMENT log ( ( field | string )* )>
<!ATTLIST log
    level ( verbose | timing | info | important | warning | error | fatal | always ) #REQUIRED
    message CDATA #IMPLIED
>

<!ELEMENT calculate ( ( calcop | number )* )>
<!ATTLIST calculate
    map-name CDATA #IMPLIED
    field-name CDATA #REQUIRED
    type ( String | Double | Float | Long | Integer ) "Double"
>
    <!ELEMENT calcop ( ( calcop | number )* )>
    <!ATTLIST calcop
        operator ( get | add | subtract | multiply | divide | negative ) #REQUIRED
        map-name CDATA #IMPLIED
        field-name CDATA #IMPLIED
    >
    <!ELEMENT number EMPTY>
    <!ATTLIST number
        value CDATA #REQUIRED
    >


<!--
    ======================================================
    ========== The Simple Map Processor Section ==========
    ======================================================
-->
<!ELEMENT simple-map-processors ( simple-map-processor+ )>

<!ELEMENT simple-map-processor ( make-in-string*, process* )>
<!ATTLIST simple-map-processor
    name CDATA #REQUIRED
>

<!--
    Make In String & Operations
-->
<!ELEMENT make-in-string ( ( in-field | property | constant )* )>
<!ATTLIST make-in-string
    field CDATA #REQUIRED
>
<!ELEMENT in-field EMPTY>
<!ATTLIST in-field
    field CDATA #REQUIRED
>
<!ELEMENT property EMPTY>
<!ATTLIST property
    resource CDATA #REQUIRED
    property CDATA #REQUIRED
>
<!ELEMENT constant (#PCDATA)>

<!--
    Field Process & Operations
-->
<!ELEMENT process ( ( validate-method | compare | compare-field | regexp | not-empty | copy | convert )* )>
<!ATTLIST process
    field CDATA #REQUIRED
>

<!-- validate-method calls a static Java method that takes a String and returns a boolean -->
<!ELEMENT validate-method ( fail-message | fail-property )>
<!ATTLIST validate-method
    method CDATA #REQUIRED
    class CDATA "org.ofbiz.base.util.UtilValidate"
>

<!ELEMENT compare ( fail-message | fail-property )>
<!ATTLIST compare
    operator ( less | greater | less-equals | greater-equals | equals | not-equals | contains ) #REQUIRED
    value CDATA #REQUIRED
    type ( PlainString | String | Double | Float | Long | Integer | Date | Time | Timestamp | Boolean | Object ) "String"
    format CDATA #IMPLIED
>

<!ELEMENT compare-field ( fail-message | fail-property )>
<!ATTLIST compare-field
    operator ( less | greater | less-equals | greater-equals | equals | not-equals | contains ) #REQUIRED
    field CDATA #REQUIRED
    type ( PlainString | String | Double | Float | Long | Integer | Date | Time | Timestamp | Boolean | Object ) "String"
    format CDATA #IMPLIED
>

<!ELEMENT regexp ( fail-message | fail-property )>
<!ATTLIST regexp
    expr CDATA #REQUIRED
>

<!ELEMENT not-empty ( fail-message | fail-property )>

<!-- Copy operation: if no to-field is specified, it is the same as the field on process -->
<!ELEMENT copy EMPTY>
<!ATTLIST copy
    to-field CDATA #IMPLIED
    replace ( true | false ) "true"
    set-if-null ( true | false ) "true"
>

<!-- Convert operation: if no to-field is specified, it is the same as the field on process -->
<!ELEMENT convert ( fail-message | fail-property )>
<!ATTLIST convert
    to-field CDATA #IMPLIED
    type ( PlainString | String | Double | Float | Long | Integer | Date | Time | Timestamp | Boolean) #REQUIRED
    replace ( true | false ) "true"
    set-if-null ( true | false ) "true"
    format CDATA #IMPLIED
>

<!--
    Failure stuff: inline message or from a properties file
-->
<!ELEMENT fail-message EMPTY>
<!ATTLIST fail-message
    message CDATA #REQUIRED
>

<!ELEMENT fail-property EMPTY>
<!ATTLIST fail-property
    resource CDATA #REQUIRED
    property CDATA #REQUIRED
>