com.bowstreet.webapp
Interface LinkedModel

All Superinterfaces:

IExemplar, WebAppObject

public interface LinkedModel
extends WebAppObject

LinkedModel class - holds info about a reference to another model

Field Summary

static java.lang.String	IS_SINGLETON Property key to specify if the linked model is a singleton.
static java.lang.String	PROFILE_MAPPER Property key to specify a ProfileMapper on a linked model.

Fields inherited from interface com.bowstreet.webapp.WebAppObject

ALWAYS_VISIBLE, INFORMATION_PROPERTY, NEVER_VISIBLE, SOMETIMES_VISIBLE

Method Summary

boolean	getInheritExplicitProfile() Get flag to determine if inheritance of explicit profiles from the parent Model is enabled
java.lang.String	getModelName() Gets the Model name for this LinkedModel
java.lang.String	getProfileName() Gets the explicit profile name that was set on this LinkedModel.
void	setInheritExplicitProfile(boolean set) Set flag to determine if inheritance of explicit profiles from the parent Model is enabled
void	setLinkedModelInstance(WebAppAccess webAppAccess) Sets a model instance for the specified Linked Model.
void	setModelName(java.lang.String modelName) Sets the Model name for this LinkedModel
void	setProfileName(java.lang.String profileName) Sets explicit profile name to use for this Linked Model.

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

IS_SINGLETON

static final java.lang.String IS_SINGLETON

Property key to specify if the linked model is a singleton.

See Also:

Constant Field Values

PROFILE_MAPPER

static final java.lang.String PROFILE_MAPPER

Property key to specify a ProfileMapper on a linked model.

See Also:

Constant Field Values

Method Detail

getInheritExplicitProfile

boolean getInheritExplicitProfile()

Get flag to determine if inheritance of explicit profiles from the parent Model is enabled

Returns:

True if enabled, else fale.

getModelName

java.lang.String getModelName()

Gets the Model name for this LinkedModel

Returns:

The Model name for this LinkedModel

getProfileName

java.lang.String getProfileName()

Gets the explicit profile name that was set on this LinkedModel.

Returns:

Explicit profile name or null if none specified (e.g. profiledText!Silver$Region!EastCoast)

setInheritExplicitProfile

void setInheritExplicitProfile(boolean set)

Set flag to determine if inheritance of explicit profiles from the parent Model is enabled

Parameters:

set - True to enable this Linked Model to Inherit its explicit profile from the parent Model..

setLinkedModelInstance

void setLinkedModelInstance(WebAppAccess webAppAccess)

Sets a model instance for the specified Linked Model. This allow you to replace an existing Linked Model within the current Model at runtime.

Parameters:

webAppAccess - The WebAppAccess of the new Linked Model.

setModelName

void setModelName(java.lang.String modelName)

Sets the Model name for this LinkedModel

Parameters:

modelName - The Model name for this LinkedModel

setProfileName

void setProfileName(java.lang.String profileName)

Sets explicit profile name to use for this Linked Model. The name specified can be one of more ProfileSet/Profile combinations.

Parameters:

profileName - The Explicit profile name to use for this LinkedModel

Example:

// build name (e.g. profiledText!Silver$Region!EastCoast)
String profileName = "profiledText" + WebAppAccess.PROFILESET_PROFILE_SEPARATOR + "Silver" + LinkedModel.EXPLICIT_PROFILE_SEPARATOR + "Region" + WebAppAccess.PROFILESET_PROFILE_SEPARATOR + "EastCoast";
linkedModel.setProfileName(profileName);