public class ActionFormProcessor extends FilteredFormProcessor<ActionDefinition,ActionFormResult>
FormProcessor
for actions
.Modifier and Type | Field and Description |
---|---|
protected static String |
EXECUTE_ASYNCHRONOUSLY |
static String |
ITEM_KIND |
fieldProcessorRegistry, filterRegistry
active, DESTINATION, matchPattern, patternMatcher, processorRegistry
Constructor and Description |
---|
ActionFormProcessor() |
Modifier and Type | Method and Description |
---|---|
protected List<Field> |
generateDefaultFields(FormCreationData data,
List<String> fieldsToIgnore)
Generates a list of default fields to add if no field names are specified.
|
protected List<Field> |
generateSelectedFields(List<String> requestedFields,
FormCreationData data) |
protected List<String> |
getDefaultIgnoredFields()
|
protected String |
getItemType(ActionDefinition item)
Returns a
String describing the type fo the specified item. |
protected String |
getItemURI(ActionDefinition item)
Returns the URI location of the specified item.
|
protected org.apache.commons.logging.Log |
getLogger()
Retrieves a logger instance to log to.
|
protected ActionDefinition |
getTypedItem(Item item)
Returns a typed Object representing the given item.
|
protected ActionFormResult |
internalPersist(ActionDefinition item,
FormData data)
Persists the form data.
|
protected Object |
makeItemData(ActionDefinition item)
|
void |
setActionService(ActionService actionService) |
void |
setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService) |
void |
setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService) |
generate, internalGenerate, persist, populateForm, setFieldProcessorRegistry, setFilterRegistry, setIgnoredFields
isActive, isApplicable, register, setActive, setFormItemType, setFormItemUrl, setMatchPattern, setProcessorRegistry, toString
public static final String ITEM_KIND
protected static final String EXECUTE_ASYNCHRONOUSLY
public void setActionService(ActionService actionService)
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
protected org.apache.commons.logging.Log getLogger()
FilteredFormProcessor
getLogger
in class FilteredFormProcessor<ActionDefinition,ActionFormResult>
protected ActionDefinition getTypedItem(Item item)
FilteredFormProcessor
Subclasses that represent a form type will return a typed object that is then passed to each of it's handlers, the handlers can therefore safely cast the Object to the type they expect.
getTypedItem
in class FilteredFormProcessor<ActionDefinition,ActionFormResult>
item
- The item to get a typed object forprotected String getItemType(ActionDefinition item)
FilteredFormProcessor
String
describing the type fo the specified item.getItemType
in class FilteredFormProcessor<ActionDefinition,ActionFormResult>
item
- ItemTypeprotected String getItemURI(ActionDefinition item)
FilteredFormProcessor
getItemURI
in class FilteredFormProcessor<ActionDefinition,ActionFormResult>
item
- ItemTypeprotected ActionFormResult internalPersist(ActionDefinition item, FormData data)
FilteredFormProcessor
internalPersist
in class FilteredFormProcessor<ActionDefinition,ActionFormResult>
item
- The object to persist the form fordata
- The data to persistprotected List<Field> generateDefaultFields(FormCreationData data, List<String> fieldsToIgnore)
FilteredFormProcessor
generateDefaultFields
in class FilteredFormProcessor<ActionDefinition,ActionFormResult>
data
- Used for field creation.fieldsToIgnore
- TODOList
of Fields
which may be empty.protected List<Field> generateSelectedFields(List<String> requestedFields, FormCreationData data)
generateSelectedFields
in class FilteredFormProcessor<ActionDefinition,ActionFormResult>
protected List<String> getDefaultIgnoredFields()
FilteredFormProcessor
Form
is generated with no field names specifically set then a default Form
is created.
The default Form
contains all the properties and associations related to the Item
, excluding a
blacklist of ignored fields which defaults to the return value of this method.
The default ignored values can be overridden by setting the property ignoredFields
.getDefaultIgnoredFields
in class FilteredFormProcessor<ActionDefinition,ActionFormResult>
Form
if no defaultFields
property is explicitly set.protected Object makeItemData(ActionDefinition item)
FilteredFormProcessor
makeItemData
in class FilteredFormProcessor<ActionDefinition,ActionFormResult>
Copyright © 2005–2017 Alfresco Software. All rights reserved.