svn commit: r763615 [2/3] - /ofbiz/site/dtds/
Locked
 
|
Modified: ofbiz/site/dtds/simple-methods.xsd
URL: http://svn.apache.org/viewvc/ofbiz/site/dtds/simple-methods.xsd?rev=763615&r1=763614&r2=763615&view=diff ============================================================================== --- ofbiz/site/dtds/simple-methods.xsd (original) +++ ofbiz/site/dtds/simple-methods.xsd Thu Apr 9 12:09:58 2009 @@ -100,13 +100,13 @@ <!-- 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 + <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. + 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> @@ -120,9 +120,9 @@ <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. + 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> @@ -164,12 +164,12 @@ 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> @@ -182,26 +182,26 @@ <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> + 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> <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> + A short description of the method for certain system error messages. </xs:documentation> - </xs:annotation> - </xs:attribute> + </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" (defauts to "true") + <xs:documentation> + Is a logged in user (UserLogin object, or login.username and login.password Strings) required to run this method? + "true" or "false" (defauts to "true") </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:simpleType> <xs:restriction base="xs:token"> <xs:enumeration value="true"/> @@ -211,11 +211,11 @@ </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" (defauts to "true") + <xs:documentation> + Create a transaction if none exists for this thread? + "true" or "false" (defauts to "true") </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:simpleType> <xs:restriction base="xs:token"> <xs:enumeration value="true"/> @@ -225,149 +225,149 @@ </xs:attribute> <xs:attribute type="xs:string" name="default-error-code" default="error"> <xs:annotation> - <xs:documentation> - The default error return code. (defauts to "error") + <xs:documentation> + The default error return code. (defauts to "error") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="default-success-code" default="success"> <xs:annotation> - <xs:documentation> - The default success return code. (defauts to "success") + <xs:documentation> + The default success return code. (defauts to "success") </xs:documentation> - </xs:annotation> + </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. - (defauts to "parameters") + <xs:documentation> + As event: copy of request parameters. + As service: incoming context. + (defauts to "parameters") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="event-request-object-name" default="request"> <xs:annotation> - <xs:documentation> - As event only (defauts to "request") + <xs:documentation> + As event only (defauts to "request") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="event-response-object-name" default="response"> <xs:annotation> - <xs:documentation> - As event only (defauts to "response") + <xs:documentation> + As event only (defauts to "response") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="event-response-code-name" default="_response_code_"> <xs:annotation> - <xs:documentation> - As event only (defauts to "_response_code") + <xs:documentation> + As event only (defauts to "_response_code") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="event-error-message-name" default="_error_message_"> <xs:annotation> - <xs:documentation> - As event only (defauts to "_error_message_") + <xs:documentation> + As event only (defauts to "_error_message_") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="event-event-message-name" default="_event_message_"> <xs:annotation> - <xs:documentation> - As event only (defauts to "_event_message_") + <xs:documentation> + As event only (defauts to "_event_message_") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="service-response-message-name" default="responseMessage"> <xs:annotation> <xs:documentation> - As service only (defauts to "responseMessage") + As service only (defauts to "responseMessage") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="service-error-message-name" default="errorMessage"> <xs:annotation> - <xs:documentation> - As service only (defauts to "errorMessage") + <xs:documentation> + As service only (defauts to "errorMessage") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="service-error-message-list-name" default="errorMessageList"> <xs:annotation> - <xs:documentation> - As service only (defauts to "errorMessageList") + <xs:documentation> + As service only (defauts to "errorMessageList") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="service-error-message-map-name" default="errorMessageMap"> <xs:annotation> - <xs:documentation> - As service only (defauts to "errorMessageMap") + <xs:documentation> + As service only (defauts to "errorMessageMap") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="service-success-message-name" default="successMessage"> <xs:annotation> - <xs:documentation> - As service only (defauts to "successMessage") + <xs:documentation> + As service only (defauts to "successMessage") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="service-success-message-list-name" default="successMessageList"> <xs:annotation> - <xs:documentation> + <xs:documentation> As service only (defauts to "successMessageList") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="locale-name" default="locale"> <xs:annotation> - <xs:documentation> - Name of locale variable (defauts to "locale") + <xs:documentation> + Name of locale variable (defauts to "locale") </xs:documentation> - </xs:annotation> + </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 (defauts to "delegator") + <xs:documentation> + A GenericDelegator object to use in the method (defauts to "delegator") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="security-name" default="security"> <xs:annotation> - <xs:documentation> + <xs:documentation> A Security object to use in the method (defauts to "security") </xs:documentation> - </xs:annotation> + </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 (defauts to "dispatcher") + <xs:documentation> + A LocalDispatcher object to use in the method (defauts to "dispatcher") </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:attribute> <xs:attribute type="xs:string" name="user-login-name" default="userLogin"> <xs:annotation> - <xs:documentation> - Name of user login variable (defauts to "userLogin") + <xs:documentation> + Name of user login variable (defauts to "userLogin") </xs:documentation> - </xs:annotation> + </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. - + 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> @@ -377,10 +377,10 @@ <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. + 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:annotation> </xs:element> </xs:sequence> <xs:attributeGroup ref="attlist.call-map-processor"/> @@ -390,50 +390,50 @@ <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. + 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: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. + 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: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. + The name of a map in the method environment to use as the input map. </xs:documentation> - </xs:annotation> + </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. + 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: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". + 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: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. + 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> @@ -453,21 +453,21 @@ <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". + 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: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 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> @@ -496,16 +496,16 @@ <xs:attribute type="xs:string" name="service-name" use="required"> <xs:annotation> <xs:documentation> - Name of the service to call. + Name of the service to call. </xs:documentation> - </xs:annotation> + </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 + 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> @@ -516,13 +516,13 @@ 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". + pass that in you can just set this to false. + Defaults to "true". </xs:documentation> </xs:annotation> <xs:simpleType> <xs:annotation> - </xs:annotation> + </xs:annotation> <xs:restriction base="xs:token"> <xs:enumeration value="true"/> <xs:enumeration value="false"/> @@ -539,7 +539,7 @@ set that to false. Defaults to "true". </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:simpleType> <xs:restriction base="xs:token"> <xs:enumeration value="true"/> @@ -552,14 +552,14 @@ <xs:documentation> Defaults to "error". </xs:documentation> - </xs:annotation> + </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:annotation> </xs:attribute> <xs:attribute name="require-new-transaction" default="false"> <xs:annotation> @@ -589,7 +589,7 @@ <xs:documentation> Specify a resource and a property to prepend to the error message. </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:complexType mixed="true"> <xs:attributeGroup ref="attlist.propertyInfoOptional"/> </xs:complexType> @@ -599,7 +599,7 @@ <xs:documentation> Specify a resource and a property to append to the error message. </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:complexType mixed="true"> <xs:attributeGroup ref="attlist.propertyInfoOptional"/> </xs:complexType> @@ -609,7 +609,7 @@ <xs:documentation> Specify a resource and a property to prepend to the success message. </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:complexType mixed="true"> <xs:attributeGroup ref="attlist.propertyInfoOptional"/> </xs:complexType> @@ -619,7 +619,7 @@ <xs:documentation> Specify a resource and a property to append to the success message. </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:complexType mixed="true"> <xs:attributeGroup ref="attlist.propertyInfoOptional"/> </xs:complexType> @@ -629,7 +629,7 @@ <xs:documentation> Specify a resource and a property to prepend to any kind of message. </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:complexType mixed="true"> <xs:attributeGroup ref="attlist.propertyInfoOptional"/> </xs:complexType> @@ -639,7 +639,7 @@ <xs:documentation> Specify a resource and a property to append to any kind of message. </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:complexType mixed="true"> <xs:attributeGroup ref="attlist.propertyInfoOptional"/> </xs:complexType> @@ -648,7 +648,7 @@ <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. + 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"> @@ -658,8 +658,8 @@ <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. + 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> @@ -678,11 +678,11 @@ <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. + 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. + 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> @@ -705,9 +705,9 @@ <xs:element name="result-to-request"> <xs:annotation> <xs:documentation> - result-to-request is event specific. + 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. + 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> @@ -720,7 +720,7 @@ <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. + that's the name of the request attribute that will be created for the value of that result. </xs:documentation> </xs:annotation> </xs:attribute> @@ -748,7 +748,7 @@ <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. + that's the name of the session attribute that will be created for the value of that result. </xs:documentation> </xs:annotation> </xs:attribute> @@ -763,14 +763,14 @@ <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. + 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. + + 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> @@ -837,15 +837,15 @@ <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. - + 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> @@ -859,12 +859,12 @@ <xs:documentation> Name of a properties file on the classpath. </xs:documentation> - </xs:annotation> + </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. + The name of the list in the method environment to check for error messages. Defaults to "error_list". </xs:documentation> </xs:annotation> @@ -873,8 +873,8 @@ <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, + 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> @@ -886,18 +886,18 @@ <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. + 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. + 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:annotation> </xs:attribute> </xs:attributeGroup> <!-- Operations to call Java methods and create Java objects --> @@ -905,14 +905,14 @@ <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. + + 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. + + 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:annotation> <xs:complexType> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="string"> @@ -920,7 +920,7 @@ <xs:documentation> Used to specify an inline String argument to the method call. </xs:documentation> - </xs:annotation> + </xs:annotation> </xs:element> <xs:element ref="field"/> </xs:choice> @@ -933,36 +933,36 @@ <xs:documentation> The name of the field the object is in that has the method to be called. </xs:documentation> - </xs:annotation> + </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: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. + The name of the field to put the result in. + If not specified any return value will be ignored. </xs:documentation> - </xs:annotation> + </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. + + 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. + + 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:annotation> <xs:complexType> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="string"> @@ -970,17 +970,17 @@ <xs:documentation> Used to specify an inline String argument to the method call. </xs:documentation> - </xs:annotation> + </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. + 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:annotation> + </xs:element> </xs:choice> <xs:attributeGroup ref="attlist.call-class-method"/> </xs:complexType> @@ -991,48 +991,48 @@ <xs:documentation> The name of the class to call the static method on. </xs:documentation> - </xs:annotation> + </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: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: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. + 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: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. + 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: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:annotation> </xs:element> </xs:choice> <xs:attributeGroup ref="attlist.create-object"/> @@ -1042,17 +1042,17 @@ <xs:attribute type="xs:string" name="class-name" use="required"> <xs:annotation> <xs:documentation> - The name of the class to construct an object of. + The name of the class to construct an object of. </xs:documentation> - </xs:annotation> + </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. + 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:annotation> </xs:attribute> </xs:attributeGroup> <!-- Operations to copy map fields in the current env to context specific containers --> @@ -1060,8 +1060,8 @@ <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. + 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> @@ -1070,17 +1070,17 @@ </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: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: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. + 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> @@ -1089,7 +1089,7 @@ </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: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> @@ -1098,8 +1098,8 @@ <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). + 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> @@ -1108,12 +1108,12 @@ </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: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. + 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> @@ -1125,8 +1125,8 @@ <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. + 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> @@ -1144,7 +1144,7 @@ <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. + 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> @@ -1153,8 +1153,8 @@ <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). + 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> @@ -1168,7 +1168,7 @@ <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. + 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> @@ -1181,11 +1181,11 @@ </xs:annotation> </xs:attribute> </xs:attributeGroup> - <xs:element name="webapp-property-to-field" substitutionGroup="EventOperations"> + <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). + 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> @@ -1196,8 +1196,8 @@ <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). + 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> @@ -1208,7 +1208,7 @@ <xs:attribute type="xs:string" name="default"> <xs:annotation> <xs:documentation> - A default value to use if the property value is null or empty. + 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> @@ -1224,8 +1224,8 @@ <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. + 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> @@ -1258,7 +1258,7 @@ <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. + 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> @@ -1309,17 +1309,17 @@ 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. + these types before setting it in the target field. </xs:documentation> </xs:annotation> <xs:complexType> @@ -1351,7 +1351,7 @@ <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. + 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> @@ -1360,7 +1360,7 @@ <xs:documentation> Type to convert to. </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:simpleType> <xs:restriction base="xs:token"> <xs:enumeration value="PlainString"/> @@ -1382,10 +1382,10 @@ <xs:attribute name="set-if-null" default="false"> <xs:annotation> <xs:documentation> - Specifies whether or not to set fields that are null or empty. + Specifies whether or not to set fields that are null or empty. Defaults to true. </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:simpleType> <xs:restriction base="xs:token"> <xs:enumeration value="true"/> @@ -1397,14 +1397,14 @@ <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. - + 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:annotation> <xs:simpleType> <xs:restriction base="xs:token"> <xs:enumeration value="true"/> @@ -1413,12 +1413,12 @@ </xs:simpleType> </xs:attribute> </xs:attributeGroup> - <xs:element name="string-append" substitutionGroup="EnvOperations"> + <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. + + 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> @@ -1430,13 +1430,13 @@ <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. + 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. + 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:annotation> </xs:attribute> <xs:attribute type="xs:string" name="string" use="required"> <xs:annotation> @@ -1452,7 +1452,7 @@ 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 @@ -1465,7 +1465,7 @@ <xs:attribute type="xs:string" name="prefix"> <xs:annotation> <xs:documentation> - Used in conjunction with arg-list-name. + Used in conjunction with arg-list-name. String that will be prepended to the string, </xs:documentation> </xs:annotation> @@ -1482,9 +1482,9 @@ <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, + 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 @@ -1517,20 +1517,20 @@ 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. + 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) + To insert a message above a field (used in conjunction with @fieldErrors FTL macro) </xs:documentation> </xs:annotation> </xs:attribute> @@ -1573,7 +1573,7 @@ <xs:documentation> Sets the value of the specified field to null. </xs:documentation> - </xs:annotation> + </xs:annotation> <xs:complexType> <xs:attributeGroup ref="attlist.clear-field"/> </xs:complexType> @@ -1620,10 +1620,10 @@ <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. + 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. + + 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> @@ -1635,7 +1635,7 @@ <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. + 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> @@ -1644,8 +1644,8 @@ <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. + 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> @@ -1656,8 +1656,8 @@ <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". + 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> @@ -1665,8 +1665,8 @@ <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. + 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> @@ -1677,19 +1677,19 @@ <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. + 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: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 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:annotation> <xs:complexType> <xs:attributeGroup ref="attlist.sequenced-id"/> </xs:complexType> @@ -1698,7 +1698,7 @@ <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 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> @@ -1706,19 +1706,19 @@ <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. + 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. + 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. + 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:annotation> <xs:simpleType> <xs:restriction base="xs:token"> <xs:enumeration value="true"/> @@ -1732,8 +1732,8 @@ 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. + 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> @@ -1741,7 +1741,7 @@ <xs:element name="make-next-seq-id" substitutionGroup="EntityMiscOperations"> <xs:annotation> <xs:documentation> - sequenced-id is the primary key sequencer. + 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 @@ -1762,11 +1762,11 @@ 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. + just use the entity name for these primary sequences. </xs:documentation> </xs:annotation> </xs:attribute> @@ -1775,7 +1775,7 @@ <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 + 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> @@ -1783,7 +1783,7 @@ <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, + 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> @@ -1806,12 +1806,12 @@ 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. + set of data exists in the database. </xs:documentation> </xs:annotation> <xs:complexType> @@ -1829,21 +1829,21 @@ <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. + 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. + 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. + The name of the list in the method environment to check for error messages. Defaults to "error_list". </xs:documentation> </xs:annotation> @@ -1868,7 +1868,7 @@ <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. + add a message to the error list about not having found it. </xs:documentation> </xs:annotation> </xs:enumeration> @@ -1879,7 +1879,7 @@ <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 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-name. </xs:documentation> </xs:annotation> @@ -1907,13 +1907,13 @@ <xs:documentation> The name of the method environment field that will contain the GenericValue object. </xs:documentation> - </xs:annotation> + </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. + 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> @@ -1928,7 +1928,7 @@ <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. + 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> @@ -1937,7 +1937,7 @@ <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 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> @@ -1949,7 +1949,7 @@ <xs:attribute type="xs:string" name="entity-name" use="required"> <xs:annotation> <xs:documentation> - The name of the entity to find instances of. + The name of the entity to find instances of. </xs:documentation> </xs:annotation> </xs:attribute> @@ -1964,16 +1964,16 @@ <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. + 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. + 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> @@ -1981,22 +1981,22 @@ <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. + 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: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. [... 2028 lines stripped ...] |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |