com.acsinet_solutions.cetia4.controller.meta
Annotation Type FormAttribute

@Documented
@Retention(value=RUNTIME)
@Target(value=METHOD)
@Inherited
public @interface FormAttribute

This annotation indicates a form attribute that will be setup upon entering a form using the setFormAttribute() method of RequestContext and cleared when the form is abandoned ( detected automatically by the navigation manager or similar object ). It also indicates upon which bean a cetia:form bean will operate. In the current page, it also indicates the default attribute from which beans are being mapped, unless overriden by a complementary FormAttribute annotation in the given action methods. This annotation is only useful on methods that lead to a single edition form.

Author:

Santiago Arriaga

Required Element Summary

java.lang.String

value The name of the attribute stored at the scope set in the scope attribute.

Optional Element Summary

AttributeMaintenancePolicy	maintenancePolicy Sets the attribute maintenance policy, using the default policy if not specified.
Scope	scope The scope of the attribute.

Element Detail

value

public abstract java.lang.String value

The name of the attribute stored at the scope set in the scope attribute.

scope

public abstract Scope scope

The scope of the attribute. Default is session for servlet and portlet scope in portlets. May be set to request. Application is supported but generally not recommended.

Default:

COMPONENT_SCOPE

maintenancePolicy

public abstract AttributeMaintenancePolicy maintenancePolicy

Sets the attribute maintenance policy, using the default policy if not specified. The type is used to interpret default policies; if type is known and subclass of PagedSearchFilter, the policy will be GLOBAL; otherwise, the policy will be NESTED. if type is unknown, even if later turns to be a PagedSearchFilter, the policy will be set to NESTED, so explicit settings will be needed for FormAttribute annotations in these cases.

See Also:

AttributeInfo.getMaintenancePolicy(FormAttribute)

Default:

DEFAULT