This is the primary interface for performing persistent store operations
on BookInstance
objects. In general this interface provides coarse grain
getters and fine grain setters.
It is important to note that all methods on this interface are fully internationalized and entitled. All titles and descriptions on the objects returned by these methods are internationalized to the prefered locale. Also, all methods are entitled, meaning if the caller does not have the required credentials the method may return a subset of the actual list or be unable to perform the specified function.
Most "Instances" can be thought of as objects tied to a desktop, An Admin has instances derived from the Library Definition, and the "end user" has instances derived from the admin instance. Changes made via these APIs require a DesktopDefinitionId and the changes are scoped to that desktop. In other words changes made here do not affect the Library or other Desktops. If the "visitorMode" on the customization Context is set the false (default) and the user executing the call is in the "Admin" or "PortalSystemAdministrator" role then these changes take affect at the admin level, and affect ALL users. If the visitorMode is false then the changes only affect the calling user.Related Topics
CustomizationContext.setVisitorMode(boolean)
PortalCustomizationManager
Method Summary |
public |
|
public |
|
public |
|
public |
|
public void |
|
public void |
|
public |
|
Method Detail |
publicNavigableInstance
addNavigable(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,BookInstanceId
bookInstanceId,NavigableDefinitionId
navigableDefinitionId, int position, int align)
throwsRemoteException
,ObjectNotFoundException
,MissingDataException
,NotEntitledException
,IllegalDependencyException
Add a NavigableDefinition
(BookDefinition or PageDefinition) to the supplied
Book Instance. This is the method you want to call if you want to add a page to a book for
a particular user or if you are an admin effect all user.
RemoteException
ObjectNotFoundException
MissingDataException
NotEntitledException
IllegalDependencyException
Related Topics
CustomizationContext.setVisitorMode(boolean)
publicBookInstance
getBookInstance(CustomizationContext
customizationContext,BookInstanceId
bookInstanceId)
throwsRemoteException
Getter for returning a BookInstance
identified by the supplieed instance id.
BookInstance
objects if it exist, otherwisez null. RemoteException
publicBookView
getBookView(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,BookInstanceId
bookInstanceId)
throwsRemoteException
Getter for returning an immutable deep copy of a BookView. The BookView
object, unlike the BookDefinition
or the BookInstance
objects
contains a deep copy of all references to all child pages, books and so on. The
BookView
object however is immutable.
RemoteException
Related Topics
IBookDefinitionManager.getBookView(CustomizationContext, BookDefinitionId)
publicNavigableInstance
moveNavigable(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,BookInstanceId
fromParentBookInstanceId,BookInstanceId
toParentBookInstanceId,NavigableInstanceId
navigableInstanceId, int position, int alignment)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
,IllegalDependencyException
Relocate the navigable (child book or page) instance to a new location on the parent book.
RemoteException
ObjectNotFoundException
NotEntitledException
IllegalDependencyException
Related Topics
CustomizationContext.setVisitorMode(boolean)
public void removeNavigable(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,NavigableInstance
navigableInstance)
throwsRemoteException
,ObjectNotFoundException
,MissingDataException
,NotEntitledException
Remove a navigable (child book or page) from the specified parent book. This method does not delete the navigable it just removes it from the parent book.
RemoteException
ObjectNotFoundException
MissingDataException
NotEntitledException
Related Topics
CustomizationContext.setVisitorMode(boolean)
public void setDefaultNavigable(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,BookInstanceId
bookInstanceId,NavigableInstanceId
navigableInstanceId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Set the default navigable (child book or book) on a the parent book.
RemoteException
ObjectNotFoundException
NotEntitledException
publicBookInstance
updateBookInstance(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,BookInstance
bookInstance)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Update the persistent store for the supplied BookInstance
. All attributes of the BookInstance
are updated in persistent store.
RemoteException
ObjectNotFoundException
NotEntitledException