Overview | Package | Class | Tree | Deprecated | Index | Help
| Copyright © 2006 BEA Systems, Inc. All Rights Reserved
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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

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

All Implemented Interfaces
  DateableDefinition, TemplateDefinition, Serializable

    public class DesktopDefinition

extends Object
implements TemplateDefinition, DateableDefinition, Serializable

This class represents a persistent desktop.

See Also
  Serialized Form

Constructor Summary
`protected` | `DesktopDefinition(DesktopDefinitionId desktopDefinitionId, LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, BookDefinitionId bookDefinitionId, DesktopInstance desktopInstance)` Constructor that takes a `DesktopInstance`
`` | `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, LookAndFeelDefinitionId lookAndFeelDefinitionId, ShellDefinitionId shellDefinitionId, boolean treeOptimization)`

Method Summary
`BookDefinitionId` | `getBookDefinitionId()` Returns the `BookDefinitionId` for the primary `BookDefinition` associated with this desktop.
`BookInstanceId` | `getBookInstanceId()` Returns `BookInstanceId` of the `BookInstance` associated with the primary desktop instance of this desktop.
`Date` | `getCreatedDate()` Gets the time that this object was created in the database.
`DesktopDefinitionId` | `getDesktopDefinitionId()` Returns the `DesktopDefinitionId` for this desktop.
`DesktopType.DesktopTypeValue` | `getDesktopType()`
`LocalizationIntersectionId` | `getLocalizationIntersectionId()` Returns the `LocalizationIntersectionId` for this desktop.
`LocalizationResource` | `getLocalizationResource()` Returns the `LocalizationResource` associated with this `DesktopDefinition` based on the locale of the request used for retrieving the `DesktopDefinition`.
`LookAndFeelDefinitionId` | `getLookAndFeelDefinitionId()` Returns the `LookAndFeelDefinitionId` for the `LookAndFeelDefinition` associated with this desktop.
`MarkupDefinitionId` | `getMarkupDefinitionId()` Returns the `MarkupDefinitionId` for the `MarkupDefinition` associated with this desktop.
`Date` | `getModifiedDate()` Gets the time that this object was last updated in the database.
`DesktopInstanceId` | `getPrimaryInstanceId()` Returns the `DesktopInstanceId` for the primary `DesktopInstance` associated with this desktop.
`ShellDefinitionId` | `getShellDefinitionId()` Returns the `ShellDefinitionId` for the `ShellDefinition` associated with this desktop.
`TemplateId` | `getTemplateId()` Returns the `TemplateId` of this template.
`TemplateTypeDefinition.TemplateType` | `getTemplateType()` Returns the `TemplateTypeDefinition.TemplateType` associated with this template
`com.bea.netuix.application.identifier.TemplateTypeId` | `getTemplateTypeId()` Returns the `TemplateTypeId` associated with this template
`String` | `getWebAppName()` Returns the name of the J2EE web application this portlet category is scoped to.
`boolean` | `isGlobal()`
`boolean` | `isTemplate()`
`boolean` | `isTreeOptimization()` During rendering should this desktop use partial control tree contruction.
`void` | `setBookDefinitionId(BookDefinitionId bookDefinitionId)` Sets the `BookDefinitionId` for the primary book of this dekstop.
`void` | `setDesktopDefinitionId(DesktopDefinitionId desktopDefinitionId)` Sets the `DesktopDefinitionId` for this desktop.
`void` | `setLocalizationResource(LocalizationResource localizationResource)` Sets the `LocalizationResource` for this desktop.
`void` | `setLookAndFeelDefinitionId(LookAndFeelDefinitionId lookAndFeelDefinitionId)` Associates a `LookAndFeelDefinition` with this desktop.
`void` | `setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)` Sets the `MarkupDefinitionId` for this desktop.
`void` | `setShellDefinitionId(ShellDefinitionId shellDefinitionId)` Associates a `ShellDefinition` with this desktop.
`void` | `setTreeOptimization(boolean treeOptimization)` During rendering should this desktop use partial control tree contruction.
`String` | `toString()` Returns a concatenated string representation of DesktopDefinitionId(web app name + portal path + desktop path) LocalizationIntersectionId(int) BookDefinitionId(int) MarkupDefinitionId(int) Tree Optimized flag(boolean) DesktopType(enum) IsTemplate flag(boolean) IsGlobal flag(boolean)

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

Constructor Detail

### DesktopDefinition

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

  Constructs a new `DesktopDefinition` object.

  Parameters
    `desktopDefinitionId` - desktopDefinitionId for this desktop
    `localizationResource` - localized title and description
    `markupDefinitionId` - reference to a persisted `MarkupDefinition` that specifies the markup for this desktop
    `bookDefinitionId` - reference to a persisted `BookDefinition` that represents the main book of this desktop
    `lookAndFeelDefinitionId` - reference to a persisted `LookAndFeelDefinition` to be associated with this desktop
    `shellDefinitionId` - reference to a persisted `ShellDefinition` to be associated with this desktop

### DesktopDefinition

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

### DesktopDefinition

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

  Constructor that takes a `DesktopInstance`

  Parameters
    `desktopDefinitionId` - desktopDefinitionId for this desktop
    `localizationResource` - localized title and description
    `markupDefinitionId` - reference to a persisted `MarkupDefinition` that specifies the markup for this desktop
    `bookDefinitionId` - reference to a persisted `BookDefinition` that represents the main book of this desktop
    `desktopInstance` -

