package org.litesoft.GWT.forms.client;

import org.litesoft.rpcpassable.*;

public interface UiFormListener
{
    /**
     * Called when the form has fields and is added to the target container. You
     * will typically call {@link UiFormHandler#requestValues(String)} to ensure
     * the back end has started a transaction.
     */
    public void formRendered( UiFormHandler pUiFormHandler, RPCpassable pServicePeerXtra );

    /**
     * Called after the form is fully populated with values from the back end.
     */
    public void formValuesApplied( UiFormHandler pUiFormHandler, RPCpassable pServicePeerXtra );

    /**
     * Called when the form ErrorState changes.
     *
     * @param pFormHasErrors <code>true</code> if the form currently has errors
     */
    public void formErrorState( UiFormHandler pUiFormHandler, boolean pFormHasErrors );

    /**
     * Called when the form is modified (dirty) or set to a clean state.
     *
     * @param pFormHasChanges <code>true</code> if the committing the form
     *                        will result in a change on the back end
     */
    public void formChangeState( UiFormHandler pUiFormHandler, boolean pFormHasChanges );

    /**
     * Called when an action (i.e. button) on the form has been requested
     * (clicked). Allows you to veto the action to prevent it from being
     * executed on the back end.
     *
     * @return <code>true</code> to veto the Action
     */
    public boolean formActionRequested( UiFormHandler pUiFormHandler, String pActionID );

    /**
     * Called by the form service to indicate the Service Peer Successfully processed an ActionRequest.
     */
    public void formActionSucceeded( UiFormHandler pUiFormHandler, String pActionID, // todo: boolean pDataCommitted,
                                     RPCpassable pServicePeerXtra );

    /**
     * Called by the form service to indicate the form UI should be disposed.
     */
    public void formCloseRequested( UiFormHandler pUiFormHandler, RPCpassable pServicePeerXtra );
}