com.sri.emo.wizard
Interface PageMetadata

All Known Subinterfaces:

CreationMetadata, InternalPageMetadata

All Known Implementing Classes:

CreationPageMetadata, CustomPartHandlerMetadata, CustomPartHandlerMetadata, EmoWizardMetadata, InitializationPageMetadata, MinMaxPageMetadata, MinMaxPageMetadata, MultiEntryMetadata, MultiEntryMetadata, RelationPageMetadata

public interface PageMetadata

Metadata for any wizard page.

Author:

Michael Rimov

Method Summary

Link	getCancel() Return link instance, NullLink if there is no finish link on this page.
String	getDirective() Get the page directions.
Link	getFinish() Return link instance, NullLink if there is no finish link on this page.
String	getHelpText() Get the page help text.
Link	getNext() Return link instance, NullLink if there is no finish link on this page.
Link	getPrevious() Return link instance, NullLink if there is no finish link on this page.
String	getTitle() Return the page title.
String	getViewId() Retrieve a view id that corresponds to Struts/JSF/whatever special view.
boolean	isEntryRequired() Retrurn false if the user can skip a step without entering anything.
boolean	isHasEntry() Set to true if the page has text entry.

Method Detail

getFinish

Link getFinish()

Return link instance, NullLink if there is no finish link on this page.

Returns:

Link instance for 'finish' operations.

getNext

Link getNext()

Return link instance, NullLink if there is no finish link on this page.

Returns:

Link instance for 'next' operations.

getPrevious

Link getPrevious()

Return link instance, NullLink if there is no finish link on this page.

Returns:

Link instance for 'previous' operations.

getCancel

Link getCancel()

Return link instance, NullLink if there is no finish link on this page.

Returns:

Link instance for 'cancel' operations.

getTitle

String getTitle()

Return the page title.

Returns:

java.lang.String

getDirective

String getDirective()

Get the page directions.

Returns:

java.lang.String.

getHelpText

String getHelpText()

Get the page help text.

Returns:

java.lang.String

isHasEntry

boolean isHasEntry()

Set to true if the page has text entry.

Returns:

boolean true if there should be some sort of entry on the page, whether menu, text, or otherwise. If a page's menu is null and hasEntry() is true, then there should be a text box on the page.

isEntryRequired

boolean isEntryRequired()

Retrurn false if the user can skip a step without entering anything.

Returns:

boolean true/false

getViewId

String getViewId()

Retrieve a view id that corresponds to Struts/JSF/whatever special view. Most of the time this will be null. Otherwise the executor of the wizard (ie contorller) should consider the results listed here when it comes to rendering the page.

Returns:

String