atg.droplet
Interface DropletFormHandler
- All Known Implementing Classes:
- AbandonedOrderFormHandler, AdminFormHandler, AdminLoginFormHandler, ApprovalFormHandler, B2BCommerceProfileFormHandler, B2BRepositoryFormHandler, B2BShoppingCartFormHandler, B2CEmailFormHandler, B2CProfileFormHandler, B2CSearchFormHandler, BaseSearchFormHandler, BrowseFormHandler, CancelOrder, CancelOrderFormHandler, CartModifierFormHandler, CatalogSearchFormHandler, CategorizeFormHandler, ColorPaletteFormHandler, CommerceProfileFormHandler, CommitOrderFormHandler, CommunityFormHandler, CommunityPrincipalFormHandler, CompareSkusFormHandler, CostCenterFormHandler, CouponFormHandler, CreateCreditCardFormHandler, CreateOrganizationFormHandler, DateEditor, DBCopyFormHandler, EmailFormHandler, EmptyFormHandler, ExpressCheckoutFormHandler, FilterFormHandler, FilteringSearchFormHandler, FolderFormHandler, ForgotPasswordHandler, FullShoppingCartFormHandler, GearConfigFormHandler, GearDefinitionFormHandler, GearTemplateFormHandler, GenericFormHandler, GiftlistFormHandler, InventoryFormHandler, MultipleSubmitHelper, MultiProfileAddFormHandler, MultiProfileForm, MultiProfileUpdateFormHandler, MultiUserAddFormHandler, MultiUserUpdateFormHandler, OrderModifierFormHandler, OrderStatusFormHandler, PageColorFormHandler, PagedRequestFormHandler, PageFormHandler, PageGearsFormHandler, PageLayoutFormHandler, PageTemplateFormHandler, PartsFilterFormHandler, PaymentGroupFormHandler, PortalGenericFormHandler, PortalProfileAdminFormHandler, ProductListHandler, atg.userprofiling.ProfileAdminFormHandler, ProfileForm, ProfileFormHandler, PurchaselistFormHandler, PurchaselistFormHandlerSuper, PurchaseProcessFormHandler, QueryFormHandler, RepositoryAssetFormHandler, RepositoryFormHandler, SaveOrderFormHandler, ScenarioProfileFormHandler, ScheduledOrderHandler, SearchFormHandler, SearchFormHandler, SearchFormHandler, ShippingGroupFormHandler, ShippingGroupUpdateFormHandler, ShoppingCartFormHandler, SimilarDocsFormHandler, SimpleSQLFormHandler, SoftGoodFormHandler, SQLTableManager, StructuredQueryFormHandler, StyleFormHandler, SwitchDataSourceFormHandler, TransactionalFormHandler, TreeQueryFormHandler, TypeAheadFormHandler, UpdateShippingGroupFormHandler, ViewDocumentFormHandler, WorkflowTaskFormHandler, WorkflowTaskFormSubject, XMLRepositoryFormHandler
public interface DropletFormHandler
Method Summary |
void |
afterGet(DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
Called after page rendering has complete for any form handlers
whose beforeGet method was called. |
boolean |
afterSet(DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
Called after all form arguments have been submitted, before the
page is serviced (or rendered). |
void |
beforeGet(DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
Called before any attempts to get values of this bean by valueof
or input tags. |
boolean |
beforeSet(DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
Called when a form is submitted that references this bean before any set
methods have been called, i.e. |
void |
handleFormException(DropletFormException exception,
DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
This is called if an exception occurred when getting or setting
the values of the form. |
void |
handleUncheckedFormException(java.lang.Throwable exception,
DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
This is called if an unchecked exception occurred when getting or setting
the values of the form. |
CLASS_VERSION
static final java.lang.String CLASS_VERSION
- See Also:
- Constant Field Values
beforeSet
boolean beforeSet(DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
throws DropletFormException
- Called when a form is submitted that references this bean before any set
methods have been called, i.e. first thing in processing the form data.
If multiple form handlers exist for the same form, they are called
in an order based on the priority of the input tag that references
the form.
- Returns:
- true if form processing should continue and the requested
URL should be served, false if it should be aborted. If false is
returned, you typically have already completed the request
with a redirect or by sending output to the output stream.
- Throws:
DropletFormException
afterSet
boolean afterSet(DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
throws DropletFormException
- Called after all form arguments have been submitted, before the
page is serviced (or rendered). If the a form is submitted to the
same page it is rendered, this method is called before the beforeGet
method of the DropletFormHandler.
This method is suitable for doing form submit processing on forms
that do not have a submit button (i.e. have only a single text field)
or for cleaning up after the form has been submitted.
- Returns:
- true if request processing should continue and the requested
URL should be served, false if it should be aborted. If false is
returned, you typically have already completed the request
with a redirect or by sending output to the output stream.
- Throws:
DropletFormException
beforeGet
void beforeGet(DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
- Called before any attempts to get values of this bean by valueof
or input tags. If form data is processed during the same request, it
will be called after all form data has been processed.
afterGet
void afterGet(DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
- Called after page rendering has complete for any form handlers
whose beforeGet method was called.
This method is suitable for releasing any resources obtained during
the processing of the request, logging of the operation performed,
etc.
handleFormException
void handleFormException(DropletFormException exception,
DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
- This is called if an exception occurred when getting or setting
the values of the form. This method is called once
for each exception that occurs when processing the setX method.
handleUncheckedFormException
void handleUncheckedFormException(java.lang.Throwable exception,
DynamoHttpServletRequest request,
DynamoHttpServletResponse response)
- This is called if an unchecked exception occurred when getting or setting
the values of the form. This method is called once
for each exception that occurs when processing the setX, getX or handle
method.