fr.toutatice.portail.cms.nuxeo.api.forms

Interface FormFilter

public interface FormFilter

Form filter.

Method Summary

Modifier and Type	Method and Description
void	execute(FormFilterContext context, FormFilterExecutor executor) Execute form filter.
String	getDescriptionKey() get the form filter description internationalization key
String	getId() Get form filter identifier.
String	getLabelKey() Get form filter label internationalization key.
Map<String,FormFilterParameterType>	getParameters() get the parameters used by the filter
boolean	hasChildren() return true if the filter calls the execution of children filter

Method Detail

getId

String getId()

Get form filter identifier.

Returns:

identifier

getLabelKey

String getLabelKey()

Get form filter label internationalization key.

Returns:

internationalization key

getDescriptionKey

String getDescriptionKey()

get the form filter description internationalization key

Returns:

t

getParameters

Map<String,FormFilterParameterType> getParameters()

get the parameters used by the filter

Returns:

a map listing the parameters and their types

hasChildren

boolean hasChildren()

return true if the filter calls the execution of children filter

Returns:

execute

void execute(FormFilterContext context,
             FormFilterExecutor executor)
      throws FormFilterException,
             org.osivia.portal.api.PortalException

Execute form filter.

Parameters:

context - form filter context

executor - form filter executor

Throws:

FormFilterException

org.osivia.portal.api.PortalException