|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
boolean isActive()
void beforeGenerate(java.lang.Object item, java.util.List fields, java.util.List forcedFields, Form form, java.util.Map context)
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.
item
- The item to generate a Form forfields
- Restricted list of fields to includeforcedFields
- List of fields to forcibly includeform
- The Form object@param
- context Map representing optional context that
can be used during retrieval of the formvoid afterGenerate(java.lang.Object item, java.util.List fields, java.util.List forcedFields, Form form, java.util.Map context)
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.
item
- The item to generate a Form forfields
- Restricted list of fields to includeforcedFields
- List of fields to forcibly includeform
- The Form objectcontext
- Map representing optional context that
can be used during retrieval of the formvoid beforePersist(java.lang.Object item, FormData data)
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.
item
- The item to persist the form data fordata
- The form datavoid afterPersist(java.lang.Object item, FormData data, java.lang.Object persistedObject)
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.
item
- The item to persist the form data fordata
- The form datapersistedObject
- The object created or modified as a result of
the form persistence
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |