|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
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.BookDefinitionAction
public class BookDefinitionAction
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 BookDefinitionAction |
addNavigable(BookDefinitionControl control, NavigableDefinitionId navigableToAddId, int position, BookDefinitionId targetBookId) Adds a child page or book (a navigable) to the specified book when the action is executed. |
static BookDefinitionAction |
createBookDefinition(BookDefinitionControl control, String title, String description, MenuDefinitionId menuDefinitionId, boolean _public, String webapp) |
static BookDefinitionAction |
deleteBookDefinition(BookDefinitionControl control, BookDefinitionId id, boolean cascadeDelete) Deletes the specified BookDefinition when the action is executed. |
void |
doAction(ResourceContext context) Method that actually performs the action on the control. |
static BookDefinitionAction |
moveNavigable(BookDefinitionControl control, NavigableDefinitionId navigableToMoveId, int position, BookDefinitionId parentBookId) Moves a child book or page (a navigable) within the specified book when the action is executed. |
static BookDefinitionAction |
removeNavigable(BookDefinitionControl control, NavigableDefinitionId navigableToRemoveId, BookDefinitionId parentBookId) Removes a child book or page (a navigable) from the specified 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 BookDefinitionAction addNavigable(BookDefinitionControl control, NavigableDefinitionId navigableToAddId, int position, BookDefinitionId targetBookId)
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 topublic static BookDefinitionAction removeNavigable(BookDefinitionControl control, NavigableDefinitionId navigableToRemoveId, BookDefinitionId parentBookId)
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 frompublic static BookDefinitionAction moveNavigable(BookDefinitionControl control, NavigableDefinitionId navigableToMoveId, int position, BookDefinitionId parentBookId)
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 inpublic static BookDefinitionAction deleteBookDefinition(BookDefinitionControl control, BookDefinitionId id, boolean cascadeDelete)
BookDefinition
when the action is executed. Use the cascadeDelete parameter to either delete just the definition (false), or to delete the defintions and all instances of in any desktops (true).control
- the control to execute the action on.id
- the ID of the book to delete.cascadeDelete
- if true
, all instances in any desktops of the specified definition are also deleted. If false
, only the definition is deleted.public static BookDefinitionAction createBookDefinition(BookDefinitionControl control, String title, String description, MenuDefinitionId menuDefinitionId, boolean _public, String webapp)
public 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.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.