fr.paris.lutece.portal.web.pluginaction

Interface IPluginActionResult

All Known Implementing Classes:

DefaultPluginActionResult

public interface IPluginActionResult

Result of an action.
Use :

• setRedirect(String) : if the action need a redirect
• setHtmlContent(String) : if the action needs to display html content
• setNoop(boolean) : if no post-action is required (mainly for exports writing directly to the response).

Method Summary

Modifier and Type	Method and Description
String	getHtmlContent() Returns the html content if any, null otherwise
String	getRedirect() Returns the redirect url, null otherwise.
boolean	isNoop() Returns true if no operation needed, false otherwise.
void	setHtmlContent(String strHtmlContent) Sets the html content if any, null otherwise
void	setNoop(boolean bNoop) Set to true if no operation needed, false otherwise.
void	setRedirect(String strRedirect) Sets the redirect url, null otherwise.

Method Detail

getRedirect

String getRedirect()

Returns the redirect url, null otherwise.

Returns:

the redirect url, null otherwise

setRedirect

void setRedirect(String strRedirect)

Sets the redirect url, null otherwise.

Parameters:

strRedirect - the redirect url, null otherwise.

isNoop

boolean isNoop()

Returns true if no operation needed, false otherwise.

Returns:

true if no operation needed, false otherwise.

setNoop

void setNoop(boolean bNoop)

Set to true if no operation needed, false otherwise.

Parameters:

bNoop - true if no operation needed, false otherwise.

getHtmlContent

String getHtmlContent()

Returns the html content if any, null otherwise

Returns:

the html content if any, null otherwise

setHtmlContent

void setHtmlContent(String strHtmlContent)

Sets the html content if any, null otherwise

Parameters:

strHtmlContent - the html content if any, null otherwise