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

public class DesktopDefinition
extends `Object`
implements `Serializable`

This class represents a persistant desktop.

Hierarchy
  `Object`
  `DesktopDefinition`

All Implemented Interfaces
  `Serializable`

## Field Summary

`protected `DesktopDefinitionId`` | `desktopDefinitionId` DesktopDefinitionId
`protected `DesktopInstance`` | `desktopInstance` DesktopInstance

## Constructor Summary

DesktopDefinition(`DesktopDefinitionId` desktopDefinitionId, `LocalizationResource` localizationResource, `MarkupDefinitionId` markupDefinitionId, `BookDefinitionId` bookDefinitionId, boolean treeOptimization, `DesktopInstance` desktopInstance) Constructor that takes a `DesktopInstance`
DesktopDefinition(`DesktopDefinitionId` desktopDefinitionId, `LocalizationResource` localizationResource, `MarkupDefinitionId` markupDefinitionId, `BookDefinitionId` bookDefinitionId, `LookAndFeelDefinitionId` lookAndFeelDefinitionId, `ShellDefinitionId` shellDefinitionId, boolean treeOptimization)
DesktopDefinition(`DesktopDefinitionId` desktopDefinitionId, `LocalizationResource` localizationResource, `MarkupDefinitionId` markupDefinitionId, `BookDefinitionId` bookDefinitionId, `LookAndFeelDefinitionId` lookAndFeelDefinitionId, `ShellDefinitionId` shellDefinitionId) Constructs a new `DesktopDefinition` object.
DesktopDefinition(`DesktopDefinitionId` desktopDefinitionId, `LocalizationResource` localizationResource, `MarkupDefinitionId` markupDefinitionId, `BookDefinitionId` bookDefinitionId, `DesktopInstance` desktopInstance) Constructor that takes a `DesktopInstance`

## Method Summary

`public `BookDefinitionId`` | `getBookDefinitionId`() Returns the `BookDefinitionId` for the primary `BookDefinition` associated with this desktop.
`public `BookInstanceId`` | `getBookInstanceId`() Returns `BookInstanceId` of the `BookInstance` associated with the primary desktop instance of this desktop.
`public `DesktopDefinitionId`` | `getDesktopDefinitionId`() Returns the `DesktopDefinitionId` for this desktop.
`public `LocalizationIntersectionId`` | `getLocalizationIntersectionId`() Returns the `LocalizationIntersectionId` for this desktop.
`public `LocalizationResource`` | `getLocalizationResource`() Returns the `LocalizationResource` associated with this `DesktopDefinition` based on the locale of the request used for retrieving the `DesktopDefinition`.
`public `LookAndFeelDefinitionId`` | `getLookAndFeelDefinitionId`() Returns the `LookAndFeelDefinitionId` for the `LookAndFeelDefinition` associated with this desktop.
`public `MarkupDefinitionId`` | `getMarkupDefinitionId`() Returns the `MarkupDefinitionId` for the `MarkupDefinition` associated with this desktop.
`public `DesktopInstanceId`` | `getPrimaryInstanceId`() Returns the `DesktopInstanceId` for the primary `DesktopInstance` associated with this desktop.
`public `ShellDefinitionId`` | `getShellDefinitionId`() Returns the `ShellDefinitionId` for the `ShellDefinition` associated with this desktop.
`public boolean` | `isTreeOptimization`() During rendering should this desktop use partial control tree contruction.
`public void` | `setBookDefinitionId`(`BookDefinitionId` bookDefinitionId) Sets the `BookDefinitionId` for the primary book of this dekstop.
`public void` | `setDesktopDefinitionId`(`DesktopDefinitionId` desktopDefinitionId) Sets the `DesktopDefinitionId` for this desktop.
`public void` | `setLocalizationResource`(`LocalizationResource` localizationResource) Sets the `LocalizationResource` for this desktop.
`public void` | `setLookAndFeelDefinitionId`(`LookAndFeelDefinitionId` lookAndFeelDefinitionId) Associates a `LookAndFeelDefinition` with this desktop.
`public void` | `setMarkupDefinitionId`(`MarkupDefinitionId` markupDefinitionId) Sets the `MarkupDefinitionId` for this desktop.
`public void` | `setShellDefinitionId`(`ShellDefinitionId` shellDefinitionId) Associates a `ShellDefinition` with this desktop.
`public void` | `setTreeOptimization`(boolean treeOptimization) During rendering should this desktop use partial control tree contruction.
`public `String`` | `toString`() Returns a concatenated string representation of DesktopDefinitionId(web app name + portal path + desktop path) LocalizationIntersectionId(int) BookDefinitionId(int) MarkupDefinitionId(int)

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

## Field Detail

### desktopDefinitionId

    protected DesktopDefinitionId desktopDefinitionId

### desktopInstance

    protected DesktopInstance desktopInstance

## Constructor Detail

### DesktopDefinition

    protected DesktopDefinition(DesktopDefinitionId desktopDefinitionId,
                                LocalizationResource localizationResource,
                                MarkupDefinitionId markupDefinitionId,
                                BookDefinitionId bookDefinitionId,
                                boolean treeOptimization,
                                DesktopInstance desktopInstance)

  Constructor that takes a `DesktopInstance`

