com.sri.emo.wizard
Interface WizardPage

All Known Implementing Classes:

CompletionPartsPage, CreationPartsPage, CustomPartHandlerPage, CustomPartHandlerPage, DisplaySummaryPage, EmoDebugWizardPage, EmoWizardPage, MultiEntryWizardPage, MultiEntryWizardPage, NameNodePage, RelationWizardPage, RelationWizardPage, SearchListPage

public interface WizardPage

Interface for a wizard page.

Author:

Michael Rimov

Method Summary

void	addError(String message) Adds an error to be associated with the current page.
Serializable	getData() Retrieve the data associated with the page.
Serializable	getId() Every page must have an id that is serializable.
ValidValue[]	getMenu() Retrieve the picklist value for the map.
PageMetadata	getMetadata() Retrieve the metadata associated with the page.
ErrorCollection	getPageErrors() Retrieve an error collection (if any) that is associated with this page.
String	getPrintableData() Retrieve the data in a printable fashion.
void	removeErrors() Clear all errors associated with the page.
void	setData(Serializable newData) Sets the data associated with the page.

Method Detail

getId

Serializable getId()

Every page must have an id that is serializable.

Returns:

Serializable.

getData

Serializable getData()

Retrieve the data associated with the page.

Returns:

the data instance

getPrintableData

String getPrintableData()

Retrieve the data in a printable fashion. (For labels, etc.)

Returns:

String

setData

void setData(Serializable newData)
             throws WizardException

Sets the data associated with the page.

Parameters:

newData - the new data for the page.

Throws:

WizardException - upon error.

getMetadata

PageMetadata getMetadata()

Retrieve the metadata associated with the page.

Returns:

PageMetadata instance.

getMenu

ValidValue[] getMenu()

Retrieve the picklist value for the map.

Returns:

ValidValue[]

getPageErrors

ErrorCollection getPageErrors()

Retrieve an error collection (if any) that is associated with this page. May return null if there are no errors.

Returns:

ErrorCollection

removeErrors

void removeErrors()

Clear all errors associated with the page.

addError

void addError(String message)

Adds an error to be associated with the current page.

Parameters:

message - String