org.alfresco.repo.forms.processor
Interface Filter

All Known Implementing Classes:
AbstractFilter

public interface Filter

Interface definition for a filter which is called before and after a form is generated and persisted.


Method Summary
 void afterGenerate(java.lang.Object item, java.util.List fields, java.util.List forcedFields, Form form, java.util.Map context)
          Callback used to indicate that a form has just been generated for the given items and fields.
 void afterPersist(java.lang.Object item, FormData data, java.lang.Object persistedObject)
          Callback used to indicate that the given form data was just persisted for the item and the given persistedObject was created or modified.
 void beforeGenerate(java.lang.Object item, java.util.List fields, java.util.List forcedFields, Form form, java.util.Map context)
          Callback used to indicate that a form is about to be generated for the given items and fields.
 void beforePersist(java.lang.Object item, FormData data)
          Callback used to indicate that the given form data is about to be persisted for the given item.
 boolean isActive()
          Determines whether the filter is active
 

Method Detail

isActive

boolean isActive()
Determines whether the filter is active

Returns:
true if the filter is active

beforeGenerate

void beforeGenerate(java.lang.Object item,
                    java.util.List fields,
                    java.util.List forcedFields,
                    Form form,
                    java.util.Map context)
Callback used to indicate that a form is about to be generated for the given items and fields.

NOTE: Filters all relating to the same type of form can cast the Object to a more appropriate object, for example all the Node based handlers can expect a NodeRef object and therefore cast to that.

Parameters:
item - The item to generate a Form for
fields - Restricted list of fields to include
forcedFields - List of fields to forcibly include
form - The Form object
@param - context Map representing optional context that can be used during retrieval of the form

afterGenerate

void afterGenerate(java.lang.Object item,
                   java.util.List fields,
                   java.util.List forcedFields,
                   Form form,
                   java.util.Map context)
Callback used to indicate that a form has just been generated for the given items and fields.

NOTE: Filters all relating to the same type of form can cast the Object to a more appropriate object, for example all the Node based handlers can expect a NodeRef object and therefore cast to that.

Parameters:
item - The item to generate a Form for
fields - Restricted list of fields to include
forcedFields - List of fields to forcibly include
form - The Form object
context - Map representing optional context that can be used during retrieval of the form

beforePersist

void beforePersist(java.lang.Object item,
                   FormData data)
Callback used to indicate that the given form data is about to be persisted for the given item.

NOTE: Filters all relating to the same type of form can cast the item Object to a more appropriate object, for example all the Node based handlers can expect a NodeRef object and therefore cast to that.

Parameters:
item - The item to persist the form data for
data - The form data

afterPersist

void afterPersist(java.lang.Object item,
                  FormData data,
                  java.lang.Object persistedObject)
Callback used to indicate that the given form data was just persisted for the item and the given persistedObject was created or modified.

NOTE: Filters all relating to the same type of form can cast the item and persistedObject Objects to a more appropriate object, for example all the Node based handlers can expect a NodeRef object and therefore cast to that.

Parameters:
item - The item to persist the form data for
data - The form data
persistedObject - The object created or modified as a result of the form persistence


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.