com.ibm.portal.portlet
Interface PortletModelController

All Superinterfaces:

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

public interface PortletModelController
extends PortletModel, ModelController<Identifiable,ModifiableIdentifiable>, Committable

A controller interface for the PortletModel interface.

Since:

6.1.0

Method Summary

boolean	confirmDelete(Identifiable aNode) Indicates if the specified node may be deleted from the model.
boolean	com.ibm.portal.portletmodel.PortletDefinition)">confirmInsert(PortletDefinition aNode) Indicates if the specified portlet entity may be inserted at the specified location in the portlet model.
boolean	com.ibm.portal.portletmodel.PortletEntity, com.ibm.portal.Identifiable)">confirmInsert(PortletEntity aNode, Identifiable aParent) Indicates if a portlet entity may be inserted at the specified location in the portlet model.
boolean	com.ibm.portal.portletmodel.PortletWindow)">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.
void	delete(Identifiable aNode) Deletes a node from the model.

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

com.ibm.portal.portletmodel.PortletEntity)">getParentPortletEntity, getPortlet, getPortletDefinition, getPortletDefinition, getPortletEntity, com.ibm.portal.content.LayoutControl)">getPortletWindow, getPreferencesHierarchy, getPreferencesHierarchy, getWebApplication

Methods inherited from interface com.ibm.portal.ModelController

confirmCreate, getModifiableNode, resolve

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 ModelController<Identifiable,ModifiableIdentifiable>

Parameters:

aNodeClass - interface class of node to insert

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

delete

void delete(Identifiable aNode)
            throws ObjectNotFoundException,
                   CannotDeleteNodeException

Deletes a node from the model. All its children are deleted as well.

Parameters:

aNode - the node to delete from the model.

Throws:

ObjectNotFoundException - in case the node cannot be found

CannotDeleteNodeException - in case the node cannot be deleted

com.ibm.portal.portletmodel.PortletWindow)">

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

com.ibm.portal.portletmodel.PortletEntity, com.ibm.portal.Identifiable)">

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

com.ibm.portal.portletmodel.PortletDefinition)">

confirmInsert

boolean confirmInsert(PortletDefinition aNode)
                      throws ObjectNotFoundException

Indicates if the specified 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

confirmDelete

boolean confirmDelete(Identifiable aNode)
                      throws ObjectNotFoundException

Indicates if the specified node may be deleted from the model.

Parameters:

aNode - node to affirm deletion for.

Returns:

true if the node can be deleted, false otherwise

Throws:

ObjectNotFoundException - in case the node cannot be found