### DesktopDefinition

    public DesktopDefinition(DesktopDefinitionId desktopDefinitionId,
                             LocalizationResource localizationResource,
                             MarkupDefinitionId markupDefinitionId,
                             BookDefinitionId bookDefinitionId,
                             LookAndFeelDefinitionId lookAndFeelDefinitionId,
                             ShellDefinitionId shellDefinitionId,
                             boolean treeOptimization)

### DesktopDefinition

    public DesktopDefinition(DesktopDefinitionId desktopDefinitionId,
                             LocalizationResource localizationResource,
                             MarkupDefinitionId markupDefinitionId,
                             BookDefinitionId bookDefinitionId,
                             LookAndFeelDefinitionId lookAndFeelDefinitionId,
                             ShellDefinitionId shellDefinitionId)

  Constructs a new `DesktopDefinition` object.

### DesktopDefinition

    protected DesktopDefinition(DesktopDefinitionId desktopDefinitionId,
                                LocalizationResource localizationResource,
                                MarkupDefinitionId markupDefinitionId,
                                BookDefinitionId bookDefinitionId,
                                DesktopInstance desktopInstance)

  Constructor that takes a `DesktopInstance`

## Method Detail

### getBookDefinitionId() Method

    public BookDefinitionId getBookDefinitionId()

Returns the `BookDefinitionId` for the primary `BookDefinition` associated with this desktop.

#### Returns

`BookDefinitionId`

Related Topics

``BookDefinition``

### getBookInstanceId() Method

    public BookInstanceId getBookInstanceId()

Returns `BookInstanceId` of the `BookInstance` associated with the primary desktop instance of this desktop.

#### Returns

`BookInstanceId`

Related Topics

``BookInstance``

### getDesktopDefinitionId() Method

    public DesktopDefinitionId getDesktopDefinitionId()

Returns the `DesktopDefinitionId` for this desktop.

#### Returns

`DesktopDefinitionId`

### getLocalizationIntersectionId() Method

    public LocalizationIntersectionId getLocalizationIntersectionId()

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

#### Returns

`LocalizationIntersectionId` for this desktop

### getLocalizationResource() Method

    public LocalizationResource getLocalizationResource()

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

#### Returns

`LocalizationResource` associated with this desktop

### getLookAndFeelDefinitionId() Method

    public LookAndFeelDefinitionId getLookAndFeelDefinitionId()

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

#### Returns

`LookAndFeelDefinitionId`

Related Topics

``LookAndFeelDefinition``

### getMarkupDefinitionId() Method

    public MarkupDefinitionId getMarkupDefinitionId()

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

#### Returns

`MarkupDefinitionId`

Related Topics

``MarkupDefinition``

### getPrimaryInstanceId() Method

    public DesktopInstanceId getPrimaryInstanceId()

Returns the `DesktopInstanceId` for the primary `DesktopInstance` associated with this desktop.

#### Returns

`DesktopInstanceId`

### getShellDefinitionId() Method

    public ShellDefinitionId getShellDefinitionId()

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

#### Returns

`ShellDefinitionId`

Related Topics

``ShellDefinition``

### isTreeOptimization() Method

    public boolean isTreeOptimization()

During rendering should this desktop use partial control tree contruction. This can improve performance but some features are lost.

### setBookDefinitionId(BookDefinitionId) Method

    public void setBookDefinitionId(BookDefinitionId bookDefinitionId)

Sets the `BookDefinitionId` for the primary book of this dekstop.

### setDesktopDefinitionId(DesktopDefinitionId) Method

    public void setDesktopDefinitionId(DesktopDefinitionId desktopDefinitionId)

Sets the `DesktopDefinitionId` for this desktop.

### setLocalizationResource(LocalizationResource) Method

    public void setLocalizationResource(LocalizationResource localizationResource)

Sets the `LocalizationResource` for this desktop.

### setLookAndFeelDefinitionId(LookAndFeelDefinitionId) Method

    public void setLookAndFeelDefinitionId(LookAndFeelDefinitionId lookAndFeelDefinitionId)

Associates a `LookAndFeelDefinition` with this desktop.

### setMarkupDefinitionId(MarkupDefinitionId) Method

    public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)

Sets the `MarkupDefinitionId` for this desktop.

### setShellDefinitionId(ShellDefinitionId) Method

    public void setShellDefinitionId(ShellDefinitionId shellDefinitionId)

Associates a `ShellDefinition` with this desktop.

### setTreeOptimization(boolean) Method

    public void setTreeOptimization(boolean treeOptimization)

During rendering should this desktop use partial control tree contruction. This can improve performance but some features are lost.

### toString() Method

    public String toString()

Returns a concatenated string representation of

- DesktopDefinitionId(web app name + portal path + desktop path)
- LocalizationIntersectionId(int)
- BookDefinitionId(int)
- MarkupDefinitionId(int)

Overrides
  `Object.toString()`