© 2004 BEA Systems, Inc.

com.bea.netuix.application.instance
Class DesktopInstance

java.lang.Object
  extended bycom.bea.netuix.application.instance.DesktopInstance
All Implemented Interfaces:
Serializable

public class DesktopInstance
extends Object
implements Serializable

Represents a customized version of a DesktopDefinition.

See Also:
Serialized Form

Constructor Summary
DesktopInstance(ShellDefinitionId shellDefinitionId, BookInstanceId bookInstanceId, LookAndFeelDefinitionId lookAndFeelDefinitionId, String instanceTitle)
          Constructor to create a new DesktopInstance object.
 
Method Summary
 BookInstanceId getBookInstanceId()
          Return the BookInstanceId for the primary book for this desktop.
 DesktopDefinition getDesktopDefinition()
          Returns the DesktopDefinition that this desktop was created from.
 DesktopDefinitionId getDesktopDefinitionId()
          Returns the DesktopDefinitionId for the DesktopDefinitionId that this desktop was created from.
 DesktopInstanceId getDesktopInstanceId()
          Returns the DesktopInstanceId for this desktop.
 String getInstanceTitle()
          Returns the instance title for this desktop.
 LookAndFeelDefinitionId getLookAndFeelDefinitionId()
          Returns the LookAndFeelDefinitionId for the LookAndFeelDefinition associated with this desktop.
 ShellDefinitionId getShellDefinitionId()
          Returns the ShellDefinitionId for the ShellDefinition associated with this desktop.
 void setBookInstanceId(BookInstanceId bookInstanceId)
          Sets book with BookInstanceId as the primary book for this desktop
 void setInstanceTitle(String instanceTitle)
          Sets the instance title for this desktop
 void setLookAndFeelDefinitionId(LookAndFeelDefinitionId lookAndFeelDefinitionId)
          Associates a LookAndFeelDefinition with this desktop.
 void setShellDefinitionId(ShellDefinitionId shellDefinitionId)
          Associates a ShellDefinition with this desktop.
 
Methods inherited 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.

Parameters:
shellDefinitionId - reference to a persisted ShellDefinition to be associated with this desktop
bookInstanceId - reference to a persisted BookInstance that represents the main book of this desktop
lookAndFeelDefinitionId - reference to a persisted LookAndFeelDefinition to be associated with this desktop
instanceTitle - customized title for this desktop instance
Method Detail

getDesktopInstanceId

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

getDesktopDefinition

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

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

getShellDefinitionId

public ShellDefinitionId getShellDefinitionId()
Returns the ShellDefinitionId for the ShellDefinition associated with this desktop.

Returns:
ShellDefinitionId
See Also:
ShellDefinition

setShellDefinitionId

public void setShellDefinitionId(ShellDefinitionId shellDefinitionId)
Associates a ShellDefinition with this desktop.

Parameters:
shellDefinitionId -

getBookInstanceId

public BookInstanceId getBookInstanceId()
Return the BookInstanceId for the primary book for this desktop.

Returns:
BookInstanceId

setBookInstanceId

public void setBookInstanceId(BookInstanceId bookInstanceId)
Sets book with BookInstanceId as the primary book for this desktop

Parameters:
bookInstanceId -

getLookAndFeelDefinitionId

public LookAndFeelDefinitionId getLookAndFeelDefinitionId()
Returns the LookAndFeelDefinitionId for the LookAndFeelDefinition associated with this desktop.

Returns:
LookAndFeelDefinitionId
See Also:
LookAndFeelDefinition

setLookAndFeelDefinitionId

public void setLookAndFeelDefinitionId(LookAndFeelDefinitionId lookAndFeelDefinitionId)
Associates a LookAndFeelDefinition with this desktop.

Parameters:
lookAndFeelDefinitionId -

getInstanceTitle

public String getInstanceTitle()
Returns the instance title for this desktop.

Returns:
instance title

setInstanceTitle

public void setInstanceTitle(String instanceTitle)
Sets the instance title for this desktop

Parameters:
instanceTitle -

© 2004 BEA Systems, Inc.

Copyright © 2004 BEA Systems, Inc. All Rights Reserved