|
Copyright © 2000, 2009, 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.BookDefinition
public class BookDefinition
This class represents a persistent book.
Field Summary | |
---|---|
protected BookInstance |
bookInstance
|
Fields inherited from interface com.bea.netuix.application.definition.ProxiedDefinition |
---|
HAS_PROXY_INFO, NO_PROXY_INFO, NOT_AVAILABLE |
Constructor Summary | |
---|---|
protected |
BookDefinition(LocalizationResource localizationResource,
MarkupDefinitionId markupDefinitionId,
String definitionLabel,
boolean hidden,
boolean _public,
String webAppName,
BookInstance bookInstance)
Constructor that takes a BookInstance |
|
BookDefinition(LocalizationResource localizationResource,
MarkupDefinitionId markupDefinitionId,
String definitionLabel,
boolean hidden,
boolean _public,
String webAppName,
MenuDefinitionId menuDefinitionId,
ThemeDefinitionId themeDefinitionId,
short menuOrientation)
Constructs a new BookDefinition object. |
Method Summary | |
---|---|
BookDefinitionId |
getBookDefinitionId()
Returns the BookDefinitionId for this book. |
Date |
getCreatedDate()
Gets the time that this object was created in the database. |
String |
getDefinitionLabel()
Returns the definitionLabel associated with this book. |
String |
getDescription()
Retrieves this book's localized description from its LocalizationResource . |
LocalizationIntersectionId |
getLocalizationIntersectionId()
Returns the LocalizationIntersectionId for this book. |
LocalizationResource |
getLocalizationResource()
Returns the LocalizationResource associated with this
BookDefinition based on the locale of the request used
for retrieving the BookDefinition . |
MarkupDefinitionId |
getMarkupDefinitionId()
Returns the MarkupDefinitionId for the MarkupDefinition
associated with this book. |
MenuDefinitionId |
getMenuDefinitionId()
Returns MenuDefinitionId for menu associated with this
BookDefinition |
short |
getMenuOrientation()
Returns the menu orientation for this BookDefinition |
Date |
getModifiedDate()
Gets the time that this object was last updated in the database. |
NavigableDefinitionId |
getNavigableDefinitionId()
Returns the NavigableDefinitionId associated with this book. |
PlaceableDefinitionId |
getPlaceableDefinitionId()
Returns the PlaceableDefinitionId associated with this book. |
PlacementId |
getPlacementId()
Returns the PlacementId for this book. |
BookInstanceId |
getPrimaryInstanceId()
Returns the BookInstanceId for the primary
book instance associated with this book. |
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
BookDefinition . |
String |
getTitle()
Retrieves this book's localized title from its LocalizationResource . |
String |
getWebAppName()
Returns the name of the J2EE web application this book is scoped to. |
byte |
hasProxyInfo()
Returns one of NOT_AVAILABLE , HAS_PROXY_INFO
or NO_PROXY_INFO . |
boolean |
isHidden()
Returns true if this book is configured to not be rendered. |
boolean |
isPublic()
Returns whether this book is end-user created. |
void |
setDefinitionLabel(String definitionLabel)
Sets the definitionLabel for this book. |
void |
setHidden(boolean hidden)
Sets whether or not this book renders. |
void |
setLocalizationResource(LocalizationResource localizationResource)
Sets the LocalizationResource for this book. |
void |
setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
Sets the MarkupDefinitionId for this book. |
void |
setMenuDefinitionId(MenuDefinitionId menuDefinitionId)
Associates a menu with this book. |
void |
setMenuOrientation(short menuOrientation)
Sets the menu orientation for this book |
void |
setPublic(boolean _public)
Sets whether this book is end-user created. |
void |
setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)
Associates a theme with this book. |
void |
setWebAppName(String webAppName)
Scopes this book to specified J2EE web application |
String |
toString()
Returns a concatenated string representation of BookDefinitionId(int) Title Description MarkupDefinitionId(int) Definition Label isHidden(true or false) isPublic(true or false) Web app name |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected BookInstance bookInstance
Constructor Detail |
---|
public BookDefinition(LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String definitionLabel, boolean hidden, boolean _public, String webAppName, MenuDefinitionId menuDefinitionId, ThemeDefinitionId themeDefinitionId, short menuOrientation)
BookDefinition
object.
localizationResource
- localized title and descriptionmarkupDefinitionId
- reference to a persisted MarkupDefinition
that specifies the markup for this bookdefinitionLabel
- uniquely identifies this book in
non-persistent modehidden
- this book is not rendered if this
attribute is true_public
- specifies that this book is created by an end user
if set to truewebAppName
- name of the J2EE web application that
this book is scoped tomenuDefinitionId
- reference to a persisted MenuDefinition
that is the menu for this bookthemeDefinitionId
- reference to a persisted ThemeDefinition
that is the theme for this bookmenuOrientation
- orientation of the menu as defined by
protected BookDefinition(LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String definitionLabel, boolean hidden, boolean _public, String webAppName, BookInstance bookInstance)
BookInstance
localizationResource
- localized title and descriptionmarkupDefinitionId
- a reference to persisted MarkupDefinition
that specifies the markup for this bookdefinitionLabel
- uniquely identifies this book in
non-persistent modehidden
- this book is not rendered if this
attribute is true_public
- specifies that this book is created by an end user
if set to truewebAppName
- name of the J2EE web application that
this book is scoped tobookInstance
- Method Detail |
---|
public NavigableDefinitionId getNavigableDefinitionId()
NavigableDefinitionId
associated with this book.
Returns null when the BookDefinition has not been retrieved
by using the persistence API.
getNavigableDefinitionId
in interface NavigableDefinition
NaviagableDefinitionId
associated with this bookNavigableDefinition
public PlaceableDefinitionId getPlaceableDefinitionId()
PlaceableDefinitionId
associated with this book.
Returns null when the BookDefinition has not been retrieved
by using the persistence API.
getPlaceableDefinitionId
in interface PlaceableDefinition
PlaceableDefinitionId
associated with this bookPlaceableDefinition
public BookDefinitionId getBookDefinitionId()
BookDefinitionId
for this book.
Returns null when the BookDefinition has not been retrieved
by using the persistence API.
BookDefinitionId
for this bookpublic MarkupDefinitionId getMarkupDefinitionId()
MarkupDefinitionId
for the MarkupDefinition
associated with this book.
MarkupDefinitionId
MarkupDefinition
public PlacementId getPlacementId()
PlacementId
for this book.
May be null if this book is not placed
or if it has not been retrieved using the persistence API.
PlacementId
for this bookpublic LocalizationIntersectionId getLocalizationIntersectionId()
LocalizationIntersectionId
for this book.
Returns null if no LocalizationResource is associated with
this book. A LocalizationIntersectionId
is a reference to all
localized versions of title and description for an entity.
LocalizationIntersectionId
for this bookpublic void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
MarkupDefinitionId
for this book.
markupDefinitionId
- public LocalizationResource getLocalizationResource()
LocalizationResource
associated with this
BookDefinition
based on the locale of the request used
for retrieving the BookDefinition
.
getLocalizationResource
in interface NavigableDefinition
getLocalizationResource
in interface PlaceableDefinition
LocalizationResource
associated with this bookpublic void setLocalizationResource(LocalizationResource localizationResource)
LocalizationResource
for this book.
localizationResource
- public String getDefinitionLabel()
getDefinitionLabel
in interface NavigableDefinition
getDefinitionLabel
in interface PlaceableDefinition
public void setDefinitionLabel(String definitionLabel)
definitionLabel
- public boolean isHidden()
isHidden
in interface NavigableDefinition
BookDefinition
is hiddenpublic void setHidden(boolean hidden)
hidden
- configures this book to not
render if set to truepublic boolean isPublic()
public void setPublic(boolean _public)
_public
- public String getWebAppName()
getWebAppName
in interface NavigableDefinition
getWebAppName
in interface PlaceableDefinition
public void setWebAppName(String webAppName)
webAppName
- name of the web application to scope this book topublic short getMenuOrientation()
BookDefinition
public void setMenuOrientation(short menuOrientation)
menuOrientation
- public MenuDefinitionId getMenuDefinitionId()
MenuDefinitionId
for menu associated with this
BookDefinition
MenuDefinitionId
public void setMenuDefinitionId(MenuDefinitionId menuDefinitionId)
menuDefinitionId
- of menu associated with this bookpublic ThemeDefinitionId getThemeDefinitionId()
ThemeDefinitionId
of theme associated with this
BookDefinition
.
ThemeDefinitionId
public void setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)
themeDefinitionId
- of theme associated with this bookpublic BookInstanceId getPrimaryInstanceId()
BookInstanceId
for the primary
book instance associated with this book.
public String getTitle()
LocalizationResource
.
getTitle
in interface NavigableDefinition
getTitle
in interface PlaceableDefinition
public String getDescription()
LocalizationResource
.
getDescription
in interface NavigableDefinition
getDescription
in interface PlaceableDefinition
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
String
representation of this BookDefinition
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |