blob: a098632b79398e7b923418238b0065295332b7ab [file] [log] [blame]
<?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">
<!--
==================================================
========== The Simple Methods Section ==========
==================================================
(see further down for the Simple Map Processor Section)
-->
<!-- Reusable artifacts (abstract elements, groups, attributeGroups -->
<xs:element name="CallOperations" abstract="true"/>
<xs:element name="EventOperations" abstract="true"/>
<xs:element name="ServiceOperations" abstract="true"/>
<xs:element name="EnvOperations" abstract="true"/>
<xs:element name="EntityMiscOperations" abstract="true"/>
<xs:element name="EntityFindOperations" abstract="true"/>
<xs:element name="EntityValueOperations" abstract="true"/>
<xs:element name="EntityListOperations" abstract="true"/>
<xs:element name="EntityTxOperations" abstract="true"/>
<xs:element name="ControlOperations" abstract="true"/>
<xs:element name="IfBasicOperations" abstract="true"/>
<xs:element name="IfOtherOperations" abstract="true"/>
<xs:element name="OtherOperations" abstract="true"/>
<xs:group name="AllOperations"> <!-- Any simple-method operation can be nested under an if-* tag. -->
<xs:choice>
<xs:element ref="CallOperations"/>
<xs:element ref="EventOperations"/>
<xs:element ref="ServiceOperations"/>
<xs:element ref="EnvOperations"/>
<xs:element ref="EntityMiscOperations"/>
<xs:element ref="EntityFindOperations"/>
<xs:element ref="EntityValueOperations"/>
<xs:element ref="EntityListOperations"/>
<xs:element ref="EntityTxOperations"/>
<xs:element ref="ControlOperations"/>
<xs:element ref="IfBasicOperations"/>
<xs:element ref="IfOtherOperations"/>
<xs:element ref="OtherOperations"/>
</xs:choice>
</xs:group>
<xs:attributeGroup name="attlist.propertyInfoOptional">
<xs:attribute type="xs:string" name="resource"/>
<xs:attribute type="xs:string" name="property"/>
</xs:attributeGroup>
<xs:attributeGroup name="attlist.typeDefaultString">
<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:attributeGroup>
<xs:attributeGroup name="attlist.operatorRequired">
<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:attributeGroup>
<!-- ELEMENTS start here -->
<xs:element name="field">
<xs:annotation>
<xs:documentation>
Used to specify a field to be passed as an argument to the method call.
The field can be in a map in the environment or if no map-name is specified
then the field will come directly from the environment.
With the "." Syntax, the map-name is typically no longer necessary because
you can do map-name.field-name in the field-name attribute, but those are still there for legacy purposes.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.field"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.field">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation><xs:documentation>Name of the field to put value in.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="type">
<xs:annotation>
<xs:documentation>
Type of the value put in the field.
If this is a method call or object creation and the type in the method signature being called is for a parent class or interface,
then it should be the type in that parent class or interface and not the type of the object being passed in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="string">
<xs:annotation>
<xs:documentation>
String of type java.lang.String. Inserts the value of the inline string where specified.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.string"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.string">
<xs:attribute type="xs:string" name="value"/>
</xs:attributeGroup>
<xs:element name="simple-methods">
<xs:annotation>
<xs:documentation>
Opening tag of simple-method files.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="simple-method">
<xs:annotation>
<xs:documentation>
Opening tag of a simple-method definition.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="simple-method">
<xs:annotation>
<xs:documentation>
A simple method can be called in either an event context from the Control
Servlet (or another event) or in a service context through the Service
Engine, or any other component that has access to a service dispatcher.
The field-to-request and field-to-session elements will be IGNORED when
called in a service context. So, they are ONLY used when called in an event context.
The field-to-result elements will be ignored in an event context, ie only used in a service.
The parameter-map-name env entry will contain the HttpRequest parameters for
running in an event context and and the input context when running in a service.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:group minOccurs="0" maxOccurs="unbounded" ref="AllOperations"/>
<xs:attributeGroup ref="attlist.simple-method"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.simple-method">
<xs:attribute type="xs:string" name="method-name" use="required">
<xs:annotation>
<xs:documentation>
A name (preferably a legal Java identifier) for this method.
This name must be unique for the XML file it is in as it will be used to reference this method externally.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="short-description" use="required">
<xs:annotation>
<xs:documentation>
A short description of the method for certain system error messages.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="login-required" default="true">
<xs:annotation>
<xs:documentation>
Is a logged in user (UserLogin object, or login.username and login.password Strings) required to run this method?
"true" or "false" (defaults to "true")
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="use-transaction" default="true">
<xs:annotation>
<xs:documentation>
Create a transaction if none exists for this thread?
"true" or "false" (defaults to "true")
</xs:documentation>
</xs:annotation>
<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="default-error-code" default="error">
<xs:annotation>
<xs:documentation>
The default error return code. (defaults to "error")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="default-success-code" default="success">
<xs:annotation>
<xs:documentation>
The default success return code. (defaults to "success")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="parameter-map-name" default="parameters">
<xs:annotation>
<xs:documentation>
As event: copy of request parameters.
As service: incoming context.
(defaults to "parameters")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="event-request-object-name" default="request">
<xs:annotation>
<xs:documentation>
As event only (defaults to "request")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="event-response-object-name" default="response">
<xs:annotation>
<xs:documentation>
As event only (defaults to "response")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="event-response-code-name" default="_response_code_">
<xs:annotation>
<xs:documentation>
As event only (defaults to "_response_code")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="event-error-message-name" default="_error_message_">
<xs:annotation>
<xs:documentation>
As event only (defaults to "_error_message_")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="event-event-message-name" default="_event_message_">
<xs:annotation>
<xs:documentation>
As event only (defaults to "_event_message_")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="service-response-message-name" default="responseMessage">
<xs:annotation>
<xs:documentation>
As service only (defaults to "responseMessage")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="service-error-message-name" default="errorMessage">
<xs:annotation>
<xs:documentation>
As service only (defaults to "errorMessage")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="service-error-message-list-name" default="errorMessageList">
<xs:annotation>
<xs:documentation>
As service only (defaults to "errorMessageList")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="service-error-message-map-name" default="errorMessageMap">
<xs:annotation>
<xs:documentation>
As service only (defaults to "errorMessageMap")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="service-success-message-name" default="successMessage">
<xs:annotation>
<xs:documentation>
As service only (defaults to "successMessage")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="service-success-message-list-name" default="successMessageList">
<xs:annotation>
<xs:documentation>
As service only (defaults to "successMessageList")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="locale-name" default="locale">
<xs:annotation>
<xs:documentation>
Name of locale variable (defaults to "locale")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="delegator-name" default="delegator">
<xs:annotation>
<xs:documentation>
A GenericDelegator object to use in the method (defaults to "delegator")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="security-name" default="security">
<xs:annotation>
<xs:documentation>
A Security object to use in the method (defaults to "security")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="dispatcher-name" default="dispatcher">
<xs:annotation>
<xs:documentation>
A LocalDispatcher object to use in the method (defaults to "dispatcher")
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="user-login-name" default="userLogin">
<xs:annotation>
<xs:documentation>
Name of user login variable (defaults to "userLogin")
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="call-map-processor" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
The call-map-processor tag invokes a simple map processor from an existing map, creating a new map or adding to an existing one
if the named out-map already exists. Resulting messages are added to the named list, and a new list is created if a list with
the given name does not yet exist. Note that all lists and maps exist in the same context and must have unique names.
An inline simple-map-processor can be used by putting a simple-map-processor tag under the call-map-processor tag.
If both an external and an inline map-processor are specified, the external
one will be called first, allowing the inline one to override its behavior.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" ref="simple-map-processor">
<xs:annotation>
<xs:documentation>
Uses the same definition as the simple-map-processor in the context of a simple-map-processors XML file.
Allows for an inlined simple-map-processor.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attributeGroup ref="attlist.call-map-processor"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.call-map-processor">
<xs:attribute type="xs:string" name="xml-resource">
<xs:annotation>
<xs:documentation>
The full path and filename on the classpath of the XML file which contains an external map processor to execute.
This is only required if an external map processor is desired.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="processor-name">
<xs:annotation>
<xs:documentation>
The name of the external map processor to execute in the specified xml-resource.
This is only required if an external map processor is desired.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="in-map-name" use="required">
<xs:annotation>
<xs:documentation>
The name of a map in the method environment to use as the input map.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="out-map-name" use="required">
<xs:annotation>
<xs:documentation>
The name of a map in the method environment to use as the output map.
Will be created if it does not exist already.
If already exists will be added to in place.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="error-list-name" default="error_list">
<xs:annotation>
<xs:documentation>
The name of a list in the method environment that the error messages will be added to.
Will be created if it does not exist.
Defaults to "error_list".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="set-service-fields" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
Take all the incoming files for this service, or all the incoming service attributes,
and look for fields with the same name in the incoming map and copy those onto the outgoing map.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.set-service-fields"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.set-service-fields">
<xs:attribute type="xs:string" name="service-name" use="required">
<xs:annotation><xs:documentation>Name of the service to get all the incoming attributes (parameters) from.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="map" use="required">
<xs:annotation><xs:documentation>Incoming map to copy fields from.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="to-map" use="required">
<xs:annotation><xs:documentation>Map to copy to fields to.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="error-list-name" default="error_list">
<xs:annotation>
<xs:documentation>
The name of a list in the method environment that the error messages will be added to.
Will be created if it does not exist.
Defaults to "error_list".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="call-service" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
The call-service tag invokes a service through the Service Engine.
If the specified error code is returned from the service,
the event is aborted and the transaction in the current thread is rolled back.
Otherwise, the remaining operations are invoked.
The result-to-request and result-to-session elements will be IGNORED when
called in a service context. So, they are ONLY used when called in an event context.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" ref="error-prefix"/>
<xs:element minOccurs="0" ref="error-suffix"/>
<xs:element minOccurs="0" ref="success-prefix"/>
<xs:element minOccurs="0" ref="success-suffix"/>
<xs:element minOccurs="0" ref="message-prefix"/>
<xs:element minOccurs="0" ref="message-suffix"/>
<xs:element minOccurs="0" ref="default-message"/>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="results-to-map"/>
<xs:element ref="result-to-field"/>
<xs:element ref="result-to-request"/>
<xs:element ref="result-to-session"/>
<xs:element ref="result-to-result"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="attlist.call-service"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.call-service">
<xs:attribute type="xs:string" name="service-name" use="required">
<xs:annotation>
<xs:documentation>
Name of the service to call.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="in-map-name">
<xs:annotation>
<xs:documentation>
Optional name of a map in the method environment to use as the input map.
If you're not going to pass any parameters to the service than you can just
leave off the in-map name, although typically in a service tag you will see
a service-name and the in-mapname passed in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="include-user-login" default="true">
<xs:annotation>
<xs:documentation>
Include-user-login by default will include the user login
so if there is a user login for the current simple-method
it will pass that in to the service. If you don't want it to
pass that in you can just set this to false.
Defaults to "true".
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:annotation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="break-on-error" default="true">
<xs:annotation>
<xs:documentation>
If there's an error in the service by default
it will stop the current simple-method and return an
error message that came from the service it called. If
you don't want it to when there's an error you can just
set that to false.
Defaults to "true".
</xs:documentation>
</xs:annotation>
<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="error-code" default="error">
<xs:annotation>
<xs:documentation>
Defaults to "error".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="success-code" default="success">
<xs:annotation>
<xs:documentation>
Defaults to "success".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="require-new-transaction" default="false">
<xs:annotation>
<xs:documentation>
Defines if the simple-method requires a new transaction or not.
Defaults to "false".
</xs:documentation>
</xs:annotation>
<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="transaction-timeout">
<xs:annotation>
<xs:documentation>
Defines the timeout for the transaction, in seconds.
Defaults to the value set in the service definition which in turn defaults to the setting
in the TransactionFactory being used (typically 60 seconds).
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="error-prefix">
<xs:annotation>
<xs:documentation>
Specify a resource and a property to prepend to the error message.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.propertyInfoOptional"/>
</xs:complexType>
</xs:element>
<xs:element name="error-suffix">
<xs:annotation>
<xs:documentation>
Specify a resource and a property to append to the error message.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.propertyInfoOptional"/>
</xs:complexType>
</xs:element>
<xs:element name="success-prefix">
<xs:annotation>
<xs:documentation>
Specify a resource and a property to prepend to the success message.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.propertyInfoOptional"/>
</xs:complexType>
</xs:element>
<xs:element name="success-suffix">
<xs:annotation>
<xs:documentation>
Specify a resource and a property to append to the success message.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.propertyInfoOptional"/>
</xs:complexType>
</xs:element>
<xs:element name="message-prefix">
<xs:annotation>
<xs:documentation>
Specify a resource and a property to prepend to any kind of message.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.propertyInfoOptional"/>
</xs:complexType>
</xs:element>
<xs:element name="message-suffix">
<xs:annotation>
<xs:documentation>
Specify a resource and a property to append to any kind of message.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.propertyInfoOptional"/>
</xs:complexType>
</xs:element>
<xs:element name="default-message">
<xs:annotation>
<xs:documentation>
Message that you can specify for the case where the service does not return a message.
You can just specify a default-message to use as if the service had returned that default-message.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.propertyInfoOptional"/>
</xs:complexType>
</xs:element>
<xs:element name="results-to-map">
<xs:annotation>
<xs:documentation>
results-to-map will take all of the results of the service,
the outgoing maps from the service and put them in a map of the given map-name.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.results-to-map"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.results-to-map">
<xs:attribute type="xs:string" name="map-name" use="required">
<xs:annotation>
<xs:documentation>
Name of a map where results will be put in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="result-to-field">
<xs:annotation>
<xs:documentation>
Specify the name of the field in the result and then the name of the field in the context you want to put it in,
and optionally the name in the map.
There's a field-map there. If you don't specify a field-name then the result-name will be used for the field-name,
that's the name of the variable that will be created in the current context for the value of that result.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.result-to-field"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.result-to-field">
<xs:attribute type="xs:string" name="result-name" use="required">
<xs:annotation>
<xs:documentation>
Name of the result. May be used for the field-name. If you don't specify a field-name,
this will be name of the variable that will be created in the current context for the value of that result.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="field">
<xs:annotation><xs:documentation>Optional name of target field. If empty will default to result-name.</xs:documentation></xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="result-to-request">
<xs:annotation>
<xs:documentation>
result-to-request is event specific.
It takes the result with the given name and puts it in a request attribute with the given name here.
Again the request-name is optional.
If you leave it off then it will put it in an attribute with the name of the result-name.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.result-to-request"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.result-to-request">
<xs:attribute type="xs:string" name="result-name" use="required">
<xs:annotation>
<xs:documentation>
Name of the result. May be used for the request attribute name. If you don't specify a request-name ,
that's the name of the request attribute that will be created for the value of that result.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="request-name">
<xs:annotation>
<xs:documentation>
Optionnal request name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="result-to-session">
<xs:annotation>
<xs:documentation>
Specify the name of the session attribute that you want it to put the value in.
If you don't specify one it will use the result-name.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.result-to-session"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.result-to-session">
<xs:attribute type="xs:string" name="result-name" use="required">
<xs:annotation>
<xs:documentation>
Name of the result. May be used for the session attribute name. If you don't specify a session-name,
that's the name of the session attribute that will be created for the value of that result.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="session-name">
<xs:annotation>
<xs:documentation>
Optionnal session name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="result-to-result">
<xs:annotation>
<xs:documentation>
result-to-result is service specific (when the service is being called as a service).
It will take the result of the service you're calling with the call service operation and it will put it in with the result of the current service.
So result-name is the name of the result in the service that was called using the call-service tag.
NOTE that these attributes are somewhat confusing: result-name is the name of the field in the result of this service call that the value comes FROM;
service-result-name is the name of the field in the result of this simple-method called as a service where the value goes TO;
in other words FROM result-name and TO service-result-name.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.result-to-result"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.result-to-result">
<xs:attribute type="xs:string" name="result-name" use="required">
<xs:annotation>
<xs:documentation>
Name of the field in the result of this service call that the value comes FROM.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="service-result-name">
<xs:annotation>
<xs:documentation>
Name of the field in the result of this simple-method called as a service where the value goes TO.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="call-service-asynch" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
Calls a service asynchronously and ignores the result, so no return messages
are used; that doesn't mean no errors will result, but they would just be
system errors like database failures, etc. which all have system error messages.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.call-service-asynch"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.call-service-asynch">
<xs:attribute type="xs:string" name="service-name" use="required">
<xs:annotation>
<xs:documentation>
Name of the service called asynchronously.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="in-map-name">
<xs:annotation>
<xs:documentation>
The name of a map in the method environment to use as the input map.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="include-user-login" default="true">
<xs:annotation>
<xs:documentation>
Defaults to "true".
</xs:documentation>
</xs:annotation>
<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="script" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
Runs an external script (minilang, bsh, groovy) from the expanded location provided.
Error messages go on the error list and are handled with the check-errors tag.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.script"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.script">
<xs:attribute type="xs:string" name="location">
<xs:annotation>
<xs:documentation>
Script location (component://...)
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="error-list-name" default="error_list">
<xs:annotation>
<xs:documentation>
The name of the list in the method environment to check for error messages.
Defaults to "error_list".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="call-bsh" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
Runs an external bsh script from the classpath if resource is specified and
then runs the inlined bsh script if any is specified.
The bsh context is the current simple-method environment including maps, lists
and special objects whose names are defined in the simple-method attributes.
The current env cannot be modified, but if a Map is returned by the bsh block
the entries in the map will be put into the current env.
Error messages go on the error list and are handled with the check-errors tag.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:attributeGroup ref="attlist.call-bsh"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.call-bsh">
<xs:attribute type="xs:string" name="resource">
<xs:annotation>
<xs:documentation>
Name of a properties file on the classpath.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="error-list-name" default="error_list">
<xs:annotation>
<xs:documentation>
The name of the list in the method environment to check for error messages.
Defaults to "error_list".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="call-simple-method" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
The call-simple-method tag calls another simple-method in the same context as the current one.
In other words the called simple-method will have the same environment as the calling simple-method,
including all environment fields, and either the event or service objects that the calling simple-method was called with.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.call-simple-method"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.call-simple-method">
<xs:attribute type="xs:string" name="xml-resource">
<xs:annotation>
<xs:documentation>
The full path and filename on the classpath of the XML file which contains an external simple-method to execute.
This is only required if a simple-method in a different file is desired.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="method-name" use="required">
<xs:annotation>
<xs:documentation>
The name of the simple-method to execute in the specified xml-resource,
or in the current XML file if no xml-resource is specified.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<!-- Operations to call Java methods and create Java objects -->
<xs:element name="call-object-method" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
Calls a method on an existing object that exists in a field in the environment or in a map in the environment.
The string and field sub-elements are passed to the method as arguments in the order they are specified.
If the sub-elements do not match the method arguments an error will be returned.
The return value will be put in the named field if an value is returned and
if a field and optionally a map name are specified.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="string">
<xs:annotation>
<xs:documentation>
Used to specify an inline String argument to the method call.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="field"/>
</xs:choice>
<xs:attributeGroup ref="attlist.call-object-method"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.call-object-method">
<xs:attribute type="xs:string" name="obj-field" use="required">
<xs:annotation>
<xs:documentation>
The name of the field the object is in that has the method to be called.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="method-name" use="required">
<xs:annotation>
<xs:documentation>
The name of the method to call on the given object.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="ret-field">
<xs:annotation>
<xs:documentation>
The name of the field to put the result in.
If not specified any return value will be ignored.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="call-class-method" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
Calls a static method on a class.
The string and field sub-elements are passed to the method as arguments in the order they are specified.
If the sub-elements do not match the method arguments an error will be returned.
The return value will be put in the named field if an value is returned and if a
field and optionally a map name are specified.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="string">
<xs:annotation>
<xs:documentation>
Used to specify an inline String argument to the method call.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="field">
<xs:annotation>
<xs:documentation>
Used to specify a field to be passed as an argument to the constructor method.
The field can be in a map in the environment or if no map-name is specified then
the field will come directly from the environment.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:attributeGroup ref="attlist.call-class-method"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.call-class-method">
<xs:attribute type="xs:string" name="class-name" use="required">
<xs:annotation>
<xs:documentation>
The name of the class to call the static method on.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="method-name" use="required">
<xs:annotation>
<xs:documentation>
The name of the static method to call on the given class.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="ret-field">
<xs:annotation>
<xs:documentation>
The name of the field to put the result in. If not specified any return value will be ignored.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="create-object" substitutionGroup="CallOperations">
<xs:annotation>
<xs:documentation>
Creates an object of the given class and if the field attribute is specified saves it in that field.
The string and field sub-elements are passed to the constructor method as arguments in the order they are specified.
If the sub-elements do not match the constructor method arguments an error will be returned.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="field">
<xs:annotation>
<xs:documentation>
Used to specify a field to be passed as an argument to the constructor method.
The field can be in a map in the environment or if no map-name is specified then
the field will come directly from the environment.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="string">
<xs:annotation>
<xs:documentation>
Used to specify an inline String argument to the method call.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:attributeGroup ref="attlist.create-object"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-object">
<xs:attribute type="xs:string" name="class-name" use="required">
<xs:annotation>
<xs:documentation>
The name of the class to construct an object of.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="field">
<xs:annotation>
<xs:documentation>
The name of a field to put the new object in.
If not specified the object will be created but ignored after that.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<!-- Operations to copy map fields in the current env to context specific containers -->
<!-- Event specific operations -->
<xs:element name="field-to-request" substitutionGroup="EventOperations">
<xs:annotation>
<xs:documentation>
The field-to-request tag copies a field from a map to the specified servlet request attribute.
The tag is only used when the simple-method is called as an event, it is ignored otherwise.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.field-to-request"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.field-to-request">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation><xs:documentation>The context name of the field to use.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="request-name">
<xs:annotation><xs:documentation>The name of the request attribute to use. Defaults to the value of field attribute.</xs:documentation></xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="field-to-session" substitutionGroup="EventOperations">
<xs:annotation>
<xs:documentation>
The field-to-session tag copies a field from a map to the specified servlet session attribute.
The tag is only used when the simple-method is called as an event, it is ignored otherwise.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.field-to-session"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.field-to-session">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation><xs:documentation>The context name of the field to use.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="session-name">
<xs:annotation><xs:documentation>The name of the session attribute to use. Defaults to the value of field attribute.</xs:documentation></xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="request-to-field" substitutionGroup="EventOperations">
<xs:annotation>
<xs:documentation>
The request-to-field tag copies an attribute from the servlet request to a field of a map in the method environment.
The tag is only used when the simple-method is called as an event, it is ignored otherwise (except the default value, if specified).
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.request-to-field"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.request-to-field">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation><xs:documentation>The context name of the field to use.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="default">
<xs:annotation>
<xs:documentation>
A default value to use if the request attribute is null or is a String and is empty.
This will also be used when NOT running as an event.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="request-name">
<xs:annotation><xs:documentation>The name of the request attribute to use. Defaults to the value of the field attribute.</xs:documentation></xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="request-parameters-to-list" substitutionGroup="EventOperations">
<xs:annotation>
<xs:documentation>
The request-parameters-to-list tag appends a request parameter values from the servlet request to the specified list.
The tag is only used when the simple-method is called as an event, it is ignored otherwise.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.request-parameters-to-list"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.request-parameters-to-list">
<xs:attribute type="xs:string" name="request-name" use="required">
<xs:annotation>
<xs:documentation>
The name of the request parameter values to use.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="list-name">
<xs:annotation>
<xs:documentation>
The name of the list in the method environment that the request parameter values will be appended to.
(default: request-name)
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="session-to-field" substitutionGroup="EventOperations">
<xs:annotation>
<xs:documentation>
The session-to-field tag copies an attribute from the servlet session to a field of a map in the method environment.
The tag is only used when the simple-method is called as an event, it is ignored otherwise (except the default value, if specified).
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.session-to-field"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.session-to-field">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation><xs:documentation>The name (key) of the map field to use.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="default">
<xs:annotation>
<xs:documentation>
A default value to use if the session attribute is null or is a String and is empty.
This will also be used when NOT running as an event.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="session-name">
<xs:annotation>
<xs:documentation>
The name of the session attribute to use. Defaults to the value of field attribute.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="webapp-property-to-field" substitutionGroup="EventOperations">
<xs:annotation>
<xs:documentation>
The webapp-property-to-field tag copies a property value from a properties file in a ServletContext resource to a field.
The tag is only used when the simple-method is called as an event, it is ignored otherwise (except the default value, if specified).
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.webapp-property-to-field"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.webapp-property-to-field">
<xs:attribute type="xs:string" name="resource" use="required">
<xs:annotation>
<xs:documentation>
The resource location of the properties file inside the webapp,
and relative to the root of the webapp (can be inside a war file).
An example of this is "/WEB-INF/myprops.properties".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="property" use="required">
<xs:annotation><xs:documentation>The property whose value will be put in the field.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="default">
<xs:annotation>
<xs:documentation>
A default value to use if the property value is null or empty.
This will also be used when NOT running as an event.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation><xs:documentation>The name (key) of the field to use.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="session-name">
<xs:annotation><xs:documentation>The name of the session attribute to use. Defaults to the value of field attribute</xs:documentation></xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<!-- Service specific operations -->
<xs:element name="field-to-result" substitutionGroup="ServiceOperations">
<xs:annotation>
<xs:documentation>
The field-to-result tag copies a field from a map to the specified service result field.
The tag is only used when the simple-method is called as a service, it is ignored otherwise.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.field-to-result"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.field-to-result">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation><xs:documentation>The name (key) of the map field to use.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="result-name">
<xs:annotation><xs:documentation>The name of the result Map name/key to use. Defaults to the value of field attribute.</xs:documentation></xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<!-- Environment specific operations -->
<xs:element name="map-to-map" substitutionGroup="EnvOperations">
<xs:annotation>
<xs:documentation>
The map-to-map tag copies all fields from one map to another map.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.map-to-map"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.map-to-map">
<xs:attribute type="xs:string" name="map" use="required">
<xs:annotation><xs:documentation>The name of the map in the method environment the fields will come from.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="to-map">
<xs:annotation>
<xs:documentation>
The name of the map in the method environment the fields will go to.
If empty the fields will be copied to the environment.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="field-to-list" substitutionGroup="EnvOperations">
<xs:annotation><xs:documentation>The field-to-list tag appends a field to the specified list.</xs:documentation></xs:annotation>
<xs:complexType><xs:attributeGroup ref="attlist.field-to-list"/></xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.field-to-list">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation><xs:documentation>The name (key) of the map field to use.</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="list" use="required">
<xs:annotation><xs:documentation>The name of the list in the method environment that the object will be appended to.</xs:documentation></xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="list-to-list" substitutionGroup="EnvOperations">
<xs:annotation><xs:documentation>Copy a list to another list.</xs:documentation></xs:annotation>
<xs:complexType><xs:attributeGroup ref="attlist.list-to-list"/></xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.list-to-list">
<xs:attribute type="xs:string" name="list" use="required">
<xs:annotation><xs:documentation>Name of the list to copy from</xs:documentation></xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="to-list" use="required">
<xs:annotation><xs:documentation>Name of the list to copy to.</xs:documentation></xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="order-map-list" substitutionGroup="EnvOperations">
<xs:annotation><xs:documentation>Sort a List containing Maps: order by fields names given in order-by sub-element.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence><xs:element maxOccurs="unbounded" ref="order-by"/></xs:sequence>
<xs:attributeGroup ref="attlist.order-map-list"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.order-map-list">
<xs:attribute type="xs:string" name="list" use="required">
<xs:annotation><xs:documentation>Name of the list to be sorted.</xs:documentation></xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="set" substitutionGroup="EnvOperations">
<xs:annotation>
<xs:documentation>
Move a value from one field to another field.
You can also take a value, just a string constant or a string
that is made up of a mixture of constant and flexible
string expansion variables using the ${} syntax, that will be
put in the field.
You can also specify a default value in the case that the
value evaluates to an empty string or the from-field is
null or empty. Then the default-value will be used.
Again you can use the flexible string expander here, the
${} syntax and such. It can also do a type conversion,
so going from whatever type the source data is in,
which would be a string value or whatever the variable
type is for a from field, it can convert that to any of
these types before setting it in the target field.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.set"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.set">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation>
<xs:documentation>
Name of the field to copy value to.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="from-field">
<xs:annotation>
<xs:documentation>
Name of the field to copy value from.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="value">
<xs:annotation>
<xs:documentation>
Simple value to copy in field.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="default-value">
<xs:annotation>
<xs:documentation>
Default value to copy in field if value evaluates to an empty string or the from-field is null or empty.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type">
<xs:annotation>
<xs:documentation>
Type to convert to. NewList will create a new List, NewMap will create a new Map.
</xs:documentation>
</xs:annotation>
<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="List"/>
<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:enumeration value="NewList"/>
<xs:enumeration value="NewMap"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="set-if-null" default="false">
<xs:annotation>
<xs:documentation>
Specifies whether or not to set fields that are null or empty.
Defaults to true.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="set-if-empty" default="true">
<xs:annotation>
<xs:documentation>
If the source value, either from a value or from a field, is empty, and
empty-string an empty list or a null value.
In this case it's set to true.
If you don't want to set, if you want it to
leave the target field alone when the source is empty,
then you need to set this to false.
</xs:documentation>
</xs:annotation>
<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="string-append" substitutionGroup="EnvOperations">
<xs:annotation>
<xs:documentation>
NOTE: the prefix and suffix will only be used IFF the current string and the string to be appended are both not empty.
So if the field does not exist then it will create a new field with this string value.
If it does exist then it will append this string value to the end.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.string-append"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.string-append">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation>
<xs:documentation>
The field that you want string-append to operate on.
This is the target field where the value will be put, and this is the string to append to that field.
So if the field does not exist then it will create a new field with this string value.
If it does exist then it will append this string value to the end.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="string" use="required">
<xs:annotation>
<xs:documentation>
The string to append to the field named in field-name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="arg-list">
<xs:annotation>
<xs:documentation>
arg-list-name is used to insert values from a list into
the string using the object in the standard Java library
that does this sort of string expression with a { } brackets
and a number, no dollar sign.
This pattern of the arg-list-name with the prefix and
suffix is something form the early days which is still
supported, but the best thing to do here is just use the
flexible string expander which is far more flexible and
powerful. So you can have the prefix variables to expand
and everything all mixed into one string.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="prefix">
<xs:annotation>
<xs:documentation>
Used in conjunction with arg-list-name.
String that will be prepended to the string,
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="suffix">
<xs:annotation>
<xs:documentation>
Used in conjunction with arg-list-name.
String that will be appended to the string,
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="string-to-list" substitutionGroup="EnvOperations">
<xs:annotation>
<xs:documentation>
Take a string literally that can also have a flexible string expander and such in it,
and it will add it to a list.
Note that you can have an arg-listname for using the standard
Java style argument list where you have in the source
string numbers inside of { } brackets that represent the
number the index in the argument list to insert at that point.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.string-to-list"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.string-to-list">
<xs:attribute type="xs:string" name="string" use="required">
<xs:annotation>
<xs:documentation>
String to add to the list named in list-name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="list" use="required">
<xs:annotation>
<xs:documentation>
List to add string to.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="arg-list">
<xs:annotation>
<xs:documentation>
arg-list-name is used to insert values from a list into
the string using the object in the standard Java library
that does this sort of string expresison with a { } brackets
and a number, no dollar sign.
This pattern of the arg-list-name with the prefix and
suffix is something form the early days which is still
supported, but the best thing to do here is just use the
flexible string expander which is far more flexible and
powerful. So you can have the prefix variables to expand
and everything all mixed into one string.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="message-field">
<xs:annotation>
<xs:documentation>
To insert a message above a field (used in conjunction with @fieldErrors FTL macro)
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="to-string" substitutionGroup="EnvOperations">
<xs:annotation>
<xs:documentation>
The to-string tag converts the Object in the specified field to a String, putting the string in the same field.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.to-string"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.to-string">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation>
<xs:documentation>
The name (key) of the map field to use.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="format">
<xs:annotation>
<xs:documentation>
Format based on the type of the object (date,number, etc.).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="numeric-padding">
<xs:annotation>
<xs:documentation>
Padding to use if a numeric object is used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="clear-field" substitutionGroup="EnvOperations">
<xs:annotation>
<xs:documentation>
Sets the value of the specified field to null.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.clear-field"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.clear-field">
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation>
<xs:documentation>
The name (key) of the map field to use.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="first-from-list" substitutionGroup="EnvOperations">
<xs:annotation>
<xs:documentation>
The first-from-list tag will get the first entry from the given list and put it in the environment field with the given entry-name.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.first-from-list"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.first-from-list">
<xs:attribute type="xs:string" name="entry" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that will contain the first entry in the list.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="list" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains the list to get the first entry from.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<!--
These operations are used to interact with a data source through the entity
engine and facilitate related operations.
-->
<xs:element name="transaction-begin" substitutionGroup="EntityTxOperations">
<xs:annotation>
<xs:documentation>
The transaction-begin tag will begin a transaction if one is not already in place.
If a transaction is begun the environment field named as the began-transaction-name will be set to true, otherwise it will be set to false.
Note that unless the simple-method is flagged to not use a transaction all simple-methods will be inside a transaction.
The same is true for service calls through the Service Engine.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.transaction-begin"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.transaction-begin">
<xs:attribute type="xs:string" name="began-transaction-name" default="beganTransaction">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains a Boolean specifying whether or not a transaction was begun in the current transaction demarcation.
Defaults to "beganTransaction".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="transaction-commit" substitutionGroup="EntityTxOperations">
<xs:annotation>
<xs:documentation>
The transaction-commit tag will commit a transaction if a transaction was begun in the current demarcation context as represented by the environment field named as the began-transaction-name.
If the Boolean in that field is false no commit will be done.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.transaction-commit"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.transaction-commit">
<xs:attribute type="xs:string" name="began-transaction-name" default="beganTransaction">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains a Boolean specifying whether or not a transaction was begun in the current transaction demarcation.
Defaults to "beganTransaction".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="transaction-rollback" substitutionGroup="EntityTxOperations">
<xs:annotation>
<xs:documentation>
The transaction-rollback tag will rollback a transaction if a transaction was begun in the current demarcation context as represented by the environment field named as the began-transaction-name.
If the Boolean in that field is false a set rollback only will operation will be done instead of rollback which will force the transaction to rollback regardless of which method or object is responsible for beginning and ending the transaction.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.transaction-rollback"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.transaction-rollback">
<xs:attribute type="xs:string" name="began-transaction-name" default="beganTransaction">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains a Boolean specifying whether or not a transaction was begun in the current transaction demarcation.
Defaults to "beganTransaction".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="sequenced-id" substitutionGroup="EntityMiscOperations">
<xs:annotation>
<xs:documentation>
The sequenced-id tag gets a sequenced ID from the Entity Engine (through the delegator) and puts it in the specified method environment field.
The object will be a java.lang.Long, but can of course be converted to a String.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.sequenced-id"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.sequenced-id">
<xs:attribute type="xs:string" name="sequence-name" use="required">
<xs:annotation>
<xs:documentation>
The name of the sequence to pass to the delegator.
The same name must always be used for sequenced IDs that will be used for a certain entity field otherwise non-unique keys may result.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="field" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field the sequenced ID will be put in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="get-long-only" default="false">
<xs:annotation>
<xs:documentation>
Get a numerical long value and put it there, so it does not do that by default.
By default getlong-only is false. If you want it to just get a long number
then you can set that to true. That's in there for supporting lower level functionality,
but that's not the typical pattern used in OFBiz as we do use strings for sequencing.
</xs:documentation>
</xs:annotation>
<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="stagger-max">
<xs:annotation>
<xs:documentation>
By default this is one. But if you want to have sequenced Ids that are staggered, instead
of consecutive, then you can set this to something like twenty. And then it will do a random staggering for
each sequenced id; instead of picking the next value all the time it will pick something between the next value
and twenty away from the next value, if stagger-max is set to twenty.
So that can be used to make the sequenced Ids more difficult to guess.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="make-next-seq-id" substitutionGroup="EntityMiscOperations">
<xs:annotation>
<xs:documentation>
sequenced-id is the primary key sequencer.
Make-next-seq-id is the secondary key sequencer. So
this would be something like an orderId for example,
where we're sequencing an orderId automatically. And
this would be something like an orderItemSequenceId,
where we have a sub-sequence that varies for order
item records related back to an orderHeader. So all of
them will have the same orderId.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.make-next-seq-id"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.make-next-seq-id">
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
Specify the name of the entity for a sequenced-id preparing the primarySequencedId.
The name of the entity is typically what we use for the sequenced name, but you can use anything
you want if you want to have different sets of sequences.
The risk of course of many different sets of sequences
for the same entity is unless you somehow prefix or
suffix the value, you could have a key conflict. So we
just use the entity name for these primary sequences.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="seq-field-name" use="required">
<xs:annotation>
<xs:documentation>
The field that will have the sub-sequenced value.
We use the seqId suffix on the field names in the OFBiz
data model to denote that that field is a secondary sequenced ID
and should therefore be maintained for this sort of operation.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="numeric-padding" default="5">
<xs:annotation>
<xs:documentation>
Since these are eventually strings we do numeric-padding so that the sort is consistent,
By default we pad it with five positions.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="increment-by" default="1">
<xs:annotation>
<xs:documentation>
Default to 1.
If you want to leave some space in the sub-sequence you
can use a greater increment.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="entity-data" substitutionGroup="EntityMiscOperations">
<xs:annotation>
<xs:documentation>
Specify the location of an XML file that should be in the same format as any
of the entity engine XML files, or the entity engine transformed
XML files. And what this will do is either load or
assert that file depending on the mode.
If it finds the record but any of the fields are different,
this is in the assert mode still, it will report any field
that's different in a message on the error list. So that's
basically what you can in essence assert, that a certain
set of data exists in the database.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.entity-data"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.entity-data">
<xs:attribute type="xs:string" name="location" use="required">
<xs:annotation>
<xs:documentation>
Specify the location of an XML file to load in database or verify in assert mode.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="delegator-name" use="optional">
<xs:annotation>
<xs:documentation>
Overrides the delegator or default context by specifying a delegator-name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:integer" name="timeout" default="-1">
<xs:annotation>
<xs:documentation>
Override the timeout to start a new transaction and load the data with a longer timeout.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="error-list-name" default="error_list">
<xs:annotation>
<xs:documentation>
The name of the list in the method environment to check for error messages.
Defaults to "error_list".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="mode" default="load">
<xs:annotation>
<xs:documentation>
"load" or "assert". Default to "load".
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="load">
<xs:annotation>
<xs:documentation>
Load the file into the database.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="assert">
<xs:annotation>
<xs:documentation>
Go through each row in the file, each record, and it
will look that up by primary key. If it does not find it, it'll
add a message to the error list about not having found it.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="find-by-primary-key" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
The find-by-primary-key tag uses the delegator to find an entity value by its primary key.
The resulting GenericValue object will be placed in the method environment using the specified value-field.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.find-by-primary-key"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.find-by-primary-key">
<xs:attribute type="xs:string" name="entity-name" use="optional">
<xs:annotation>
<xs:documentation>
The name of the entity to find an instance of.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="map" use="required">
<xs:annotation>
<xs:documentation>
The name of a map in the method environment that will be used for the entity fields.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that will contain the GenericValue object.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="use-cache" default="false">
<xs:annotation>
<xs:documentation>
Specifies whether or not the delegator's cache should be searched before going to the database.
This results in much faster retrieval times, but can return stale data that is not the most current in the database.
Must be "true" or "false", defaults to "false".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="fields-to-select-list">
<xs:annotation>
<xs:documentation>
List containing name of fields to select, if empty defaults to all entity fields.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="delegator-name">
<xs:annotation>
<xs:documentation>
By default this operation is done using the delegator that is part of the simple-method calling context.
This allows you to override the default delegator by naming an alternate delegator.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="find-by-and" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
The find-by-and tag uses the delegator to find entity values by anding the fields passed in the map.
The resulting GenericValue objects will be placed in the method environment using the specified list-name.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.find-by-and"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.find-by-and">
<xs:attribute type="xs:string" name="entity-name" use="required">
<xs:annotation>
<xs:documentation>
The name of the entity to find instances of.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="map" use="required">
<xs:annotation>
<xs:documentation>
The name of a map in the method environment that will be used for the entity fields.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="order-by-list">
<xs:annotation>
<xs:documentation>
This will be a list sitting in the context that has string entries in it for each field that you want it to order by/
Each field in the list, or each entry in the list, will just be a string with a field name.
It can be preceded by a plus or a minus to specify an ascending or descending sort for that.
The default is ascending sort, so you just put a minus in front of the field-name if you want it to be descending.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="delegator-name">
<xs:annotation>
<xs:documentation>
By default this operation is done using the delegator that is part of the simple-method calling context.
This allows you to override the default delegator by naming an alternate delegator.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="use-cache" default="false">
<xs:annotation>
<xs:documentation>
Specifies whether or not the delegator's cache should be searched before going to the database.
This results in much faster retrieval times, but can return stale data that is not the most current in the database.
Must be "true" or "false", defaults to "false".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="use-iterator" default="false">
<xs:annotation>
<xs:documentation>
Specifies whether or not to use the EntityListIterator when doing the query.
This is much more efficient for large data sets because the results are read incrementaly instead of all at once.
Note that when using this the use-cache setting will be ignored.
Also note that an EntityListIterator must be closed when you are finished, but this is done automatically by the iterate operation.
Must be "true" or "false", defaults to "false".
</xs:documentation>
</xs:annotation>
<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="list" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that will contain the list of GenericValue objects.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="entity-one" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
Does a find-by-primarykey, always returns a single generic value object if it's found, otherwise returns null.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="field-map">
<xs:annotation>
<xs:documentation>
Specify where to find primary key fields if you set auto-field-map to false.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="select-field">
<xs:annotation>
<xs:documentation>
Specify fields to select, otherwise all fields will be selected.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attributeGroup ref="attlist.entity-one"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.entity-one">
<xs:attribute name="entity-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of the entity to query on.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value-field" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of the variable to put result record in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="use-cache" default="false">
<xs:annotation>
<xs:documentation>
Specifies whether or not the delegator's cache should be searched before going to the database.
This results in much faster retrieval times, but can return stale data that is not the most current in the database.
Must be "true" or "false", defaults to "false".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="auto-field-map" default="true">
<xs:annotation>
<xs:documentation>
Looks for all primary key field names in the current context as well as in the parameters map or not.
Defaults to true.
</xs:documentation>
</xs:annotation>
<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="entity-and" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
Does a find-by-and, returns a list of GenericValues if any are found, otherwise returns an empty list.
Uses name/value pairs, that will be used for the query and will all be "anded" together.
The result-set-type by default is scroll which is flexible so you can go forward.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="field-map"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="select-field">
<xs:annotation><xs:documentation>Specify fields to select, otherwise all fields will be selected.</xs:documentation></xs:annotation>
</xs:element>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="order-by">
<xs:annotation><xs:documentation>Defines fields to order list by.</xs:documentation></xs:annotation>
</xs:element>
<xs:choice minOccurs="0">
<xs:element ref="limit-range"/>
<xs:element ref="limit-view"/>
<xs:element ref="use-iterator"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="attlist.entity-and"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.entity-and">
<xs:attribute name="entity-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of entity to search in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="use-cache" type="xs:string" default="false">
<xs:annotation>
<xs:documentation>
Specifies whether or not the delegator's cache should be searched before going to the database.
This results in much faster retrieval times, but can return stale data that is not the most current in the database.
Must be "true" or "false", defaults to "false".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="filter-by-date" default="false">
<xs:annotation>
<xs:documentation>
Look for from-date and through-date fields in the list of results coming back
and filters by the current date and time if set to true.
Defaults to false.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
<xs:enumeration value="by-name"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="list" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of the list where to put results.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="entity-condition" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
Like entity-and returns a list of Generic values if any are found, otherwise returns an empty list.
Uses any of condition-expression, condition-list and condition-object.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="condition-expr"/>
<xs:element ref="condition-list"/>
<xs:element ref="condition-object"/>
</xs:choice>
<xs:element minOccurs="0" ref="having-condition-list"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="select-field">
<xs:annotation>
<xs:documentation>
Specify fields to select, otherwise all fields will be selected.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="order-by"/>
<xs:choice minOccurs="0">
<xs:element ref="limit-range"/>
<xs:element ref="limit-view"/>
<xs:element ref="use-iterator"/>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="attlist.entity-condition"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.entity-condition">
<xs:attribute name="entity-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of entity to search in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="use-cache" default="false">
<xs:annotation>
<xs:documentation>
Specifies whether or not the delegator's cache should be searched before going to the database.
This results in much faster retrieval times, but can return stale data that is not the most current in the database.
Must be "true" or "false", defaults to "false".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="filter-by-date" default="false">
<xs:annotation>
<xs:documentation>
Look for from date and through date fields in the list of results coming back
and filters by the current date and time if set to true.
Defaults to false.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
<xs:enumeration value="by-name"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="distinct" default="false">
<xs:annotation>
<xs:documentation>
Filter the results making sure that all of them are unique.
Defaults to false.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="delegator-name" type="xs:string">
<xs:annotation>
<xs:documentation>
Name of a delegator to use.
By default uses the delegator associated with that instance of the service engine.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="list" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of the list where to put results.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="condition-list">
<xs:annotation>
<xs:documentation>
A condition-list is a list of conditions that are combined with either and or or.
The default is and.
You can have condition-lists under condition-list, for building fairly complex condition trees,
and you can also drop in condition-objects at any point.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element ref="condition-expr"/>
<xs:element ref="condition-list"/>
<xs:element ref="condition-object"/>
</xs:choice>
<xs:attributeGroup ref="attlist.condition-list"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.condition-list">
<xs:attribute name="combine" default="and">
<xs:annotation>
<xs:documentation>
"or" or "and", defaults to and.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="and"/>
<xs:enumeration value="or"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="having-condition-list">
<xs:annotation>
<xs:documentation>
Similar to condition-list but relates to SQL grouping : having-condition runs after the grouping.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element ref="condition-expr"/>
<xs:element ref="condition-list"/>
<xs:element ref="condition-object"/>
</xs:choice>
<xs:attributeGroup ref="attlist.having-condition-list"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.having-condition-list">
<xs:attribute name="combine" default="and">
<xs:annotation>
<xs:documentation>
"or" or "and", defaults to and.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="and"/>
<xs:enumeration value="or"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="condition-expr">
<xs:annotation>
<xs:documentation>
Basically combines a field, an SQL operator and a variable or a value.
The variable is actually a field in the context : env-name.
There are some options to ignore the condition if the env-name or value is empty or null.
Or to ignore case.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.condition-expr"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.condition-expr">
<xs:attribute name="field-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of the field to apply operator on, combined with env-name or value.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="operator" default="equals">
<xs:annotation>
<xs:documentation>
Operator to apply to field-name and env-name or value.
If you use the between then the env-name must point to
a collection that has two entries in it. With in you may specify several entries.
If you use like, then it's just a single thing, as will all of the other ones;
less, greater, less-equals, greater-equals, equals, not equals.
Defaults to equals.
</xs:documentation>
</xs:annotation>
<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="in"/>
<xs:enumeration value="not-in"/>
<xs:enumeration value="between"/>
<xs:enumeration value="like"/>
<xs:enumeration value="not-like"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="from-field" type="xs:string">
<xs:annotation>
<xs:documentation>
Name of field (variable) to apply operator on, along with field-name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" type="xs:string">
<xs:annotation>
<xs:documentation>
Value to apply operator on, combined with field-name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ignore-if-null" default="false">
<xs:annotation>
<xs:documentation>
Ignore the condition if the env-name or value is null.
Defaults to false.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ignore-if-empty" default="false">
<xs:annotation>
<xs:documentation>
Ignore the condition if the env-name or value is empty.
Defaults to false.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ignore-case" default="false">
<xs:annotation>
<xs:documentation>
Ignore case when using operator if the env-name or value is empty.
Defaults to false.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ignore" default="false">
<xs:annotation>
<xs:documentation>
Ignore the condition if flag is true.
Defaults to false.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="condition-object">
<xs:annotation>
<xs:documentation>
An instance of the entity-condition, or an object that implements the entity-condition interface.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.condition-object"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.condition-object">
<xs:attribute name="field" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Field in the current context where that condition object is that implements the entity condition interface.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="select-field">
<xs:complexType>
<xs:attributeGroup ref="attlist.select-field"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.select-field">
<xs:attribute name="field-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of field to select.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="order-by">
<xs:annotation>
<xs:documentation>
Defines fields to order list by.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.order-by"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.order-by">
<xs:attribute name="field-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of field to order list by.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="limit-range">
<xs:annotation>
<xs:documentation>
Specify a start, value, and a number of results to include.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.limit-range"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.limit-range">
<xs:attribute name="start" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Should resolve into a non-negative integer.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="size" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Should resolve into a non-negative integer.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="limit-view">
<xs:annotation>
<xs:documentation>
Specify a view-index, and a view-size of elements to view.
Start at view-index - 1 times of view-size with origin 0.
Example : view-index=3 and view-size=10 gives elements 21 to 30.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.limit-view"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.limit-view">
<xs:attribute name="view-index" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Index of elements to view, depends on view-size.
Should resolve into a non-negative integer.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="view-size" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Number of elements to view.
Should resolve into a positive integer.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="use-iterator">
<xs:annotation>
<xs:documentation>
Specifies whether or not to use the EntityListIterator when doing the query.
This is much more efficient for large data sets because the results are read incrementaly instead of all at once.
Note that when using this the use-cache setting will be ignored.
Also note that an EntityListIterator must be closed when you are finished, but this is done automatically by the iterate operation.
Must be "true" or "false", defaults to "false".
</xs:documentation>
</xs:annotation>
<xs:complexType/>
</xs:element>
<xs:element name="field-map">
<xs:complexType>
<xs:attributeGroup ref="attlist.field-map"/>
</xs:complexType>
</xs:element>
<xs:annotation>
<xs:documentation>
A name/value pair.
</xs:documentation>
</xs:annotation>
<xs:attributeGroup name="attlist.field-map">
<xs:attribute type="xs:string" name="field-name" use="required">
<xs:annotation>
<xs:documentation>
Name of the field.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="from-field">
<xs:annotation>
<xs:documentation>
Name of the variable in the context.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="value">
<xs:annotation>
<xs:documentation>
Literal or flexible string using ${} syntax.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="entity-count" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
Returns a long presenting the number of results found matching the specified condition.
The entity-count is very similar to the entity-condition.
Specify the entity-name, optionally the delgator-name if you want to override that,
and then the name of the variable to put the count in.
You can do the same condition-expr (condition expression) or condition-list which can have condition-expr
and other condition-lists underneath it for a tree of conditions that can be arbitrarily complex.
You can also use the have-in-condition-list, this is the same as on the entity-condition.
What this will do basically is, rather than doing a query and getting the results back,
it will just count the results and put that number in the context in the variable named by the count-name.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element ref="condition-expr"/>
<xs:element ref="condition-list"/>
<xs:element ref="condition-object"/>
</xs:choice>
<xs:element minOccurs="0" ref="having-condition-list"/>
</xs:sequence>
<xs:attributeGroup ref="attlist.entity-count"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.entity-count">
<xs:attribute name="entity-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of entity to search in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="delegator-name" type="xs:string">
<xs:annotation>
<xs:documentation>
Name of a delegator to use.
By default uses the delegator associated with that instance of the service engine.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="count-field" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of the field (variable) to put result of the count in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="get-related-one" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
If you have a generic value object sitting in the context and you want to get a related entity
following one of the type one relationships in the data model, then you can specify the name of the value
here, the relation-name, the name of the relationship between the two entities, and the to-value where it
should put the result, and you can tell it to use-cache or not, by default it doesn't.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.get-related-one"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.get-related-one">
<xs:attribute name="value-field" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of a generic value sitting in the context from where you want to get a related-one generic value.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="relation-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of the one-relation to use to relate generic value in value-field to generic value in to-value.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="use-cache" type="xs:string" default="false">
<xs:annotation>
<xs:documentation>
Specifies whether or not the delegator's cache should be searched before going to the database.
This results in much faster retrieval times, but can return stale data that is not the most current in the database.
Must be "true" or "false", defaults to "false".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="to-value-field" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of a generic value where to put the result.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="get-related" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
Get-related is just like get-related-one,
except that instead of getting a single value back to put in the to-value,
it gets a full list back.
You start with the the value object, specify the name of the relationship.
You can specify the name of a map that will restrain the query further,
beyond the field mappings and their relationship.
You can also specify how you want to order it.
Use-cache true or false, list-name for the output.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.get-related"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.get-related">
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
Name of a generic value sitting in the context from where you want to get a related generic value.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="relation-name" use="required">
<xs:annotation>
<xs:documentation>
Name of the relation to use to relate generic value in value-field to generic value in to-value.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="map">
<xs:annotation>
<xs:documentation>
Name of a map that will restrain the query further,
beyond the field mappings and their relationship.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="order-by-list">
<xs:annotation>
<xs:documentation>
This will be a list sitting in the context that has string entries in it for each field that you want it to order by/
Each field in the list, or each entry in the list, will just be a string with a field name.
It can be preceded by a plus or a minus to specify an ascending or descending sort for that.
The default is ascending sort, so you just put a minus in front of the field-name if you want it to be descending.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="use-cache" default="false">
<xs:annotation>
<xs:documentation>
Specifies whether or not the delegator's cache should be searched before going to the database.
This results in much faster retrieval times, but can return stale data that is not the most current in the database.
Must be "true" or "false", defaults to "false".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="list" use="required">
<xs:annotation>
<xs:documentation>
Name of a list where to put the result in.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="order-value-list" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
Order-value-list does not actually do anything with the database.
It takes an exiting list that has been returned and sorts it.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.order-value-list"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.order-value-list">
<xs:attribute type="xs:string" name="list" use="required">
<xs:annotation>
<xs:documentation>
Name of the list of generic value objects that we want to sort.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="to-list">
<xs:annotation>
<xs:documentation>
Name of the output list. If it is empty, as it is optional, it will simply use the list-name.
In other words it will take the ordered list and put it over top of the resource list.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="order-by-list" use="required">
<xs:annotation>
<xs:documentation>
This will be a list sitting in the context that has string entries in it for each field that you want it to order by.
Each field in the list, or each entry in the list, will just be a string with a field name.
It can be preceded by a plus or a minus to specify an ascending or descending sort for that.
The default is ascending sort, so you just put a minus in front of the field-name if you want it to be descending.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="filter-list-by-and" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
The filter-list-by-and tag filters the given list by the fields in the specified map.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.filter-list-by-and"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.filter-list-by-and">
<xs:attribute type="xs:string" name="list" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains the list of GenericValue objects.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="to-list">
<xs:annotation>
<xs:documentation>
The name of the method environment field the filtered list will be put into.
Defaults to the value of the list-name attribute (ie goes to the same place it came from, replacing the old list).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="map">
<xs:annotation>
<xs:documentation>
The name of a map in the method environment that will be used for the entity fields.
If no map is used this will just make a copy of the list.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="filter-list-by-date" substitutionGroup="EntityFindOperations">
<xs:annotation>
<xs:documentation>
The filter-list-by-date tag filters the given list by the valid date using the from and thru dates in each value object.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.filter-list-by-date"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.filter-list-by-date">
<xs:attribute type="xs:string" name="list" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains the list of GenericValue objects.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="to-list">
<xs:annotation>
<xs:documentation>
The name of the method environment field the filtered list will be put into.
Defaults to the value of the list-name attribute (ie goes to the same place it came from, replacing the old list).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="valid-date">
<xs:annotation>
<xs:documentation>
The name of a field in the method environment date to filter by.
Defaults to now.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="from-field-name" default="fromDate">
<xs:annotation>
<xs:documentation>
The name of the GenericValue field to use as the beginning effective date.
Defaults to fromDate.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="thru-field-name" default="thruDate">
<xs:annotation>
<xs:documentation>
The name of the GenericValue field to use as the ending effective date.
Defaults to thruDate.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="all-same" default="true">
<xs:annotation>
<xs:documentation>
Specifies whether or not all GenericValue objects in the list are of the same entity.
Defaults to true.
</xs:documentation>
</xs:annotation>
<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="make-value" substitutionGroup="EntityValueOperations">
<xs:annotation>
<xs:documentation>
The make-value tag uses the delegator to construct an entity value.
The resulting value will not necessarily exist in the database, but will simply be assembled using the entity-name and fields map.
The resulting GenericValue object will be placed in the method environment using the specified value-field.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.make-value"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.make-value">
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains the GenericValue object.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="entity-name" use="required">
<xs:annotation>
<xs:documentation>
The name of the entity to construct an instance of.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="map">
<xs:annotation>
<xs:documentation>
The name of a map in the method environment that will be used for the entity fields.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="clone-value" substitutionGroup="EntityValueOperations">
<xs:annotation>
<xs:documentation>
The clone-value tag make a copy of the value in the method environment field specified by value-field.
The resulting GenericValue object will be placed in the method environment using the specified new-value-field.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.clone-value"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.clone-value">
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains the GenericValue object.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="new-value-field" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that will contain the new GenericValue object.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:element name="create-value" substitutionGroup="EntityValueOperations">
<xs:annotation>
<xs:documentation>
The create-value tag persists the specified GenericValue object by creating a new instance of the entity in the datasource.
An error will result if an instance of the entity exists in the datasource with the same primary key.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.create-value"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.create-value">
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains the GenericValue object.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="do-cache-clear" default="true">
<xs:annotation>
<xs:documentation>
Clear the cache. Defaults to "true".
Deprecated - should always be true
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="or-store" default="false">
<xs:annotation>
<xs:documentation>
Store value if already exists, defaults to false
</xs:documentation>
</xs:annotation>
<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="store-value" substitutionGroup="EntityValueOperations">
<xs:annotation>
<xs:documentation>
The store-value tag persists the specified GenericValue object by updating the instance of the entity in the datasource.
An error will result if an instance of the entity does not exist in the datasource with the same primary key.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.store-value"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.store-value">
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains the GenericValue object.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="do-cache-clear" default="true">
<xs:annotation>
<xs:documentation>
Clear the cache. Defaults to "true".
Deprecated - should always be true
</xs:documentation>
</xs:annotation>
<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="refresh-value" substitutionGroup="EntityValueOperations">
<xs:annotation>
<xs:documentation>
Refresh from database the value given in value-field.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.refresh-value"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.refresh-value">
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
Name of the value to refresh from database.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="do-cache-clear" default="true">
<xs:annotation>
<xs:documentation>
Clear the cache, defaults to true.
</xs:documentation>
</xs:annotation>
<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="remove-value" substitutionGroup="EntityValueOperations">
<xs:annotation>
<xs:documentation>
The remove-value tag removes the specified GenericValue object by removing the instance of the entity in the datasource.
An error will result if an instance of the entity does not exist in the datasource with the same primary key.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.remove-value"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.remove-value">
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
The name of the method environment field that contains the GenericValue object.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="do-cache-clear" default="true">
<xs:annotation>
<xs:documentation>
Clear the cache. Defaults to "true".
Deprecated - should always be true
</xs:documentation>
</xs:annotation>
<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="remove-related" substitutionGroup="EntityValueOperations">
<xs:annotation>
<xs:documentation>
Given a value name and a relationship name,
follows the relationship and remove all related
records, whether they be a type one or type many
relationship.
For a type one relationship it will remove a
single record if it exists, and for a type many relationship
it will remove all the records that are related to it.
This of course can be dangerous, for example if you
have a product-type entity and you do a remove-related
with a certain product type value object here, and the
relation name product here, it will remove all products
of that type. This is of more value when you're doing
something like removing an order or removing a product,
and you want to remove all related elements before
removing the product to resolve foreign key issues.
Usually the best practice for that, for removing a product
for example, is to do a remove-related on certain
types of information related to the product, and then try
to remove the product but not remove all related tables.
In many cases, if the product has been ordered for example,
then you do not want to remove the product,
and so you can do all these remove-relateds.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="attlist.remove-related"/>
</xs:complexType>
</xs:element>
<xs:attributeGroup name="attlist.remove-related">
<xs:attribute type="xs:string" name="value-field" use="required">
<xs:annotation>
<xs:documentation>
Name of a generic value to remove all related records.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="relation-name" use="required">
<xs:annotation>
<xs:documentation>
Name of a relation to use to remove related records.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="do-cache-clear" default="true">
<xs:annotation>
<xs:documentation>
Clear the cache. Defaults to "true".
Deprecated - should always be true
</xs:documentation>