Method Detail

### getDesktopDefinitionId

    public DesktopDefinitionId getDesktopDefinitionId()

  Returns the `DesktopDefinitionId` for this desktop.

  Returns
    `DesktopDefinitionId`

### setDesktopDefinitionId

    public void setDesktopDefinitionId(DesktopDefinitionId desktopDefinitionId)

  Sets the `DesktopDefinitionId` for this desktop.

  Parameters
    `desktopDefinitionId` -

### getLocalizationResource

    public LocalizationResource getLocalizationResource()

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

  Specified by:
    `getLocalizationResource` in interface `TemplateDefinition`
  Returns
    `LocalizationResource` associated with this desktop

### getLocalizationIntersectionId

    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

### setLocalizationResource

    public void setLocalizationResource(LocalizationResource localizationResource)

  Sets the `LocalizationResource` for this desktop.

  Parameters
    `localizationResource` -

### getMarkupDefinitionId

    public MarkupDefinitionId getMarkupDefinitionId()

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

  Returns
    `MarkupDefinitionId`
  See Also
    `MarkupDefinition`

### setMarkupDefinitionId

    public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)

  Sets the `MarkupDefinitionId` for this desktop.

  Parameters
    `markupDefinitionId` -

### getBookDefinitionId

    public BookDefinitionId getBookDefinitionId()

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

  Returns
    `BookDefinitionId`
  See Also
    `BookDefinition`

### setBookDefinitionId

    public void setBookDefinitionId(BookDefinitionId bookDefinitionId)

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

  Parameters
    `bookDefinitionId` -

### getShellDefinitionId

    public ShellDefinitionId getShellDefinitionId()

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

  Returns
    `ShellDefinitionId`
  See Also
    `ShellDefinition`

### getLookAndFeelDefinitionId

    public LookAndFeelDefinitionId getLookAndFeelDefinitionId()

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

  Returns
    `LookAndFeelDefinitionId`
  See Also
    `LookAndFeelDefinition`

### getBookInstanceId

    public BookInstanceId getBookInstanceId()

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

  Returns
    `BookInstanceId`
  See Also
    `BookInstance`

### getPrimaryInstanceId

    public DesktopInstanceId getPrimaryInstanceId()

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

  Returns
    `DesktopInstanceId`

### setLookAndFeelDefinitionId

    public void setLookAndFeelDefinitionId(LookAndFeelDefinitionId lookAndFeelDefinitionId)

  Associates a `LookAndFeelDefinition` with this desktop.

  Parameters
    `lookAndFeelDefinitionId` -

### setShellDefinitionId

    public void setShellDefinitionId(ShellDefinitionId shellDefinitionId)

  Associates a `ShellDefinition` with this desktop.

  Parameters
    `shellDefinitionId` -

### getDesktopType

    public DesktopType.DesktopTypeValue getDesktopType()

### isTemplate

    public boolean isTemplate()

### isGlobal

    public boolean isGlobal()

### getWebAppName

    public String getWebAppName()

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

  Specified by:
    `getWebAppName` in interface `TemplateDefinition`
  Returns
    web application name

### getTemplateId

    public TemplateId getTemplateId()

  Description copied from interface: `TemplateDefinition`
  Returns the `TemplateId` of this template.

  Specified by:
    `getTemplateId` in interface `TemplateDefinition`
  Returns
    template id

### getTemplateType

    public TemplateTypeDefinition.TemplateType getTemplateType()

  Description copied from interface: `TemplateDefinition`
  Returns the `TemplateTypeDefinition.TemplateType` associated with this template

  Specified by:
    `getTemplateType` in interface `TemplateDefinition`
  Returns
    template type

### getTemplateTypeId

    public com.bea.netuix.application.identifier.TemplateTypeId getTemplateTypeId()

  Description copied from interface: `TemplateDefinition`
  Returns the `TemplateTypeId` associated with this template

  Specified by:
    `getTemplateTypeId` in interface `TemplateDefinition`
  Returns
    template type id

### isTreeOptimization

    public boolean isTreeOptimization()

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

### setTreeOptimization

    public void setTreeOptimization(boolean treeOptimization)

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

  Parameters
    `treeOptimization` -

### getCreatedDate

    public Date getCreatedDate()

  Gets the time that this object was created in the database.

  Specified by:
    `getCreatedDate` in interface `DateableDefinition`

### getModifiedDate

    public Date getModifiedDate()

  Gets the time that this object was last updated in the database. This value only applies to this immediate object and not its children.

  Specified by:
    `getModifiedDate` in interface `DateableDefinition`

### toString

    public String toString()

  Returns a concatenated string representation of
  - DesktopDefinitionId(web app name + portal path + desktop path)
  - LocalizationIntersectionId(int)
  - BookDefinitionId(int)
  - MarkupDefinitionId(int)
  - Tree Optimized flag(boolean)
  - DesktopType(enum)
  - IsTemplate flag(boolean)
  - IsGlobal flag(boolean)

  Overrides:
    `toString` in class `Object`
  Returns

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006 BEA Systems, Inc. All Rights Reserved