# com.bea.netuix.application.definition
BookDefinition Class

public class BookDefinition
extends `Object`
implements `NavigableDefinition`, `PlaceableDefinition`, `Serializable`

This class represents a persistant book.

Hierarchy
  `Object`
  `BookDefinition`

All Implemented Interfaces
  `NavigableDefinition`, `PlaceableDefinition`, `Serializable`

## Field Summary

`protected `BookInstance`` | `bookInstance` BookInstance

## Constructor Summary

BookDefinition(`LocalizationResource` localizationResource, `MarkupDefinitionId` markupDefinitionId, `String` definitionLabel, boolean hidden, boolean _public, `String` webAppName, `MenuDefinitionId` menuDefinitionId, `ThemeDefinitionId` themeDefinitionId, short menuOrientation) Constructs a new `BookDefinition` object.
BookDefinition(`LocalizationResource` localizationResource, `MarkupDefinitionId` markupDefinitionId, `String` definitionLabel, boolean hidden, boolean _public, `String` webAppName, `BookInstance` bookInstance) Constructor that takes a `BookInstance```

## Method Summary

`public `BookDefinitionId`` | `getBookDefinitionId`() Returns the `BookDefinitionId` for this book.
`public `String`` | `getDefinitionLabel`() Returns the definitionLabel associated with this book.
`public `String`` | `getDescription`() Retrieves this book's localized description from it's `LocalizationResource`.
`public `LocalizationIntersectionId`` | `getLocalizationIntersectionId`() Returns the `LocalizationIntersectionId` for this book.
`public `LocalizationResource`` | `getLocalizationResource`() Returns the `LocalizationResource` associated with this `BookDefinition` based on the locale of the request used for retrieving the `BookDefinition`.
`public `MarkupDefinitionId`` | `getMarkupDefinitionId`() Returns the `MarkupDefinitionId` for the `MarkupDefinition` associated with this book.
`public `MenuDefinitionId`` | `getMenuDefinitionId`() Returns `MenuDefinitionId` for menu associated with this `BookDefinition`
`public short` | `getMenuOrientation`() Returns the menu orientation for this `BookDefinition`
`public `NavigableDefinitionId`` | `getNavigableDefinitionId`() Returns the `NavigableDefinitionId` associated with this book.
`public `PlaceableDefinitionId`` | `getPlaceableDefinitionId`() Returns the `PlaceableDefinitionId` associated with this book.
`public `PlacementId`` | `getPlacementId`() Returns the `PlacementId` for this book.
`public `BookInstanceId`` | `getPrimaryInstanceId`() Returns the `BookInstanceId` for the primary book instance associated with this book.
`public `ThemeDefinitionId`` | `getThemeDefinitionId`() Returns the `ThemeDefinitionId` of theme associated with this `BookDefinition`.
`public `String`` | `getTitle`() Retrieves this book's localized title from it's `LocalizationResource`.
`public `String`` | `getWebAppName`() Returns the name of the J2EE web application this book is scoped to.
`public boolean` | `isHidden`() Returns true if this book is configured to not be rendered.
`public boolean` | `isPublic`() Returns whether this book is end-user created.
`public void` | `setDefinitionLabel`(`String` definitionLabel) Sets the definitionLabel for this book.
`public void` | `setHidden`(boolean hidden) Sets whether or not this book renders.
`public void` | `setLocalizationResource`(`LocalizationResource` localizationResource) Sets the `LocalizationResource` for this book.
`public void` | `setMarkupDefinitionId`(`MarkupDefinitionId` markupDefinitionId) Sets the `MarkupDefinitionId` for this book.
`public void` | `setMenuDefinitionId`(`MenuDefinitionId` menuDefinitionId) Associates a menu with this book.
`public void` | `setMenuOrientation`(short menuOrientation) Sets the menu orientation for this book
`public void` | `setPublic`(boolean _public) Sets whether this book is end-user created.
`public void` | `setThemeDefinitionId`(`ThemeDefinitionId` themeDefinitionId) Associates a theme with this book.
`public void` | `setWebAppName`(`String` webAppName) Scopes this book to specified J2EE web application
`public `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 from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods from interface `com.bea.netuix.application.definition.`NavigableDefinition``
``getBookGroupId`, `getDefinitionLabel`, `getDescription`, `getLocalizationResource`, `getNavigableDefinitionId`, `getTitle`, `getWebAppName`, `isHidden``

Methods from interface `com.bea.netuix.application.definition.`PlaceableDefinition``
``getDefinitionLabel`, `getDescription`, `getLocalizationResource`, `getPlaceableDefinitionId`, `getPlacementId`, `getTitle`, `getWebAppName``

## Field Detail

### bookInstance

    protected BookInstance bookInstance

## Constructor Detail

### BookDefinition

    public BookDefinition(LocalizationResource localizationResource,
                          MarkupDefinitionId markupDefinitionId,
                          String definitionLabel,
                          boolean hidden,
                          boolean _public,
                          String webAppName,
                          MenuDefinitionId menuDefinitionId,
                          ThemeDefinitionId themeDefinitionId,
                          short menuOrientation)

  Constructs a new `BookDefinition` object.

