com.ibm.portal.model.controller
Interface ContentModelControllerResumeService

All Superinterfaces:

ContentModelProvider

public interface ContentModelControllerResumeService
extends ContentModelProvider

The future - may be implemented after web2.0 tech preview: allow management of content model controllers across a prolonged time, e.g. multiple requests. Storage/lifetime is implied by how this service is obtained (e.g. if it is obtained using a session object, it can be assumed the controller is suspended to the session etc.)

Since:

6.1.0

Nested Class Summary

static interface

ContentModelControllerResumeService.Memento Interface acting as a handle for a suspended model controller.

Method Summary

void	com.ibm.portal.content.ContentModelController, com.ibm.portal.model.controller.ContentModelControllerResumeService.Memento)">resume(ContentModelController controller, ContentModelControllerResumeService.Memento memento) Resumes a content model controller using the given content model controller and specified memento.
ContentModelControllerResumeService.Memento	com.ibm.portal.content.ContentModelController)">suspend(ContentModelController controller) Suspends the given content model controller.

Methods inherited from interface com.ibm.portal.model.ContentModelProvider

getContentModel

Method Detail

com.ibm.portal.content.ContentModelController)">

suspend

ContentModelControllerResumeService.Memento suspend(ContentModelController controller)
                                                    throws CannotSuspendControllerException

Suspends the given content model controller. The returned memento must be used to resume the controller.

Parameters:

controller - the controller to suspend, must not be null

Throws:

CannotSuspendControllerException - in case the controller cannot be suspended

com.ibm.portal.content.ContentModelController, com.ibm.portal.model.controller.ContentModelControllerResumeService.Memento)">

resume

void resume(ContentModelController controller,
            ContentModelControllerResumeService.Memento memento)
            throws CannotResumeControllerException

Resumes a content model controller using the given content model controller and specified memento. After successfully resuming the controller, this method cannot be invoked again using the same memento.

Parameters:

controller - an unmodified, newly created controller, must not be null

memento - a memento handle obtained by a call to com.ibm.portal.content.ContentModelController)">suspend(ContentModelController)

Throws:

CannotResumeControllerException - in case the controller cannot be resumed, for example if the same memento is used twice for this method