com.bowstreet.webapp
Interface ActionList

All Superinterfaces:

IExemplar, WebAppObject

public interface ActionList
extends WebAppObject

Class that represents an ActionList

Field Summary

static java.lang.String

SYSTEMOUT_ACTION_KEY

Fields inherited from interface com.bowstreet.webapp.WebAppObject

ALWAYS_VISIBLE, INFORMATION_PROPERTY, NEVER_VISIBLE, SOMETIMES_VISIBLE

Method Summary

ActionListAction	addAction(int index, java.lang.String actionType, java.lang.String name) Adds an action to an ActionList at the specified position in this list.
ActionListAction	addAction(java.lang.String name) Adds an action (Page, Method, or ActionList) to an ActionList.
ActionListAction	addAction(java.lang.String actionType, java.lang.String name) Adds an action to an ActionList.
ActionListAction	addActionListAction(java.lang.String actionListName) Adds an ActionList action to an ActionList.
void	addArgument(java.lang.String name, java.lang.String type) Adds an argument to the method.
ActionListAction	addAssignmentAction(java.lang.String name, java.lang.String source) Adds an assignment action to an ActionList.
ActionListAction	addAssignmentAction(java.lang.String name, java.lang.String source, boolean append) Adds an assignment action to an ActionList.
ActionListAction	addCodeAction(java.lang.String code) Adds a Code action to an ActionList.
ActionListAction	addCommentAction(java.lang.String comment) Adds a Comment action to an ActionList.
ActionListAction	addConditionalAction(java.lang.String type) Adds a Conditional action to an ActionList.
ActionListAction	addMethodAction(java.lang.String methodName) Adds a Method action to an ActionList.
ActionListAction	addPageAction(java.lang.String pageName) Adds a Page action to an ActionList.
ActionListAction	addReturnAction(java.lang.String source) Adds a return action to an ActionList.
java.util.Iterator	getActions() Gets an iterator of all the actions in this list.
java.util.Iterator	getArguments() Gets list of arguments and their types.
java.lang.String	getReturnType() Gets Action List return type.
java.lang.String	getSchemaPath() Get schemaPath associated with a method that returns IXml (null if not XML)
int	getSize() Returns the number of actions in this list.
void	setReturnType(java.lang.String type) Sets Action List return type.
void	setSchemaPath(java.lang.String schemaPath) Set the schemaPath for a method that returns IXml.

Methods inherited from interface com.bowstreet.webapp.WebAppObject

clone, getBuilderCall, getName, getProperties, getProperty, getVisibility, isHidden, putProperty, setBuilderCall, setHidden, setName, setVisibility

Methods inherited from interface com.bowstreet.util.IExemplar

newInstance

Field Detail

SYSTEMOUT_ACTION_KEY

static final java.lang.String SYSTEMOUT_ACTION_KEY

See Also:

Constant Field Values

Method Detail

addAction

ActionListAction addAction(int index,
                           java.lang.String actionType,
                           java.lang.String name)

Adds an action to an ActionList at the specified position in this list.

Parameters:

index - - index at which the specified action is to be inserted.

actionType - Type of action - ActionListAction.PAGE, etc.

name - The name of the action, e.g. Page name or method name

Returns:

ActionListAction holding the new action.

Throws:

java.lang.IndexOutOfBoundsException - - if index is out of range (index < 0 || index > size()).

addAction

ActionListAction addAction(java.lang.String name)

Adds an action (Page, Method, or ActionList) to an ActionList.

Parameters:

name - The name of the action, e.g. Page name or method name

Returns:

ActionListAction holding the new action.

addAction

ActionListAction addAction(java.lang.String actionType,
                           java.lang.String name)

Adds an action to an ActionList.

Parameters:

actionType - Type of action - ActionListAction.PAGE, etc.

name - The name of the action, e.g. Page name or method name

Returns:

ActionListAction holding the new action.

addActionListAction

ActionListAction addActionListAction(java.lang.String actionListName)

Adds an ActionList action to an ActionList.

Parameters:

actionListName - The name of the ActionList to call

