# com.bea.netuix.application.instance
DesktopInstance Class

public class DesktopInstance
extends `Object`
implements `Serializable`

Represents a customized version of a `DesktopDefinition`.

Hierarchy
  `Object`
  `DesktopInstance`

All Implemented Interfaces
  `Serializable`

## Constructor Summary

DesktopInstance(`ShellDefinitionId` shellDefinitionId, `BookInstanceId` bookInstanceId, `LookAndFeelDefinitionId` lookAndFeelDefinitionId, `String` instanceTitle) Constructor to create a new `DesktopInstance` object.

## Method Summary

`public `BookInstanceId`` | `getBookInstanceId`() Return the `BookInstanceId` for the primary book for this desktop.
`public `DesktopDefinition`` | `getDesktopDefinition`() Returns the `DesktopDefinition` that this desktop was created from.
`public `DesktopDefinitionId`` | `getDesktopDefinitionId`() Returns the `DesktopDefinitionId` for the `DesktopDefinitionId` that this desktop was created from.
`public `DesktopInstanceId`` | `getDesktopInstanceId`() Returns the `DesktopInstanceId` for this desktop.
`public `String`` | `getInstanceTitle`() Returns the instance title for this desktop.
`public `LookAndFeelDefinitionId`` | `getLookAndFeelDefinitionId`() Returns the `LookAndFeelDefinitionId` for the `LookAndFeelDefinition` associated with this desktop.
`public `ShellDefinitionId`` | `getShellDefinitionId`() Returns the `ShellDefinitionId` for the `ShellDefinition` associated with this desktop.
`public void` | `setBookInstanceId`(`BookInstanceId` bookInstanceId) Sets book with `BookInstanceId` as the primary book for this desktop
`public void` | `setInstanceTitle`(`String` instanceTitle) Sets the instance title for this desktop
`public void` | `setLookAndFeelDefinitionId`(`LookAndFeelDefinitionId` lookAndFeelDefinitionId) Associates a `LookAndFeelDefinition` with this desktop.
`public void` | `setShellDefinitionId`(`ShellDefinitionId` shellDefinitionId) Associates a `ShellDefinition` with this desktop.

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

## Constructor Detail

### DesktopInstance

    public DesktopInstance(ShellDefinitionId shellDefinitionId,
                           BookInstanceId bookInstanceId,
                           LookAndFeelDefinitionId lookAndFeelDefinitionId,
                           String instanceTitle)

  Constructor to create a new `DesktopInstance` object.

## Method Detail

### getBookInstanceId() Method

    public BookInstanceId getBookInstanceId()

Return the `BookInstanceId` for the primary book for this desktop.

#### Returns

`BookInstanceId`

### getDesktopDefinition() Method

    public DesktopDefinition getDesktopDefinition()

Returns the `DesktopDefinition` that this desktop was created from. Returns `NULL` when the DesktopInstance has not been retrieved by using the persistence API.

#### Returns

`DesktopDefinition` for this desktop

### getDesktopDefinitionId() Method

    public DesktopDefinitionId getDesktopDefinitionId()

Returns the `DesktopDefinitionId` for the `DesktopDefinitionId` that this desktop was created from. Returns `NULL` when the DesktopInstance has not been retrieved by using the persistence API.

#### Returns

`DesktopDefinitionId` for this desktop

### getDesktopInstanceId() Method

    public DesktopInstanceId getDesktopInstanceId()

Returns the `DesktopInstanceId` for this desktop. Returns `NULL` when the DesktopInstance has not been retrieved by using the persistence API.

#### Returns

`DesktopInstanceId` for this desktop

### getInstanceTitle() Method

    public String getInstanceTitle()

Returns the instance title for this desktop.

#### Returns

instance title

### getLookAndFeelDefinitionId() Method

    public LookAndFeelDefinitionId getLookAndFeelDefinitionId()

Returns the `LookAndFeelDefinitionId` for the `LookAndFeelDefinition` associated with this desktop.

#### Returns

`LookAndFeelDefinitionId`

Related Topics

``LookAndFeelDefinition``

### getShellDefinitionId() Method

    public ShellDefinitionId getShellDefinitionId()

Returns the `ShellDefinitionId` for the `ShellDefinition` associated with this desktop.

#### Returns

`ShellDefinitionId`

Related Topics

``ShellDefinition``

### setBookInstanceId(BookInstanceId) Method

    public void setBookInstanceId(BookInstanceId bookInstanceId)

Sets book with `BookInstanceId` as the primary book for this desktop

### setInstanceTitle(String) Method

    public void setInstanceTitle(String instanceTitle)

Sets the instance title for this desktop

### setLookAndFeelDefinitionId(LookAndFeelDefinitionId) Method

    public void setLookAndFeelDefinitionId(LookAndFeelDefinitionId lookAndFeelDefinitionId)

Associates a `LookAndFeelDefinition` with this desktop.

### setShellDefinitionId(ShellDefinitionId) Method

    public void setShellDefinitionId(ShellDefinitionId shellDefinitionId)

Associates a `ShellDefinition` with this desktop.