### BookDefinition

    protected BookDefinition(LocalizationResource localizationResource,
                             MarkupDefinitionId markupDefinitionId,
                             String definitionLabel,
                             boolean hidden,
                             boolean _public,
                             String webAppName,
                             BookInstance bookInstance)

  Constructor that takes a `BookInstance```

## Method Detail

### getBookDefinitionId() Method

    public BookDefinitionId getBookDefinitionId()

Returns the `BookDefinitionId` for this book. Returns `NULL` when the BookDefinition has not been retrieved by using the persistence API.

#### Returns

`BookDefinitionId` for this book

### getDefinitionLabel() Method

    public String getDefinitionLabel()

Returns the definitionLabel associated with this book.

#### Returns

definitionLabel for this book

### getDescription() Method

    public String getDescription()

Retrieves this book's localized description from it's `LocalizationResource`.

#### Returns

localized description for this book

### getLocalizationIntersectionId() Method

    public LocalizationIntersectionId getLocalizationIntersectionId()

Returns the `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.

#### Returns

`LocalizationIntersectionId` for this book

### getLocalizationResource() Method

    public LocalizationResource getLocalizationResource()

Returns the `LocalizationResource` associated with this `BookDefinition` based on the locale of the request used for retrieving the `BookDefinition`.

#### Returns

`LocalizationResource` associated with this book

### getMarkupDefinitionId() Method

    public MarkupDefinitionId getMarkupDefinitionId()

Returns the `MarkupDefinitionId` for the `MarkupDefinition` associated with this book.

#### Returns

`MarkupDefinitionId`

Related Topics

``MarkupDefinition``

### getMenuDefinitionId() Method

    public MenuDefinitionId getMenuDefinitionId()

Returns `MenuDefinitionId` for menu associated with this `BookDefinition`

#### Returns

`MenuDefinitionId`

### getMenuOrientation() Method

    public short getMenuOrientation()

Returns the menu orientation for this `BookDefinition`

#### Returns

menu orientation

### getNavigableDefinitionId() Method

    public NavigableDefinitionId getNavigableDefinitionId()

Returns the `NavigableDefinitionId` associated with this book. Returns `NULL` when the BookDefinition has not been retrieved by using the persistence API.

#### Returns

`NaviagableDefinitionId` associated with this book

Related Topics

``NavigableDefinition``

### getPlaceableDefinitionId() Method

    public PlaceableDefinitionId getPlaceableDefinitionId()

Returns the `PlaceableDefinitionId` associated with this book. Returns `NULL` when the BookDefinition has not been retrieved by using the persistence API.

#### Returns

`PlaceableDefinitionId` associated with this book

Related Topics

``PlaceableDefinition``

### getPlacementId() Method

    public PlacementId getPlacementId()

Returns the `PlacementId` for this book. May be `NULL` if this book is not placed or if it has not been retrieved using the persistence API.

#### Returns

`PlacementId` for this book

### getPrimaryInstanceId() Method

    public BookInstanceId getPrimaryInstanceId()

Returns the `BookInstanceId` for the primary book instance associated with this book.

#### Returns

BookInstanceId

### getThemeDefinitionId() Method

    public ThemeDefinitionId getThemeDefinitionId()

Returns the `ThemeDefinitionId` of theme associated with this `BookDefinition`.

#### Returns

`ThemeDefinitionId`

### getTitle() Method

    public String getTitle()

Retrieves this book's localized title from it's `LocalizationResource`.

#### Returns

localized title for this book

### getWebAppName() Method

    public String getWebAppName()

Returns the name of the J2EE web application this book is scoped to.

#### Returns

name of web application

### isHidden() Method

    public boolean isHidden()

Returns true if this book is configured to not be rendered.

#### Returns

true if `BookDefinition` is hidden

### isPublic() Method

    public boolean isPublic()

Returns whether this book is end-user created.

#### Returns

true if this book is end-user created.

### setDefinitionLabel(String) Method

    public void setDefinitionLabel(String definitionLabel)

Sets the definitionLabel for this book.

### setHidden(boolean) Method

    public void setHidden(boolean hidden)

Sets whether or not this book renders.

#### Parameters

hidden
  configures this book to not render if set to true

### setLocalizationResource(LocalizationResource) Method

    public void setLocalizationResource(LocalizationResource localizationResource)

Sets the `LocalizationResource` for this book.

### setMarkupDefinitionId(MarkupDefinitionId) Method

    public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)

Sets the `MarkupDefinitionId` for this book.

### setMenuDefinitionId(MenuDefinitionId) Method

    public void setMenuDefinitionId(MenuDefinitionId menuDefinitionId)

Associates a menu with this book.

#### Parameters

menuDefinitionId
  of menu associated with this book

### setMenuOrientation(short) Method

    public void setMenuOrientation(short menuOrientation)

Sets the menu orientation for this book

### setPublic(boolean) Method

    public void setPublic(boolean _public)

Sets whether this book is end-user created.

### setThemeDefinitionId(ThemeDefinitionId) Method

    public void setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)

Associates a theme with this book.

#### Parameters

themeDefinitionId
  of theme associated with this book

### setWebAppName(String) Method

    public void setWebAppName(String webAppName)

Scopes this book to specified J2EE web application

#### Parameters

webAppName
  name of the web application to scope this book to

### toString() Method

    public 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

Overrides
  `Object.toString()`