Returns:

ActionListAction holding the new action.

addArgument

void addArgument(java.lang.String name,
                 java.lang.String type)

Adds an argument to the method. Note - While this method is available to the Builders at generation time there is no support in the Factory WebApp runtime for generating artifacts related to it.

Parameters:

name - The name of the argument.

type - The argument java type.

addAssignmentAction

ActionListAction addAssignmentAction(java.lang.String name,
                                     java.lang.String source)

Adds an assignment action to an ActionList. Note - While this method is available to the Builders at generation time there is no support in the Factory WebApp runtime for generating artifacts related to it.

Parameters:

name - The variable name to assign to

source - The source of the assignment

Returns:

ActionListAction holding the new action.

addAssignmentAction

ActionListAction addAssignmentAction(java.lang.String name,
                                     java.lang.String source,
                                     boolean append)

Adds an assignment action to an ActionList. Note - While this method is available to the Builders at generation time there is no support in the Factory WebApp runtime for generating artifacts related to it.

Parameters:

name - The variable name to assign to

source - The source of the assignment

append - Specifies if the assignment should do an append to the target object.

Returns:

ActionListAction holding the new action.

addCodeAction

ActionListAction addCodeAction(java.lang.String code)

Adds a Code action to an ActionList.

Parameters:

code - Java source code to be inserted directly into the method built for the action list.

Returns:

ActionListAction holding the new action.

addCommentAction

ActionListAction addCommentAction(java.lang.String comment)

Adds a Comment action to an ActionList. Note - While this method is available to the Builders at generation time there is no support in the Factory WebApp runtime for generating artifacts related to it.

Parameters:

comment - The comment to add.

Returns:

ActionListAction holding the new action.

addConditionalAction

ActionListAction addConditionalAction(java.lang.String type)

Adds a Conditional action to an ActionList. Note - While this method is available to the Builders at generation time there is no support in the Factory WebApp runtime for generating artifacts related to it.

Parameters:

type - The conditional type IF (condition), ELSE, ENDIF.

Returns:

ActionListAction holding the new action.

addMethodAction

ActionListAction addMethodAction(java.lang.String methodName)

Adds a Method action to an ActionList.

Parameters:

methodName - The name of the method to call

Returns:

ActionListAction holding the new action.

addPageAction

ActionListAction addPageAction(java.lang.String pageName)

Adds a Page action to an ActionList.

Parameters:

pageName - The name of the Page to call

Returns:

ActionListAction holding the new action.

addReturnAction

ActionListAction addReturnAction(java.lang.String source)

Adds a return action to an ActionList.

Parameters:

source - The source of the returned value

Returns:

ActionListAction holding the new action.

getActions

java.util.Iterator getActions()

Gets an iterator of all the actions in this list.

Returns:

Iterator of ActionListAction objects.

getArguments

java.util.Iterator getArguments()

Gets list of arguments and their types. Returned type of objects in list is com.bowstreet.webapp.ArgumentInfo. Note - While this method is available to the Builders at generation time there is no support in the Factory WebApp runtime for generating artifacts related to it.

getReturnType

java.lang.String getReturnType()

Gets Action List return type. Defaults to "void" if not specified. Note - While this method is available to the Builders at generation time there is no support in the Factory WebApp runtime for generating artifacts related to it.

Returns:

Java type returned by the Action List.

getSchemaPath

java.lang.String getSchemaPath()

Get schemaPath associated with a method that returns IXml (null if not XML)

Returns:

schemaPath string, or null

getSize

int getSize()

Returns the number of actions in this list.

Returns:

size of the action list.

setReturnType

void setReturnType(java.lang.String type)

Sets Action List return type. Defaults to "void" if not specified. Note - While this method is available to the Builders at generation time there is no support in the Factory WebApp runtime for generating artifacts related to it.

Parameters:

type - Java type returned by the Action List.

setSchemaPath

void setSchemaPath(java.lang.String schemaPath)

Set the schemaPath for a method that returns IXml.

Parameters:

schemaPath - string represenation (eg, "/" )