com.iknowbase.api.presentationservices.portlet

Interface PortletRunner

public interface PortletRunner

The PortletRunner lets you run a portlet on-demand. PortletRunner is an immutable value type, and each configuration method returns a new instance.

Method Summary

Modifier and Type	Method and Description
PortletRunner	client(PresentationServicesClient client) Sets which client context to use
PortletRunner	portlet(java.lang.String name) Sets the name of the portlet to run
PortletResult	run() Runs the portlet, using the specified configuration

Method Detail

portlet

PortletRunner portlet(java.lang.String name)

Sets the name of the portlet to run

Parameters:

name - the name of the portlet to run

Returns:

a new, configured PortletRunner

client

PortletRunner client(PresentationServicesClient client)

Sets which client context to use

Parameters:

client - the client context to use

Returns:

a new, configured PortletRunner

run

PortletResult run()

Runs the portlet, using the specified configuration

Returns:

the output from the portlet