com.sri.emo.wizard.defaults
Class EmoWizardMetadata

java.lang.Object
  com.sri.emo.wizard.defaults.EmoWizardMetadata

All Implemented Interfaces:

PageMetadata, Serializable

Direct Known Subclasses:

CustomPartHandlerMetadata, CustomPartHandlerMetadata, InitializationPageMetadata, MinMaxPageMetadata, MinMaxPageMetadata

public class EmoWizardMetadata
extends Object
implements PageMetadata, Serializable

Wizard Metadata instance.

Author:

Michael Rimov

See Also:

Serialized Form

Constructor Summary

EmoWizardMetadata()
Constructor that takes constructed links.

Method Summary

boolean	equals(Object parm1) Override of equals().
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 the view id.
int	hashCode() Override of Hashcode().
boolean	isEntry()
boolean	isEntryRequired() Retrurn false if the user can skip a step without entering anything.
boolean	isHasEntry() Set to true if there is some sort of entry to occur on a page.
void	setCancelLink(Link cancelLink)
void	setDirective(String directive) Sets the directive string.
void	setEntry(boolean entry) True if there is data entry for this page.
void	setEntryRequired(boolean entryRequired) Sets whether the data entry is required or not.
void	setFinishLink(Link finishLink)
void	setHelpText(String helpText) Sets the help text.
void	setNextLink(Link nextLink)
void	setPreviousLink(Link previousLink)
void	setTitle(String title) Sets the title.
void	setViewId(String newId) Set the view id.
String	toString() Override of toString().

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EmoWizardMetadata

public EmoWizardMetadata()

Constructor that takes constructed links.

Method Detail

setCancelLink

public void setCancelLink(Link cancelLink)

setFinishLink

public void setFinishLink(Link finishLink)

setNextLink

public void setNextLink(Link nextLink)

setPreviousLink

public void setPreviousLink(Link previousLink)

getFinish

public Link getFinish()

Description copied from interface: PageMetadata

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

Specified by:

getFinish in interface PageMetadata

Returns:

Link instance for 'finish' operations.

getNext

public Link getNext()

Description copied from interface: PageMetadata

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

Specified by:

getNext in interface PageMetadata

Returns:

Link instance for 'next' operations.

getPrevious

public Link getPrevious()

Description copied from interface: PageMetadata

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

Specified by:

getPrevious in interface PageMetadata

Returns:

Link instance for 'previous' operations.

getCancel

public Link getCancel()

Description copied from interface: PageMetadata

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

Specified by:

getCancel in interface PageMetadata

Returns:

Link instance for 'cancel' operations.

getTitle

public String getTitle()

Description copied from interface: PageMetadata

Return the page title.

Specified by:

getTitle in interface PageMetadata

Returns:

java.lang.String

getDirective

public String getDirective()

Description copied from interface: PageMetadata

Get the page directions.

Specified by:

getDirective in interface PageMetadata

Returns:

java.lang.String.

getHelpText

public String getHelpText()

Description copied from interface: PageMetadata

Get the page help text.

Specified by:

getHelpText in interface PageMetadata

Returns:

java.lang.String

isEntry

public boolean isEntry()

setDirective

public void setDirective(String directive)

Sets the directive string.

Parameters:

directive - the new value.

setHelpText

public void setHelpText(String helpText)

Sets the help text.

Parameters:

helpText - the new value.

setTitle

public void setTitle(String title)

Sets the title.

Parameters:

title - the new value.

setEntry

public void setEntry(boolean entry)

True if there is data entry for this page.

Parameters:

entry - boolean

setEntryRequired

public void setEntryRequired(boolean entryRequired)

Sets whether the data entry is required or not.

Parameters:

entryRequired - boolean

equals

public boolean equals(Object parm1)

Override of equals(). This version does not check equality of the links.

Overrides:

equals in class Object

Parameters:

parm1 - the other object to check.

Returns:

true if the objects appear equal.

setViewId

public void setViewId(String newId)

Set the view id.

Parameters:

newId - String

getViewId

public String getViewId()

Retrieve the view id. Defaults to null. May specify a special type of view handling for a given page.

Specified by:

getViewId in interface PageMetadata

Returns:

String

toString

public String toString()

Override of toString().

Overrides:

toString in class Object

Returns:

String

hashCode

public int hashCode()

Override of Hashcode().

Overrides:

hashCode in class Object

Returns:

integer

isHasEntry

public boolean isHasEntry()

Set to true if there is some sort of entry to occur on a page.

Specified by:

isHasEntry in interface PageMetadata

Returns:

boolean

isEntryRequired

public boolean isEntryRequired()

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

Specified by:

isEntryRequired in interface PageMetadata

Returns:

boolean true/false