MenuDefinition Class

com.bea.netuix.application.definition
MenuDefinition Class

public class MenuDefinition

    extends Object
    implements Serializable

This class represents a persistant menu.

Hierarchy
Object
  MenuDefinition
All Implemented Interfaces

Serializable

Constructor Summary
MenuDefinition(LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String webAppName, String menuFile, boolean deleted)

Constructs a new MenuDefinition object.
 

Method Summary
public LocalizationIntersectionId
getLocalizationIntersectionId()
Returns the LocalizationIntersectionId for this menu.
public LocalizationResource
getLocalizationResource()
Returns the LocalizationResource associated with this menu based on the locale of the request used for retrieving the menu.
public MarkupDefinitionId
getMarkupDefinitionId()
Returns the MarkupDefinitionId for this MarkupDefinition associated with this menu.
public MenuDefinitionId
getMenuDefinitionId()
Returns the MenuDefinitionId for this menu.
public String
getMenuFile()
Returns the path to the menu file.
public String
getWebAppName()
Returns the web application name this menu is scoped to.
public boolean
isDeleted()
Returns whether this menu is deleted.
public void
setDeleted(boolean deleted)
Sets whether this menu is deleted
public void
setLocalizationResource(LocalizationResource localizationResource)
Sets the LocalizationResource for this menu.
public void
setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
Sets the MarkupDefinition for this menu.
public void
setMenuFile(String menuFile)
Sets the menu file path
public void
setWebAppName(String webAppName)
Scopes this menu to given web applcation.
public String
toString()
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
   

Constructor Detail

MenuDefinition

public MenuDefinition(LocalizationResource localizationResource, 
                      MarkupDefinitionId markupDefinitionId, 
                      String webAppName, 
                      String menuFile, 
                      boolean deleted)
Constructs a new MenuDefinition object.
 

Method Detail

getLocalizationIntersectionId() Method

public LocalizationIntersectionId getLocalizationIntersectionId()
Returns the LocalizationIntersectionId for this menu. Returns NULL if no LocalizationResource is associated with this menu. A LocalizationIntersectionId is a reference to all localized versions of title and description for an entity.

Returns

LocalizationIntersectionId for this menu

getLocalizationResource() Method

public LocalizationResource getLocalizationResource()
Returns the LocalizationResource associated with this menu based on the locale of the request used for retrieving the menu.

Returns

LocalizationResource associated with this menu

getMarkupDefinitionId() Method

public MarkupDefinitionId getMarkupDefinitionId()
Returns the MarkupDefinitionId for this MarkupDefinition associated with this menu.

Returns

MarkupDefinitionId

Related Topics

MarkupDefinition

getMenuDefinitionId() Method

public MenuDefinitionId getMenuDefinitionId()
Returns the MenuDefinitionId for this menu. Returns NULL if this menu has not been retrieved using the persistence API.

Returns

MenuDefinitionId

getMenuFile() Method

public String getMenuFile()
Returns the path to the menu file. This path is relative to the web application context.

Returns

menu file path

getWebAppName() Method

public String getWebAppName()
Returns the web application name this menu is scoped to.

Returns

web application name

isDeleted() Method

public boolean isDeleted()
Returns whether this menu is deleted.

Returns

true if this menu is deleted

setDeleted(boolean) Method

public void setDeleted(boolean deleted)
Sets whether this menu is deleted

setLocalizationResource(LocalizationResource) Method

public void setLocalizationResource(LocalizationResource localizationResource)
Sets the LocalizationResource for this menu.

setMarkupDefinitionId(MarkupDefinitionId) Method

public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
Sets the MarkupDefinition for this menu.

setMenuFile(String) Method

public void setMenuFile(String menuFile)
Sets the menu file path

setWebAppName(String) Method

public void setWebAppName(String webAppName)
Scopes this menu to given web applcation.

toString() Method

public String toString()
Overrides
Object.toString()