@AlfrescoPublicApi
public interface Filter<ItemType,PersistType>
Modifier and Type | Method and Description |
---|---|
void |
afterGenerate(ItemType item,
List<String> fields,
List<String> forcedFields,
Form form,
Map<String,Object> context)
Callback used to indicate that a form has just been generated for
the given items and fields.
|
void |
afterPersist(ItemType item,
FormData data,
PersistType 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(ItemType item,
List<String> fields,
List<String> forcedFields,
Form form,
Map<String,Object> context)
Callback used to indicate that a form is about to be generated for
the given items and fields.
|
void |
beforePersist(ItemType 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
|
boolean isActive()
void beforeGenerate(ItemType item, List<String> fields, List<String> forcedFields, Form form, Map<String,Object> 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 afterGenerate(ItemType item, List<String> fields, List<String> forcedFields, Form form, Map<String,Object> 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(ItemType 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(ItemType item, FormData data, PersistType 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 persistenceCopyright © 2005–2017 Alfresco Software. All rights reserved.