Table of Contents
Table of Contents |
---|
Related Documents
...
Documents
...
Introduction
The Open For Business JSP Tag Library consists of a set of custom tags that make it easier to use other components of the OFBiz Core Framework.
...
Attribute Name | Required? | ExprVal? | Description |
---|---|---|---|
field | Y | N | The name of the field to print in the named entity. |
param | N | N | The name of the URL parameter that corresponds to this value. If null or empty param will be the same as field. |
entityAttr | Y | N | The name of the attribute that contains the entity that contains the field to print. |
tryEntityAttr | Y | N | The name of an context attribute that contains a Boolean which specifies whether or not to even try using the named entity. If false the request parameter value will be used, if true the entity field value will be used. |
default | N | Y | The default value to print if the specified entity field or parameter is not found. |
fullattrs | N | N | If fullattrs is set to true then [name="{param}" value="{value}"] will be output instead of just [value]. By default fullattrs is false. |
Internationalization Tags
Used to specify and load an internationalized message bundle. The bundle will be referred to by the id attribute value if specified. By default all messages will be retreived from the bundle specified by their parent i18nBundle tag, in other words the i18nMessage tags will be nested inside the bundle tag.
...
Attribute Name | Required? | ExprVal? | Description |
---|---|---|---|
value | Y | Y | The value of the argument to insert into the message. Can use the <%=...%> syntax to use Java method context variables. |
Service Tags
The service tag invokes the named service using the given mode (sync or async). The results can be placed in the page, request, session or application scope as specified using the resultTo attribute. The default scope is page.
To specify information about parameters and return values use nested param tags. They are described below.
For more information on services see the Service Engine Guide and the Service Engine Configuration Guide.
Attribute Name | Required? | ExprVal? | Description |
---|---|---|---|
name | Y | Y | The name of the service to call. |
mode | N | Y | The mode that will be used to call the service, either synchronous or asynchronous. Must be sync or async, Defaults to sync. |
resultTo | N | Y | Specifies the scope that the results should be put into. The OUT attributes/parameters of the service will be put into attributes in this scope. Must be page, request, session or application. Defaults to page. |
The param tag is used to specify information about parameters passed to the service and can also be used for spcifying certain information about return values.
Attribute Name | Required? | ExprVal? | Description |
---|---|---|---|
name | Y | Y | The name of the service parameter. |
value | N | Y | The value to assign to an IN parameter. Can use the <%=...%> syntax to use Java method context variables. |
mode | N | Y | Specifies the mode of the parameter. Must be IN, OUT or INOUT. Defaults to IN. If OUT or INOUT the alias attribute can be used to override the default key for the context attribute in the scope specified in the service tag. |
map | N | Y | Specifies a name for a Map to find in a context attribute. If specified the attribute attribute will be used to find a value in this map. If not specified the attribute attribute will be used to lookup a value in a context attribute. |
attribute | N | Y | Specifies the name of the attribute value to lookup. This is used INSTEAD of the value attribute which is used to directly specify the value to be passed to the service for this parameter. The looked up attribute value will be passed to the service for this parameter. |
alias | N | Y | Used to specify the key that will be used when putting OUT or INOUT parameters into a context attribute. Defaults to the value of the name attribute. |
Other Tags
...
Makes an Object in a context attribute (page, request, session or application) available in the Java method context of the JSP so it can be used in Java scriptlets, etc.
Attribute Name | Required? | ExprVal? | Description |
---|---|---|---|
name | Y | N | The name of the Java method context variable to create. |
property | N | N | The name of the context attribute to attach the value to. If not specified will be the same as name. |
type | N | N | The Java type of the object. If not specified defaults to org.ofbiz.entity.GenericValue. |