com.ibm.portal
Interface Committable

All Superinterfaces:

Disposable

All Known Subinterfaces:

AdminPortletModelController, ClientListController<T,M>, CommittableListModelController<T,M>, CommittableTreeModelController<T,M>, ContentModelController<T,M>, MarkupListController<T,M>, OutboundConnectionModelController, PortletModelController, RatingModelController<R,M>, ResourceModelController<R,M>, SkinListController<T,M>, TagModelController<T,M>, ThemeListController<T,M>, VanityURLModelController<E,M>, WebdavCopyableTreeModelController<T,M>, WebdavLockableTreeModelController<T,M>, WebdavRenameableTreeModelController<T,M>, WebdavTreeModelController<T,M>

All Known Implementing Classes:

DefaultWebdavTreeModelController

public interface Committable
extends Disposable

An interface to commit modifications. Controller interfaces may implement this interface to allow committing modifications made through the controller.

Since:

6.1.0

Method Summary

void	commit() Commits the modifications applied to the controller that implements this interface.
void	dispose() Indicate that the object will no longer be accessed

Method Detail

commit

void commit()
            throws CannotCommitException

Commits the modifications applied to the controller that implements this interface. Implementations of this method must not perform database read access.

After the controller is committed successfully, this method must not be called again. The same is true for any other method modifying the controller or its nodes.

Throws:

CannotCommitException - in case the modifications cannot be committed; if this exception occurs, the commit operation is considered unsuccessfully executed

dispose

void dispose()

Indicate that the object will no longer be accessed

Once this method is called, no further method calls on the controller are allowed. It is mandatory that this method is called whenever the committable instance is no longer used, e.g. by placing this in a finally block

Specified by:

dispose in interface Disposable