Package org.alfresco.repo.forms.processor.workflow

Class WorkflowFormProcessor

java.lang.Object

org.alfresco.repo.forms.processor.AbstractFormProcessor

org.alfresco.repo.forms.processor.FilteredFormProcessor<ItemType,PersistType>

org.alfresco.repo.forms.processor.node.ContentModelFormProcessor<ItemType,PersistType>

org.alfresco.repo.forms.processor.workflow.AbstractWorkflowFormProcessor<WorkflowDefinition,WorkflowInstance>

org.alfresco.repo.forms.processor.workflow.WorkflowFormProcessor

All Implemented Interfaces:

FormProcessor

public class WorkflowFormProcessor
extends AbstractWorkflowFormProcessor<WorkflowDefinition,WorkflowInstance>

FormProcessor implementation that can generate and persist Form objects for workflow definitions.

Since:

3.4

Author:

Nick Smith

Field Summary

Fields inherited from class org.alfresco.repo.forms.processor.workflow.AbstractWorkflowFormProcessor

behaviourFilter, workflowService

Fields inherited from class org.alfresco.repo.forms.processor.node.ContentModelFormProcessor

associationNamePattern, contentService, dictionaryService, fileFolderService, namespaceService, nodeService, permissionService, propertyNamePattern, transientPropertyPattern

Fields inherited from class org.alfresco.repo.forms.processor.FilteredFormProcessor

fieldProcessorRegistry, filterRegistry

Fields inherited from class org.alfresco.repo.forms.processor.AbstractFormProcessor

active, DESTINATION, matchPattern, patternMatcher, processorRegistry

Constructor Summary

Constructors

Constructor	Description
WorkflowFormProcessor()

Method Summary

Modifier and Type	Method	Description
protected Map<QName,Serializable>	getAssociationValues(WorkflowDefinition item)
protected TypeDefinition	getBaseType(WorkflowDefinition item)
protected List<String>	getDefaultIgnoredFields()	When a Form is generated with no field names specifically set then a default Form is created.
protected String	getItemType(WorkflowDefinition item)	Returns a String describing the type fo the specified item.
protected String	getItemURI(WorkflowDefinition item)	Returns the URI location of the specified item.
protected org.apache.commons.logging.Log	getLogger()	Retrieves a logger instance to log to.
protected Map<QName,Serializable>	getPropertyValues(WorkflowDefinition item)
protected Map<String,Object>	getTransientValues(WorkflowDefinition item)
protected WorkflowDefinition	getTypedItemForDecodedId(String itemId)	Returns the typed item.
protected ContentModelFormPersister<WorkflowInstance>	makeFormPersister(WorkflowDefinition item)	Returns an implementation of ContentModelFormPersister which is used to accumulate all the changes specified in the Form and then persist them.

Methods inherited from class org.alfresco.repo.forms.processor.workflow.AbstractWorkflowFormProcessor

generateDefaultFields, generateSelectedFields, getTypedItem, internalPersist, populateForm, setBehaviourFilter, setExtendedPropertyFieldProcessor, setWorkflowService

Methods inherited from class org.alfresco.repo.forms.processor.node.ContentModelFormProcessor

addPropertyDataIfRequired, determineDefaultMimetype, getAspectNames, makeItemData, persistNode, processAssociationPersist, processContentPropertyPersist, processEncodingPropertyPersist, processMimetypePropertyPersist, processNamePropertyPersist, processPropertyPersist, setContentService, setDictionaryService, setFileFolderService, setNamespaceService, setNodeService, setPermissionService

Methods inherited from class org.alfresco.repo.forms.processor.FilteredFormProcessor

generate, internalGenerate, persist, setFieldProcessorRegistry, setFilterRegistry, setIgnoredFields

Methods inherited from class org.alfresco.repo.forms.processor.AbstractFormProcessor

isActive, isApplicable, register, setActive, setFormItemType, setFormItemUrl, setMatchPattern, setProcessorRegistry, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

WorkflowFormProcessor

public WorkflowFormProcessor()

Method Details

getAssociationValues

protected Map<QName,Serializable> getAssociationValues(WorkflowDefinition item)

Specified by:

getAssociationValues in class ContentModelFormProcessor<WorkflowDefinition,WorkflowInstance>

getBaseType

protected TypeDefinition getBaseType(WorkflowDefinition item)

Specified by:

getBaseType in class ContentModelFormProcessor<WorkflowDefinition,WorkflowInstance>

getPropertyValues

protected Map<QName,Serializable> getPropertyValues(WorkflowDefinition item)

Specified by:

getPropertyValues in class ContentModelFormProcessor<WorkflowDefinition,WorkflowInstance>

getTransientValues

protected Map<String,Object> getTransientValues(WorkflowDefinition item)

Specified by:

getTransientValues in class ContentModelFormProcessor<WorkflowDefinition,WorkflowInstance>

getItemType

protected String getItemType(WorkflowDefinition item)

Description copied from class: FilteredFormProcessor

Returns a String describing the type fo the specified item.

Specified by:

getItemType in class FilteredFormProcessor<WorkflowDefinition,WorkflowInstance>

Parameters:

item - ItemType

Returns:

String

getItemURI

protected String getItemURI(WorkflowDefinition item)

Description copied from class: FilteredFormProcessor

Returns the URI location of the specified item.

Specified by:

getItemURI in class FilteredFormProcessor<WorkflowDefinition,WorkflowInstance>

Parameters:

item - ItemType

Returns:

String

getLogger

protected org.apache.commons.logging.Log getLogger()

Description copied from class: FilteredFormProcessor

Retrieves a logger instance to log to.

Specified by:

getLogger in class FilteredFormProcessor<WorkflowDefinition,WorkflowInstance>

Returns:

Log instance to log to.

getTypedItemForDecodedId

protected WorkflowDefinition getTypedItemForDecodedId(String itemId)

Description copied from class: AbstractWorkflowFormProcessor

Returns the typed item.

Specified by:

getTypedItemForDecodedId in class AbstractWorkflowFormProcessor<WorkflowDefinition,WorkflowInstance>

Parameters:

itemId - the decoded item Id.

Returns:

ItemType

makeFormPersister

protected ContentModelFormPersister<WorkflowInstance> makeFormPersister(WorkflowDefinition item)

Description copied from class: AbstractWorkflowFormProcessor

Returns an implementation of ContentModelFormPersister which is used to accumulate all the changes specified in the Form and then persist them.

Specified by:

makeFormPersister in class AbstractWorkflowFormProcessor<WorkflowDefinition,WorkflowInstance>

Parameters:

item - ItemType

getDefaultIgnoredFields

protected List<String> getDefaultIgnoredFields()

Description copied from class: FilteredFormProcessor

When a 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.

Overrides:

getDefaultIgnoredFields in class AbstractWorkflowFormProcessor<WorkflowDefinition,WorkflowInstance>

Returns:

the names of all the fields to be excluded from the default Form if no defaultFields property is explicitly set.