com.bea.netuix.application.view
Interface ShellView

View class for a shell. All desktops must have a least one shell. The shell represents everything
outside of the main book.

"Views" are deep copy immutable objects. Unlike "Definitions" and "Instances" Views cannot be modified by the developer.
An Instance or a Definition however can always be obtained from the view. The persistence APIs provide coarse grain
and fine grain getters, but only fine grain setters. If you are interested in an object and all its children then
retrieve the View, but if you are only interested in the immediate object and don't care about its children then retrieve the
Definition.

This interface is intended to be implemented only by Oracle Weblogic Portal. Oracle Systems reserves the right to add abstract methods to this interface without notice. Implementations of this interface by other parties must not be expected to compile without change in future versions of Oracle Weblogic Portal.

getShellDefinitionId

Getter for the shell definition id. The shell id is the primary key value for the
shell definition in the PF_SHELL_DEFINITION table. Unlike Book, Pages, and Portlets, shells
do not have instances. The admin or end user can change a shell but in doing so they
are customizing the desktop and not the shell.

Returns

a non-null unique definition id. This value should never be null as views are obtained
via the persistence API.

getShellDefinition

Retrieve the associated shellDefinition from this shell view. Shell views are immutable but
shell definitions are not. Therefore it is often necessary to retrieve the definition from the view in
order to update its values and then in turn call the persistence API. The shell definition is constructed
(in the database) and updated via its .shell file. If you create a new .shell file then a new shell definition
is created in the database. If you edit the file the changes are automatically seen in the database.
(during dev time we poll the file system periodically and in production we update the database whenever the webapp is
redeployed).

getShellFile

Retrieve the file name used to create this shell. Shells are
created via .shell files.

Returns

the file name associated with this shell.

isDeleted

boolean isDeleted()

If isDeleted is true then the shell has been removed from the file system. It was not outright deleted
from the database because it is in use by some desktop somewhere in the system. Either
restore the file and this flag will go back to false or remove/replace this shell via the admin tools.

If this flag is set on an object the admin tools will display the object with a different icon to denote that
it has been removed from the file system.