com.bea.netuix.application.definition
Class DesktopDefinition

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

All Implemented Interfaces:

Serializable

public class DesktopDefinition

extends Object

implements Serializable

This class represents a persistant desktop.

See Also:

Serialized Form

Field Summary

protected DesktopDefinitionId	desktopDefinitionId
protected DesktopInstance	desktopInstance

Constructor Summary

protected	DesktopDefinition(DesktopDefinitionId desktopDefinitionId, LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, BookDefinitionId bookDefinitionId, boolean treeOptimization, DesktopInstance desktopInstance) Constructor that takes a DesktopInstance
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.
DesktopDefinitionId	getDesktopDefinitionId() Returns the DesktopDefinitionId for this desktop.
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.
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.
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)

Methods inherited 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

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

Constructor that takes a DesktopInstance

DesktopDefinition

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

Constructs a new DesktopDefinition object.

DesktopDefinition

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

Method Detail

getBookDefinitionId

public BookDefinitionId getBookDefinitionId()

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

Returns:

BookDefinitionId

See Also:

BookDefinition

getBookInstanceId

public BookInstanceId getBookInstanceId()

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

Returns:

BookInstanceId

See Also:

BookInstance

getDesktopDefinitionId

public DesktopDefinitionId getDesktopDefinitionId()

Returns the DesktopDefinitionId for this desktop.

Returns:

DesktopDefinitionId

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

getLocalizationResource

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

public LookAndFeelDefinitionId getLookAndFeelDefinitionId()

Returns the LookAndFeelDefinitionId for the LookAndFeelDefinition associated with this desktop.

Returns:

LookAndFeelDefinitionId

See Also:

LookAndFeelDefinition

getMarkupDefinitionId

public MarkupDefinitionId getMarkupDefinitionId()

Returns the MarkupDefinitionId for the MarkupDefinition associated with this desktop.

Returns:

MarkupDefinitionId

See Also:

MarkupDefinition

getPrimaryInstanceId

public DesktopInstanceId getPrimaryInstanceId()

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

Returns:

DesktopInstanceId

getShellDefinitionId

public ShellDefinitionId getShellDefinitionId()

Returns the ShellDefinitionId for the ShellDefinition associated with this desktop.

Returns:

ShellDefinitionId

See Also:

ShellDefinition

isTreeOptimization

public boolean isTreeOptimization()

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

setBookDefinitionId

public void setBookDefinitionId(BookDefinitionId bookDefinitionId)

Sets the BookDefinitionId for the primary book of this dekstop.

Parameters:

bookDefinitionId -

setDesktopDefinitionId

public void setDesktopDefinitionId(DesktopDefinitionId desktopDefinitionId)

Sets the DesktopDefinitionId for this desktop.

Parameters:

desktopDefinitionId -

setLocalizationResource

public void setLocalizationResource(LocalizationResource localizationResource)

Sets the LocalizationResource for this desktop.

Parameters:

localizationResource -

setLookAndFeelDefinitionId

public void setLookAndFeelDefinitionId(LookAndFeelDefinitionId lookAndFeelDefinitionId)

Associates a LookAndFeelDefinition with this desktop.

Parameters:

lookAndFeelDefinitionId -

setMarkupDefinitionId

public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)

Sets the MarkupDefinitionId for this desktop.

Parameters:

markupDefinitionId -

setShellDefinitionId

public void setShellDefinitionId(ShellDefinitionId shellDefinitionId)

Associates a ShellDefinition with this desktop.

Parameters:

shellDefinitionId -

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 -

toString

public String toString()

Returns a concatenated string representation of

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

Returns: