com.bowstreet.builders.webapp.methods
Interface ModelContainer

public interface ModelContainer

Public Linked Java object implementing the Model Container API

Field Summary

static java.lang.String

MODEL_INITIALIZATION_VARIABLE_NAME Name of the special variable into which the Model Container pushes initialization data: "ModelInitializationData".

Method Summary

void	callInitializationAction(WebAppAccess webAppAccess, java.lang.Object initData, java.lang.String force) Call the module initialization action for the current model.
java.lang.String	getModelName() Get the name of the model held by this container.
java.lang.String	getProfileName() Get the name of the current model profile
void	load(WebAppAccess webAppAccess) Immediately load the linked model to reflect the current model and profile.
void	setModelInstance(java.lang.Object webAppAccess) Cause this container to use a specific model instance
void	setModelName(java.lang.String modelName) Set the name of the model held by this container.
void	setProfileName(java.lang.String profileName) Set the name of the current model profile

Field Detail

MODEL_INITIALIZATION_VARIABLE_NAME

static final java.lang.String MODEL_INITIALIZATION_VARIABLE_NAME

Name of the special variable into which the Model Container pushes initialization data: "ModelInitializationData". Applications typically use an XML-valued variable for this purpose, with one node corresponding to each customizable aspect of the model's behavior. This variable will be created by the Model Container if necessary.

See Also:

Constant Field Values

Method Detail

callInitializationAction

void callInitializationAction(WebAppAccess webAppAccess,
                              java.lang.Object initData,
                              java.lang.String force)

Call the module initialization action for the current model.

Parameters:

initData - the data to pass to the action

force - if "true", calls action even if already called

getModelName

java.lang.String getModelName()

Get the name of the model held by this container.

Returns:

the currently contained model

getProfileName

java.lang.String getProfileName()

Get the name of the current model profile

Returns:

the profile in use

load

void load(WebAppAccess webAppAccess)

Immediately load the linked model to reflect the current model and profile.

Parameters:

webAppAccess - the instance of the model holding the model container

setModelInstance

void setModelInstance(java.lang.Object webAppAccess)

Cause this container to use a specific model instance

Parameters:

webAppAccess - the model instance to use

setModelName

void setModelName(java.lang.String modelName)

Set the name of the model held by this container.

Parameters:

modelName - the model to contain

setProfileName

void setProfileName(java.lang.String profileName)

Set the name of the current model profile

Parameters:

profileName - the profile in use