# com.bea.netuix.application.definition
ShellDefinition Class

public class ShellDefinition
extends `Object`
implements `Serializable`

`ShellDefinition`

Hierarchy
  `Object`
  `ShellDefinition`

All Implemented Interfaces
  `Serializable`

## Constructor Summary

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

## Method Summary

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

Methods 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() Method

    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() Method

    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() Method

    public MarkupDefinitionId getMarkupDefinitionId()

Returns the `MarkupDefinitionId` for the `MarkupDefinition` associated with this shell.

#### Returns

`MarkupDefinitionId`

Related Topics

``MarkupDefinition``

### getShellDefinitionId() Method

    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() Method

    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() Method

    public String getWebAppName()

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

#### Returns

name of web application

### isDeleted() Method

    public boolean isDeleted()

Returns whether this shell is deleted.

#### Returns

true if this shell is deleted

### setDeleted(boolean) Method

    public void setDeleted(boolean deleted)

Sets whether this shell is deleted

### setLocalizationResource(LocalizationResource) Method

    public void setLocalizationResource(LocalizationResource localizationResource)

Sets the `LocalizationResource` for this shell.

### setMarkupDefinitionId(MarkupDefinitionId) Method

    public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)

Sets the `MarkupDefinitionId` for this shell.

### setShellFile(String) Method

    public void setShellFile(String shellFile)

Sets the shell file path for this shell.

### setWebAppName(String) Method

    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() Method

    public String toString()

Overrides
  `Object.toString()`