org.apache.shale.dialog.scxml.config
Class DialogMetadata

java.lang.Object
  org.apache.shale.dialog.scxml.config.DialogMetadata

All Implemented Interfaces:

Serializable

public class DialogMetadata
extends Object
implements Serializable

Bean encapsulating metadata for a Shale dialog when using Commons SCXML to drive the underlying state machine.

This includes:

• The logical name of this dialog.
• The document location where Commons SCXML can find the SCXML document describing this dialog.
• The Commons SCXML object model for this dialog obtained by parsing the above document.
• The dialog data class name, an instance of which will be set as dialog data once an instance of this dialog is started.
• A list of Commons SCXML custom actions, that will be defined for this dialog.

WARNING - These classes should ONLY be used by the dialog framework infrastructure. They are NOT meant to be used by the application.

Since:

1.0.4 $Id: DialogMetadata.java 491384 2006-12-31 04:43:49Z rahul $

See Also:

Serialized Form

Nested Class Summary

static class

DialogMetadata.SCXMLAction A POJO representing the bits of a custom Commons SCXML action used in a Shale dialog.

Constructor Summary

DialogMetadata()
Constructor.

Method Summary

void	addDialogAction(DialogMetadata.SCXMLAction scxmlAction) Add this Commons SCXML custom action for this specific dialog.
String	getDataclassname() Get the data class FQN.
List	getDialogActions() Get the list of dialog actions defined for this specific dialog.
String	getName() Get the dialog name.
String	getScxmlconfig() Get the location where the SCXML document for this dialog resides.
org.apache.commons.scxml.model.SCXML	getStateMachine() Get the Commons SCXML object model describing the state machine for this dialog.
void	setDataclassname(String dataclassname) Set the data class FQN.
void	setName(String name) Set the dialog name.
void	setScxmlconfig(String scxmlconfig) Set the location where the SCXML document for this dialog resides.
void	setStateMachine(org.apache.commons.scxml.model.SCXML stateMachine) Set the Commons SCXML object model describing the state machine for this dialog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DialogMetadata

public DialogMetadata()

Constructor.

Method Detail

getName

public String getName()

Get the dialog name.

Returns:

Returns the dialog name.

setName

public void setName(String name)

Set the dialog name.

Parameters:

name - The dialog name.

getDataclassname

public String getDataclassname()

Get the data class FQN.

Returns:

Returns the dataclassname.

setDataclassname

public void setDataclassname(String dataclassname)

Set the data class FQN.

Parameters:

dataclassname - The data class FQN.

getScxmlconfig

public String getScxmlconfig()

Get the location where the SCXML document for this dialog resides.

Returns:

Returns the scxmlconfig.

setScxmlconfig

public void setScxmlconfig(String scxmlconfig)

Set the location where the SCXML document for this dialog resides.

Parameters:

scxmlconfig - The SCXML dialog configuration file location.

getStateMachine

public org.apache.commons.scxml.model.SCXML getStateMachine()

Get the Commons SCXML object model describing the state machine for this dialog.

Returns:

Returns the stateMachine.

setStateMachine

public void setStateMachine(org.apache.commons.scxml.model.SCXML stateMachine)

Set the Commons SCXML object model describing the state machine for this dialog.

Parameters:

stateMachine - The stateMachine to set.

addDialogAction

public void addDialogAction(DialogMetadata.SCXMLAction scxmlAction)

Add this Commons SCXML custom action for this specific dialog.

Parameters:

scxmlAction - The SCXMLAction to be added.

getDialogActions

public List getDialogActions()

Get the list of dialog actions defined for this specific dialog.

Returns:

Returns the list of DialogActions.