|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.netuix.application.definition.PageDefinition
public class PageDefinition
This class represents a persistent page.
Field Summary | |
---|---|
protected PageInstance |
pageInstance
|
Fields inherited from interface com.bea.netuix.application.definition.ProxiedDefinition |
---|
HAS_PROXY_INFO, NO_PROXY_INFO, NOT_AVAILABLE |
Constructor Summary | |
---|---|
|
PageDefinition(LocalizationResource localizationResource,
MarkupDefinitionId markupDefinitionId,
String definitionLabel,
boolean hidden,
boolean _public,
String webAppName,
LayoutDefinitionId layoutDefinitionId,
ThemeDefinitionId themeDefinitionId)
Constructors to create a new PageDefinition object. |
protected |
PageDefinition(LocalizationResource localizationResource,
MarkupDefinitionId markupDefinitionId,
String definitionLabel,
boolean hidden,
boolean _public,
String webAppName,
PageInstance pageInstance)
Constructor that takes a PageInstance . |
Method Summary | |
---|---|
Date |
getCreatedDate()
Gets the time that this object was created in the database. |
String |
getDefinitionLabel()
Returns the definitionLabel associated with this page. |
String |
getDescription()
Retrieves this page's localized description from its LocalizationResource . |
LayoutDefinitionId |
getLayoutDefinitionId()
Returns LayoutDefinitionId for menu associated with this
LayoutDefinition |
LocalizationIntersectionId |
getLocalizationIntersectionId()
Returns the LocalizationIntersectionId for this page. |
LocalizationResource |
getLocalizationResource()
Returns the LocalizationResource associated with this
PageDefinition based on the locale of the request used
for retrieving the PageDefinition . |
MarkupDefinitionId |
getMarkupDefinitionId()
Returns the MarkupDefinitionId for the MarkupDefinition
associated with this page. |
Date |
getModifiedDate()
Gets the time that this object was last updated in the database. |
NavigableDefinitionId |
getNavigableDefinitionId()
Returns the NavigableDefinitionId associated with this page. |
PageDefinitionId |
getPageDefinitionId()
Returns the PageDefinitionId for this page. |
PageInstanceId |
getPrimaryInstanceId()
Returns the BookInstanceId for the primary
page instance associated with this page. |
String |
getProviderName()
Returns the name of the provider that provided the source entity that this proxied definition is created from |
Id |
getProxiedDefinitionId()
Returns the Id of this proxied definition. |
ThemeDefinitionId |
getThemeDefinitionId()
Returns the ThemeDefinitionId of theme associated with this
PageDefinition . |
String |
getTitle()
Retrieves this page's localized title from its LocalizationResource . |
String |
getWebAppName()
Returns the name of the J2EE web application this page is scoped to. |
byte |
hasProxyInfo()
Returns one of NOT_AVAILABLE , HAS_PROXY_INFO
or NO_PROXY_INFO . |
boolean |
isHidden()
Returns true if the owning book should display this page as a tab in a menu. |
boolean |
isPublic()
Returns whether this page is end-user created. |
void |
setDefinitionLabel(String definitionLabel)
Sets the definitionLabel for this page. |
void |
setHidden(boolean hidden)
Sets whether or not the owning book should display this page as a tab in a menu. |
void |
setLayoutDefinitionId(LayoutDefinitionId layoutDefinitionId)
Associates a layout with this page. |
void |
setLocalizationResource(LocalizationResource localizationResource)
Sets the LocalizationResource for this page. |
void |
setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
Sets the MarkupDefinitionId for this page. |
void |
setPublic(boolean _public)
Sets whether this page is end-user created. |
void |
setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)
Associates a theme with this page. |
void |
setWebAppName(String webAppName)
Scopes this page to specified J2EE web application |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected PageInstance pageInstance
Constructor Detail |
---|
public PageDefinition(LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String definitionLabel, boolean hidden, boolean _public, String webAppName, LayoutDefinitionId layoutDefinitionId, ThemeDefinitionId themeDefinitionId)
PageDefinition
object.
localizationResource
- localized title and descriptionmarkupDefinitionId
- reference to a persisted MarkupDefinition
that specifies the markup for this pagedefinitionLabel
- uniquely identifies this page in
non-persistent modehidden
- this page is not rendered if this
attribute is true_public
- specifies that this page is created by an end user
if set to truewebAppName
- name of the J2EE web application that
this page is scoped tolayoutDefinitionId
- reference to a persisted LayoutDefinition
that is the layout for this pagethemeDefinitionId
- reference to a persisted ThemeDefinition
that is the theme for this pageprotected PageDefinition(LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String definitionLabel, boolean hidden, boolean _public, String webAppName, PageInstance pageInstance)
PageInstance
.
localizationResource
- localized title and descriptionmarkupDefinitionId
- reference to a persisted MarkupDefinition
that specifies the markup for this pagedefinitionLabel
- uniquely identifies this page in
non-persistent modehidden
- this page is not rendered if this
attribute is true_public
- specifies that this page is created by an end user
if set to truewebAppName
- name of the J2EE web application that
this page is scoped topageInstance
- Method Detail |
---|
public PageDefinitionId getPageDefinitionId()
PageDefinitionId
for this page.
Returns null when the PageDefinition has not been retrieved
by using the persistence API.
PageDefinitionId
for this pagepublic NavigableDefinitionId getNavigableDefinitionId()
NavigableDefinitionId
associated with this page.
Returns null when the PageDefinition has not been retrieved
by using the persistence API.
getNavigableDefinitionId
in interface NavigableDefinition
NaviagableDefinitionId
associated with this pageNavigableDefinition
public LocalizationResource getLocalizationResource()
LocalizationResource
associated with this
PageDefinition
based on the locale of the request used
for retrieving the PageDefinition
.
getLocalizationResource
in interface NavigableDefinition
LocalizationResource
associated with this pagepublic LocalizationIntersectionId getLocalizationIntersectionId()
LocalizationIntersectionId
for this page.
Returns null if no LocalizationResource is associated with
this page. A LocalizationIntersectionId
is a reference to all
localized versions of title and description for an entity.
LocalizationIntersectionId
for this pagepublic void setLocalizationResource(LocalizationResource localizationResource)
LocalizationResource
for this page.
localizationResource
- public MarkupDefinitionId getMarkupDefinitionId()
MarkupDefinitionId
for the MarkupDefinition
associated with this page.
MarkupDefinitionId
MarkupDefinition
public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
MarkupDefinitionId
for this page.
markupDefinitionId
- public String getDefinitionLabel()
getDefinitionLabel
in interface NavigableDefinition
public void setDefinitionLabel(String definitionLabel)
definitionLabel
- public boolean isHidden()
isHidden
in interface NavigableDefinition
PageDefinition
is hiddenpublic void setHidden(boolean hidden)
hidden
- configures this page to not
render if set to truepublic boolean isPublic()
public void setPublic(boolean _public)
_public
- public String getWebAppName()
getWebAppName
in interface NavigableDefinition
public void setWebAppName(String webAppName)
webAppName
- name of the web application to scope this page topublic LayoutDefinitionId getLayoutDefinitionId()
LayoutDefinitionId
for menu associated with this
LayoutDefinition
LayoutDefinitionId
public void setLayoutDefinitionId(LayoutDefinitionId layoutDefinitionId)
layoutDefinitionId
- of menu associated with this pagepublic ThemeDefinitionId getThemeDefinitionId()
ThemeDefinitionId
of theme associated with this
PageDefinition
.
ThemeDefinitionId
public void setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)
themeDefinitionId
- of theme associated with this pagepublic PageInstanceId getPrimaryInstanceId()
BookInstanceId
for the primary
page instance associated with this page.
public String getTitle()
LocalizationResource
.
getTitle
in interface NavigableDefinition
public String getDescription()
LocalizationResource
.
getDescription
in interface NavigableDefinition
public Date getCreatedDate()
getCreatedDate
in interface DateableDefinition
public Date getModifiedDate()
getModifiedDate
in interface DateableDefinition
public String getProviderName()
ProxiedDefinition
getProviderName
in interface ProxiedDefinition
public byte hasProxyInfo()
ProxiedDefinition
NOT_AVAILABLE
, HAS_PROXY_INFO
or NO_PROXY_INFO
.
hasProxyInfo
in interface ProxiedDefinition
public Id getProxiedDefinitionId()
ProxiedDefinition
Id
of this proxied definition. Returns
NULL
if this entity is not a proxied definition
getProxiedDefinitionId
in interface ProxiedDefinition
Id
public String toString()
toString
in class Object
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |