Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column
width20%
<simple-method>
Column
Contains a block of code.

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.

Code Block
xml
xml
<simple-method method-name="fooMethod">
  <!-- some mini-language code goes here -->
</simple-method>

Attributes

Name

Type

Requirements

Description

Note

method-name

constant

required

A name (preferably a legal Java identifier) for this method.

Each simple method in a file must have a unique name.

short-description

constant

optional

A short description of the method.

Used for documentation.

login-required

constant

optional

Require a user login to run this method.

Defaults to "true".

use-transaction

constant

optional

Create a transaction if none exists for this thread.

Defaults to "true".

default-error-code

constant

optional

The default error return code.

Defaults to "error".

default-success-code

constant

optional

The default success return code.

Defaults to "success".

event-request-object-name

constant

optional

The name of the field containing the javax.servlet.ServletRequest object.

Defaults to "request".

event-response-object-name

constant

optional

The name of the field containing the javax.servlet.ServletResponse object.

Defaults to "response".

event-session-object-name

constant

optional

The name of the field containing the javax.servlet.http.HttpSession object.

Defaults to "session".

event-response-code-name

constant

optional

The name of the field containing the event response code.

Defaults to "_response_code_".

event-error-message-name

constant

optional

The name of the field containing the event error message.

Defaults to "_error_message_".

event-error-message-list-name

constant

optional

The name of the field containing the event message list.

Defaults to "_error_message_list_".

event-event-message-name

constant

optional

The name of the field containing the event message.

Defaults to "_event_message_".

event-event-message-list-name

constant

optional

The name of the field containing the event message list.

Defaults to "_event_message_list_".

service-response-message-name

constant

optional

The name of the field containing the service response message.

Defaults to "responseMessage".

service-error-message-name

constant

optional

The name of the field containing the service error message.

Defaults to "errorMessage".

service-error-message-list-name

constant

optional

The name of the field containing the service error message list.

Defaults to "errorMessageList".

service-error-message-map-name

constant

optional

The name of the field containing the service error message map.

Defaults to "errorMessageMap".

service-success-message-name

constant

optional

The name of the field containing the service success message.

Defaults to "successMessage".

service-success-message-list-name

constant

optional

The name of the field containing the service success message list.

Defaults to "successMessageList".


Note
titleDraft Status

Final draft.


...

Section
Column
width20%
<order-map-list>
Column
Sorts a list of maps.

Maps are sorted by the keys specified in the order<order-by by> sub-elements.

Code Block
xml
xml
<order-map-list list="fooList">
    <order-by field="fooKey" />
</order-map-list>

Attributes

Name

Type

Requirements

Description

Note

list

expression

required

The name of the list to be sorted.

Operation does nothing if the list is not found.


Child Elements

Name

Requirements

 

<order-by>

required

(question)


Note
titleDraft Status

Final draft.


...