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

java.lang.Object
  extended by org.alfresco.repo.forms.processor.AbstractFormProcessor
      extended by org.alfresco.repo.forms.processor.FilteredFormProcessor
          extended by org.alfresco.repo.forms.processor.node.ContentModelFormProcessor
              extended by org.alfresco.repo.forms.processor.workflow.AbstractWorkflowFormProcessor
                  extended by org.alfresco.repo.forms.processor.workflow.WorkflowFormProcessor
All Implemented Interfaces:
FormProcessor

public class WorkflowFormProcessor
extends AbstractWorkflowFormProcessor

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

Since:
3.4

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, 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
WorkflowFormProcessor()
           
 
Method Summary
protected  java.util.Map getAssociationValues(WorkflowDefinition item)
           
protected  org.alfresco.service.cmr.dictionary.TypeDefinition getBaseType(WorkflowDefinition item)
           
protected  java.util.List getDefaultIgnoredFields()
          When a Form is generated with no field names specifically set then a default Form is created.
protected  java.lang.String getItemType(WorkflowDefinition item)
          Returns a String describing the type fo the specified item.
protected  java.lang.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  java.util.Map getPropertyValues(WorkflowDefinition item)
           
protected  java.util.Map getTransientValues(WorkflowDefinition item)
           
protected  WorkflowDefinition getTypedItemForDecodedId(java.lang.String itemId)
          Returns the typed item.
protected  ContentModelFormPersister 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
getTypedItem, internalPersist, populateForm, setBehaviourFilter, setWorkflowService
 
Methods inherited from class org.alfresco.repo.forms.processor.node.ContentModelFormProcessor
addPropertyDataIfRequired, determineDefaultMimetype, generateDefaultFields, getAspectNames, makeItemData, persistNode, processAssociationPersist, processContentPropertyPersist, processEncodingPropertyPersist, processMimetypePropertyPersist, processNamePropertyPersist, processPropertyPersist, setContentService, setDictionaryService, setFileFolderService, setNamespaceService, setNodeService
 
Methods inherited from class org.alfresco.repo.forms.processor.FilteredFormProcessor
generate, generateSelectedFields, 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 Detail

WorkflowFormProcessor

public WorkflowFormProcessor()
Method Detail

getAssociationValues

protected java.util.Map getAssociationValues(WorkflowDefinition item)
Specified by:
getAssociationValues in class ContentModelFormProcessor

getBaseType

protected org.alfresco.service.cmr.dictionary.TypeDefinition getBaseType(WorkflowDefinition item)
Specified by:
getBaseType in class ContentModelFormProcessor

getPropertyValues

protected java.util.Map getPropertyValues(WorkflowDefinition item)
Specified by:
getPropertyValues in class ContentModelFormProcessor

getTransientValues

protected java.util.Map getTransientValues(WorkflowDefinition item)
Specified by:
getTransientValues in class ContentModelFormProcessor

getItemType

protected java.lang.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
Returns:

getItemURI

protected java.lang.String getItemURI(WorkflowDefinition item)
Description copied from class: FilteredFormProcessor
Returns the URI location of the specified item.

Specified by:
getItemURI in class FilteredFormProcessor
Returns:

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
Returns:
Log instance to log to.

getTypedItemForDecodedId

protected WorkflowDefinition getTypedItemForDecodedId(java.lang.String itemId)
Description copied from class: AbstractWorkflowFormProcessor
Returns the typed item.

Specified by:
getTypedItemForDecodedId in class AbstractWorkflowFormProcessor
Parameters:
itemId - the decoded item Id.
Returns:

makeFormPersister

protected ContentModelFormPersister 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
Returns:

getDefaultIgnoredFields

protected java.util.List 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
Returns:
the names of all the fields to be excluded from the default Form if no defaultFields property is explicitly set.


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