|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.portal.tools.portal.actions.PortalControlAction com.bea.portal.tools.portal.actions.BookInstanceAction
public class BookInstanceAction
Objects extending this class implement actions to be taken on portal controls. These may be used to specify multiple actions which need to occur in a single transactioni by calling the Portal controls' executeActions() method.
Method Summary | |
---|---|
static BookInstanceAction |
addNavigable(BookInstanceControl control,
NavigableDefinitionId navigableToAddId,
int position,
BookInstanceId targetBookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath)
Adds a child page or book (a navigable) to the specified book when the action is executed. |
void |
doAction(ResourceContext context)
Method that actually performs the action on the control. |
static BookInstanceAction |
moveNavigable(BookInstanceControl control,
NavigableInstanceId navigableToMoveId,
int position,
BookInstanceId parentBookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath)
Moves a child book or page (a navigable) within the specified book when the action is executed. |
static BookInstanceAction |
removeNavigable(BookInstanceControl control,
NavigableInstanceId navigableToRemoveId,
BookInstanceId parentBookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath)
Removes a child book or page (a navigable) from the specified book when the action is executed. |
static BookInstanceAction |
rename(BookInstanceControl control,
String title,
BookInstanceId parentBookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath)
Resets the title of the book instance when the action is executed. |
static BookInstanceAction |
setDefaultNavigable(BookInstanceControl control,
NavigableInstanceId navigableId,
BookInstanceId bookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath)
Sets the default navigable for a book when the action is executed. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static BookInstanceAction addNavigable(BookInstanceControl control, NavigableDefinitionId navigableToAddId, int position, BookInstanceId targetBookId, String webApp, PortalPath portalPath, DesktopPath desktopPath)
control
- the control to execute the action on.navigableToAddId
- the id of the page or book to addposition
- the position of the child within the booktargetBookId
- the ID of the book to add the navigable towebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathpublic static BookInstanceAction removeNavigable(BookInstanceControl control, NavigableInstanceId navigableToRemoveId, BookInstanceId parentBookId, String webApp, PortalPath portalPath, DesktopPath desktopPath)
control
- the control to execute the action on.navigableToRemoveId
- the id of the page or book to removeparentBookId
- the ID of the book to remove the navigable fromwebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathpublic static BookInstanceAction moveNavigable(BookInstanceControl control, NavigableInstanceId navigableToMoveId, int position, BookInstanceId parentBookId, String webApp, PortalPath portalPath, DesktopPath desktopPath)
control
- the control to execute the action on.navigableToMoveId
- the id of the page or book to moveposition
- the new position of the child within the bookparentBookId
- the ID of the book to move the navigable inwebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathpublic static BookInstanceAction rename(BookInstanceControl control, String title, BookInstanceId parentBookId, String webApp, PortalPath portalPath, DesktopPath desktopPath)
control
- the control to execute the action on.title
- the new title for the book instanceparentBookId
- the ID of the book to renamewebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathpublic static BookInstanceAction setDefaultNavigable(BookInstanceControl control, NavigableInstanceId navigableId, BookInstanceId bookId, String webApp, PortalPath portalPath, DesktopPath desktopPath)
control
- the control to execute the action on.navigableId
- the id of the page or book that will be the defaultbookId
- the id of the book to set the default navigable for.webApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathpublic void doAction(ResourceContext context) throws Exception
doAction
in interface ControlAction
doAction
in class PortalControlAction
Exception
public String toString()
toString
in class Object
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |