# com.bea.netuix.application.instance
BookInstance Class

public class BookInstance
extends `Object`
implements `NavigableInstance`, `PlaceableInstance`, `Serializable`

Represents a customized version of a `BookDefinition`.

Hierarchy
  `Object`
  `BookInstance`

All Implemented Interfaces
  `NavigableInstance`, `PlaceableInstance`, `Serializable`

## Constructor Summary

BookInstance(`MenuDefinitionId` menuDefinitionId, `ThemeDefinitionId` themeDefinitionId, short menuOrientation, `String` instanceTitle) Constructor to create a new `BookInstance` object.

## Method Summary

`public `BookDefinition`` | `getBookDefinition`() Returns the `BookDefinition` that this book was created from.
`public `BookDefinitionId`` | `getBookDefinitionId`() Returns the `BookDefinitionId` for the `BookDefinition` that this book was created from.
`public `BookInstanceId`` | `getBookInstanceId`() Returns the `BookInstanceId` for this book.
`public `String`` | `getInstanceTitle`() Returns the instance title for this book.
`public `MenuDefinitionId`` | `getMenuDefinitionId`() Returns `MenuDefinitionId` for menu associated with this `BookInstance`
`public short` | `getMenuOrientation`() Returns the menu orientation for this `BookInstance`
`public `NavigableDefinition`` | `getNavigableDefinition`() Returns the `NavigableDefinition` associated with this book.
`public `NavigableDefinitionId`` | `getNavigableDefinitionId`() Returns the `NavigableDefinitionId` for the `NavigableDefinition`associated with this book.
`public `NavigableInstanceId`` | `getNavigableInstanceId`() Returns the `NavigableInstanceId` for the `NavigableInstance`associated with this book.
`public `PlaceableDefinition`` | `getPlaceableDefinition`() Returns the `PlaceableDefinition` associated with this book.
`public `PlaceableInstanceId`` | `getPlaceableInstanceId`() Returns the `PlaceableInstanceId` for the `PlaceableInstance`associated with this book.
`public `PlacementId`` | `getPlacementId`() Returns the `PlacementId` for this book.
`public `ThemeDefinitionId`` | `getThemeDefinitionId`() Returns the `ThemeDefinitionId` of theme associated with this `BookInstance`.
`public void` | `setInstanceTitle`(`String` instanceTitle) Sets the instance title 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` | `setThemeDefinitionId`(`ThemeDefinitionId` themeDefinitionId) Associates a theme with this book.

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `com.bea.netuix.application.instance.`NavigableInstance``
``getBookGroupId`, `getNavigableDefinition`, `getNavigableDefinitionId`, `getNavigableInstanceId``

Methods from interface `com.bea.netuix.application.instance.`PlaceableInstance``
``getPlaceableDefinition`, `getPlaceableInstanceId`, `getPlacementId``

## Constructor Detail

### BookInstance

    public BookInstance(MenuDefinitionId menuDefinitionId,
                        ThemeDefinitionId themeDefinitionId,
                        short menuOrientation,
                        String instanceTitle)

  Constructor to create a new `BookInstance` object.

## Method Detail

### getBookDefinition() Method

    public BookDefinition getBookDefinition()

Returns the `BookDefinition` that this book was created from. Returns `NULL` when the BookInstance has not been retrieved by using the persistence API.

#### Returns

`BookDefinition` for this book

### getBookDefinitionId() Method

    public BookDefinitionId getBookDefinitionId()

Returns the `BookDefinitionId` for the `BookDefinition` that this book was created from. Returns `NULL` when the BookInstance has not been retrieved by using the persistence API.

#### Returns

`BookDefinitionId` for this book

### getBookInstanceId() Method

    public BookInstanceId getBookInstanceId()

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

#### Returns

`BookInstanceId` for this book

### getInstanceTitle() Method

    public String getInstanceTitle()

Returns the instance title for this book.

#### Returns

instance title

### getMenuDefinitionId() Method

    public MenuDefinitionId getMenuDefinitionId()

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

#### Returns

`MenuDefinitionId`

### getMenuOrientation() Method

    public short getMenuOrientation()

Returns the menu orientation for this `BookInstance`

#### Returns

menu orientation

### getNavigableDefinition() Method

    public NavigableDefinition getNavigableDefinition()

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

#### Returns

`NaviagableDefinition` associated with this book

Related Topics

``NavigableDefinition``

### getNavigableDefinitionId() Method

    public NavigableDefinitionId getNavigableDefinitionId()

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

#### Returns

`NaviagableDefinitionId` associated with this book

Related Topics

``NavigableDefinition``

### getNavigableInstanceId() Method

    public NavigableInstanceId getNavigableInstanceId()

Returns the `NavigableInstanceId` for the `NavigableInstance`associated with this book. Returns `NULL` when the BookInstance has not been retrieved by using the persistence API.

#### Returns

`NaviagableInstanceId` associated with this book

Related Topics

``NavigableInstance``

### getPlaceableDefinition() Method

    public PlaceableDefinition getPlaceableDefinition()

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

#### Returns

`PlaceableDefinition` associated with this book

Related Topics

``PlaceableDefinition``

### getPlaceableInstanceId() Method

    public PlaceableInstanceId getPlaceableInstanceId()

Returns the `PlaceableInstanceId` for the `PlaceableInstance`associated with this book. Returns `NULL` when the BookInstance has not been retrieved by using the persistence API.

#### Returns

`PlaceableInstanceId` associated with this book

Related Topics

``PlaceableInstance``

### 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

### getThemeDefinitionId() Method

    public ThemeDefinitionId getThemeDefinitionId()

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

#### Returns

`ThemeDefinitionId`

### setInstanceTitle(String) Method

    public void setInstanceTitle(String instanceTitle)

Sets the instance title 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

### setThemeDefinitionId(ThemeDefinitionId) Method

    public void setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)

Associates a theme with this book.

#### Parameters

themeDefinitionId
  of theme associated with this book