com.bea.netuix.application.definition
Class ShellDefinition

java.lang.Object
  com.bea.netuix.application.definition.ShellDefinition

All Implemented Interfaces:

Serializable

public class ShellDefinition

extends Object

implements Serializable

ShellDefinition

See Also:

Serialized Form

Constructor Summary

ShellDefinition(LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String webAppName, String shellFile, boolean deleted)
Constructor to create a new ShellDefinition object.

Method Summary

LocalizationIntersectionId	getLocalizationIntersectionId() Returns the LocalizationIntersectionId for this shell.
LocalizationResource	getLocalizationResource() Returns the LocalizationResource associated with this ShellDefinition based on the locale of the request used for retrieving the ShellDefinition.
MarkupDefinitionId	getMarkupDefinitionId() Returns the MarkupDefinitionId for the MarkupDefinition associated with this shell.
ShellDefinitionId	getShellDefinitionId() Returns the ShellDefinitionId for this shell.
String	getShellFile() Returns the path to the shell file for this shell.
String	getWebAppName() Returns the name of the J2EE web application this shell is scoped to.
boolean	isDeleted() Returns whether this shell is deleted.
void	setDeleted(boolean deleted) Sets whether this shell is deleted
void	setLocalizationResource(LocalizationResource localizationResource) Sets the LocalizationResource for this shell.
void	setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId) Sets the MarkupDefinitionId for this shell.
void	setShellFile(String shellFile) Sets the shell file path for this shell.
void	setWebAppName(String webAppName) Scopes this shell to specified J2EE web application
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShellDefinition

public ShellDefinition(LocalizationResource localizationResource,
                       MarkupDefinitionId markupDefinitionId,
                       String webAppName,
                       String shellFile,
                       boolean deleted)

Constructor to create a new ShellDefinition object.

Method Detail

getLocalizationIntersectionId

public LocalizationIntersectionId getLocalizationIntersectionId()

Returns the LocalizationIntersectionId for this shell. Returns NULL if no LocalizationResource is associated with this shell. A LocalizationIntersectionId is a reference to all localized versions of title and description for an entity.

Returns:

LocalizationIntersectionId for this shell

getLocalizationResource

public LocalizationResource getLocalizationResource()

Returns the LocalizationResource associated with this ShellDefinition based on the locale of the request used for retrieving the ShellDefinition.

Returns:

LocalizationResource associated with this shell

getMarkupDefinitionId

public MarkupDefinitionId getMarkupDefinitionId()

Returns the MarkupDefinitionId for the MarkupDefinition associated with this shell.

Returns:

MarkupDefinitionId

See Also:

MarkupDefinition

getShellDefinitionId

public ShellDefinitionId getShellDefinitionId()

Returns the ShellDefinitionId for this shell. Returns NULL when the ShellDefinition has not been retrieved by using the persistence API.

Returns:

ShellDefinitionId for this shell

getShellFile

public String getShellFile()

Returns the path to the shell file for this shell. This path is relative to the web application context.

Returns:

shell file path

getWebAppName

public String getWebAppName()

Returns the name of the J2EE web application this shell is scoped to.

Returns:

name of web application

isDeleted

public boolean isDeleted()

Returns whether this shell is deleted.

Returns:

true if this shell is deleted

setDeleted

public void setDeleted(boolean deleted)

Sets whether this shell is deleted

Parameters:

deleted -

setLocalizationResource

public void setLocalizationResource(LocalizationResource localizationResource)

Sets the LocalizationResource for this shell.

Parameters:

localizationResource -

setMarkupDefinitionId

public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)

Sets the MarkupDefinitionId for this shell.

Parameters:

markupDefinitionId -

setShellFile

public void setShellFile(String shellFile)

Sets the shell file path for this shell.

Parameters:

shellFile -

setWebAppName

public void setWebAppName(String webAppName)

Scopes this shell to specified J2EE web application

Parameters:

webAppName - name of the web application to scope this shell to

toString

public String toString()