com.ibm.portal.portlet
Interface PortletModelController

All Superinterfaces:

Committable, CommonPortletModelController, Controller, Disposable, LocatorProvider<Identifiable>, ModelController<Identifiable,ModifiableIdentifiable>, PortletModel

public interface PortletModelController
extends CommonPortletModelController, PortletModel, Committable

A controller interface for the PortletModel interface.

Since:

6.1.0

Method Summary

boolean	confirmInsert(PortletDefinition aNode) Indicates if the specified portlet definition may be inserted at the specified location in the portlet model.
boolean	confirmInsert(PortletEntity aNode, Identifiable aParent) Indicates if a portlet entity may be inserted at the specified location in the portlet model.
boolean	confirmInsert(PortletWindow aNode) Indicates if a portlet entity may be inserted at the specified location in the portlet model.
ModifiableIdentifiable	create(java.lang.Class aNodeClass, CreationContext aContext) Creates a modifiable node and inserts it into the model.

Methods inherited from interface com.ibm.portal.portlet.CommonPortletModelController

confirmDelete, delete

Methods inherited from interface com.ibm.portal.ModelController

confirmCreate, confirmGetModifiableNode, getModifiableNode, resolve

Methods inherited from interface com.ibm.portal.LocatorProvider

getLocator

Methods inherited from interface com.ibm.portal.portletmodel.PortletModel

getParentPortletEntity, getPortlet, getPortletDefinition, getPortletDefinition, getPortletEntity, getPortletWindow, getPreferencesHierarchy, getPreferencesHierarchy, getWebApplication

Methods inherited from interface com.ibm.portal.Committable

commit, dispose

Method Detail

create

ModifiableIdentifiable create(java.lang.Class aNodeClass,
                              CreationContext aContext)
                              throws CannotInstantiateModifiableNodeException

Creates a modifiable node and inserts it into the model.

Specified by:

create in interface CommonPortletModelController

Specified by:

create in interface ModelController<Identifiable,ModifiableIdentifiable>

Parameters:

aNodeClass - interface class of node to insert. A PortletModelController supports creation of the following objects:

• PortletEntity
• PortletDefinition (aka cloning)

aContext - a context specifying information about the node to create, may be null

Returns:

a modifiable node;

Throws:

CannotInstantiateModifiableNodeException - in case the modifiable node cannot be instantiated

confirmInsert

boolean confirmInsert(PortletWindow aNode)
                      throws ObjectNotFoundException

Indicates if a portlet entity may be inserted at the specified location in the portlet model.

Parameters:

aNode - node to affirm insertion for

Returns:

true in case the node may be inserted, false otherwise

Throws:

ObjectNotFoundException - in case one or more specified nodes cannot be found

confirmInsert

boolean confirmInsert(PortletEntity aNode,
                      Identifiable aParent)
                      throws ObjectNotFoundException

Indicates if a portlet entity may be inserted at the specified location in the portlet model.

Parameters:

aNode - node to affirm insertion for

aParent - parent node; may be null. must be of type PortletEntity or PortletDefinition

Returns:

true in case the node may be inserted, false otherwise

Throws:

ObjectNotFoundException - in case one or more specified nodes cannot be found

confirmInsert

boolean confirmInsert(PortletDefinition aNode)
                      throws ObjectNotFoundException

Indicates if the specified portlet definition may be inserted at the specified location in the portlet model.

Parameters:

aNode - node to affirm insertion for

Returns:

true in case the node may be inserted, false otherwise

Throws:

ObjectNotFoundException - in case one or more specified nodes cannot be found