com.portal.app.cc.comp

Interface PWizardPage

All Superinterfaces:

PCCPage

All Known Implementing Classes:

PBillingPage, PCAConsumerPaymentPanel, PCAEmptyProfilePanel, PContactPage, PCreditLimitPage, PCustomizeProductsPanel, PGeneralPage, PIACAPaymentPanel, PIACAProfilePanel, PMapInfoPage, PNewServicePage, PPaymentWizard, PPlanOptionsPage, PPurchasePanel, PRolloverTransferPanel, PSubscriberPrefsPage

public interface PWizardPage
extends PCCPage

The common methods for all Customer Center wizard pages. Every page displayed in the Customer Center wizard must implement this interface.

Method Summary

Modifier and Type	Method and Description
void	collectData(PCollectDataEvent event) Called by the wizard framework to collect data from this page in preparation for committing data to the database and (if the page elects to have the wizard framework do partial validation on its behalf) in preparation for partial data validation.
String	getWizardHelpID() Returns the Help ID for this wizard page.
boolean	handleWizardCommitError(com.portal.app.util.CustomerError error) Called on each wizard page successively if an attempt to commit the wizard data failed.
void	leavingPage() Called before the wizard actually leaves the current page.
void	validateWizardPage() Validates this page.

Methods inherited from interface com.portal.app.cc.comp.PCCPage

enteringPage, getLabel, recycle

Method Detail

collectData

void collectData(PCollectDataEvent event)

Called by the wizard framework to collect data from this page in preparation for committing data to the database and (if the page elects to have the wizard framework do partial validation on its behalf) in preparation for partial data validation.

Parameters:

event - The collect data event containing a model handle to which data will be added.

See Also:

validateWizardPage

getWizardHelpID

String getWizardHelpID()

Returns the Help ID for this wizard page.

leavingPage

void leavingPage()
          throws PropertyVetoException

Called before the wizard actually leaves the current page. If for some reason the implementing page does not want the wizard to leave the page, it should throw a PropertyVetoException.

Throws:

PropertyVetoException

validateWizardPage

void validateWizardPage()
                 throws PValidationException

Validates this page. If an error is found and the user wishes to fix it right away, a PValidationException will be thrown. (The page could validate the data itself, use wizard framework convenience methods to do validation, or do some validation itself and defer some validation work to the framework.)

Throws:

PValidationException

See Also:

WizardValidationManager

handleWizardCommitError

boolean handleWizardCommitError(com.portal.app.util.CustomerError error)

Called on each wizard page successively if an attempt to commit the wizard data failed. If a page returns true from this method, the method will not be called on the remaining pages. If the error "belongs" to a page (that is, the page determines that the user should be able to fix the error on this page) true will be returned. Otherwise it will return false. (The page could itself check for ownership of the error, use a wizard framework convenience method to do this on its behalf, or do some checking itself for error ownership and and defer some of the work to the framework.)

Parameters:

error - The commit-time error.

Returns:

true if the page will handle the error; otherwise false.

See Also:

WizardValidationManager