Package org.alfresco.repo.workflow

Class WorkflowObjectFactory

java.lang.Object

org.alfresco.repo.workflow.WorkflowObjectFactory

public class WorkflowObjectFactory
extends Object

Since:

3.4.e

Author:

Nick Smith

Constructor Summary

Constructors

Constructor	Description
WorkflowObjectFactory(WorkflowQNameConverter qNameConverter, org.alfresco.repo.tenant.TenantService tenantService, MessageService messageService, org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService, String engineId, org.alfresco.service.namespace.QName defaultStartTaskType)

Method Summary

Modifier and Type	Method	Description
String	buildGlobalId(String localId)
void	checkDomain(String defName)	Throws exception if domain mismatch
void	clearQNameCache()
WorkflowDefinition	createDefinition(String defId, String defName, int version, String defaultTitle, String defaultDescription, WorkflowTaskDefinition startTaskDef)	Create a new WorkflowDefinition.
WorkflowDeployment	createDeployment(WorkflowDefinition wfDef, String... problems)	Create a new WorkflowDeployment.
WorkflowInstance	createInstance(String id, WorkflowDefinition definition, Map<String,Object> variables, boolean isActive, Date startDate, Date endDate)
WorkflowNode	createNode(String name, String definitionName, String defaultTitle, String defaultDescription, String type, boolean isTaskNode, WorkflowTransition... transitions)
WorkflowPath	createPath(String id, WorkflowInstance wfInstance, WorkflowNode node, boolean isActive)
WorkflowTask	createTask(String id, WorkflowTaskDefinition taskDef, String name, String defaultTitle, String defaultDescription, WorkflowTaskState state, WorkflowPath path, String workflowDefinitionName, Map<org.alfresco.service.namespace.QName,Serializable> properties)
WorkflowTask	createTask(String id, WorkflowTaskDefinition taskDef, String name, String defaultTitle, String defaultDescription, WorkflowTaskState state, WorkflowPath path, Map<org.alfresco.service.namespace.QName,Serializable> properties)
WorkflowTaskDefinition	createTaskDefinition(String id, WorkflowNode node, String typeName, boolean isStart)
WorkflowTransition	createTransition(String id, String defaultTitle, String defaultDescription, boolean isDefault, String... baseLabelKeys)
WorkflowTimer	createWorkflowTimer(String id, String name, String error, Date dueDate, WorkflowPath workflowPath, WorkflowTask workflowTask)
<T> List<T>	doSpecialTenantFilter(Collection<T> values, org.alfresco.util.collections.Function<T,String> processKeyGetter)	For "default" domain return ALL workflows For tenant-specific workflows exclude "default"
<T> List<T>	filterByDomain(Collection<T> values, org.alfresco.util.collections.Function<T,String> processKeyGetter)
String	getDomainProcessKey(String defName)
String	getLocalEngineId(String globalId)
String	getProcessKey(String defName)
String	getTaskDescription(org.alfresco.service.cmr.dictionary.TypeDefinition typeDefinition, String defName, String defaultDescription, String title)
org.alfresco.service.cmr.dictionary.TypeDefinition	getTaskFullTypeDefinition(String name, boolean isStart)	Returns an anonymous TypeDefinition for the given name with all the mandatory aspects applied.
String	getTaskTitle(org.alfresco.service.cmr.dictionary.TypeDefinition typeDefinition, String defName, String defaultTitle, String name)
org.alfresco.service.cmr.dictionary.TypeDefinition	getTaskTypeDefinition(String name, boolean isStart)	Gets the Task TypeDefinition for the given name.
String	getWorkflowDefinitionName(String defName)
boolean	isDefaultDomain()
boolean	isGlobalId(String globalId)
boolean	isIgnoreTenantCheck()
org.alfresco.service.namespace.QName	mapNameToQName(String name)	Map QName to workflow variable name
String	mapQNameToName(org.alfresco.service.namespace.QName name)	Map QName to workflow variable name
void	setIgnoreTenantCheck(boolean ignoreTenantCheck)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowObjectFactory

public WorkflowObjectFactory(WorkflowQNameConverter qNameConverter,
                             org.alfresco.repo.tenant.TenantService tenantService,
                             MessageService messageService,
                             org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService,
                             String engineId,
                             org.alfresco.service.namespace.QName defaultStartTaskType)

Method Detail

buildGlobalId

public String buildGlobalId(String localId)

getLocalEngineId

public String getLocalEngineId(String globalId)

isGlobalId

public boolean isGlobalId(String globalId)

createDeployment

public WorkflowDeployment createDeployment(WorkflowDefinition wfDef,
                                           String... problems)

Create a new WorkflowDeployment.

Parameters:

wfDef - WorkflowDefinition

problems - String

Returns:

WorkflowDeployment

createDefinition

public WorkflowDefinition createDefinition(String defId,
                                           String defName,
                                           int version,
                                           String defaultTitle,
                                           String defaultDescription,
                                           WorkflowTaskDefinition startTaskDef)

Create a new WorkflowDefinition.

Parameters:

defId - String

defName - String

version - int

defaultTitle - String

defaultDescription - String

startTaskDef - WorkflowTaskDefinition

Returns:

WorkflowDefinition

getWorkflowDefinitionName

public String getWorkflowDefinitionName(String defName)

createInstance

public WorkflowInstance createInstance(String id,
                                       WorkflowDefinition definition,
                                       Map<String,Object> variables,
                                       boolean isActive,
                                       Date startDate,
                                       Date endDate)

createPath

public WorkflowPath createPath(String id,
                               WorkflowInstance wfInstance,
                               WorkflowNode node,
                               boolean isActive)

createNode

public WorkflowNode createNode(String name,
                               String definitionName,
                               String defaultTitle,
                               String defaultDescription,
                               String type,
                               boolean isTaskNode,
                               WorkflowTransition... transitions)

createTransition

public WorkflowTransition createTransition(String id,
                                           String defaultTitle,
                                           String defaultDescription,
                                           boolean isDefault,
                                           String... baseLabelKeys)

createTaskDefinition

public WorkflowTaskDefinition createTaskDefinition(String id,
                                                   WorkflowNode node,
                                                   String typeName,
                                                   boolean isStart)

createTask

public WorkflowTask createTask(String id,
                               WorkflowTaskDefinition taskDef,
                               String name,
                               String defaultTitle,
                               String defaultDescription,
                               WorkflowTaskState state,
                               WorkflowPath path,
                               Map<org.alfresco.service.namespace.QName,Serializable> properties)

createTask

public WorkflowTask createTask(String id,
                               WorkflowTaskDefinition taskDef,
                               String name,
                               String defaultTitle,
                               String defaultDescription,
                               WorkflowTaskState state,
                               WorkflowPath path,
                               String workflowDefinitionName,
                               Map<org.alfresco.service.namespace.QName,Serializable> properties)

createWorkflowTimer

public WorkflowTimer createWorkflowTimer(String id,
                                         String name,
                                         String error,
                                         Date dueDate,
                                         WorkflowPath workflowPath,
                                         WorkflowTask workflowTask)

getProcessKey

public String getProcessKey(String defName)

getDomainProcessKey

public String getDomainProcessKey(String defName)

getTaskTitle

public String getTaskTitle(org.alfresco.service.cmr.dictionary.TypeDefinition typeDefinition,
                           String defName,
                           String defaultTitle,
                           String name)

getTaskDescription

public String getTaskDescription(org.alfresco.service.cmr.dictionary.TypeDefinition typeDefinition,
                                 String defName,
                                 String defaultDescription,
                                 String title)

checkDomain

public void checkDomain(String defName)

Throws exception if domain mismatch

Parameters:

defName - String

isDefaultDomain

public boolean isDefaultDomain()

filterByDomain

public <T> List<T> filterByDomain(Collection<T> values,
                                  org.alfresco.util.collections.Function<T,String> processKeyGetter)

doSpecialTenantFilter

public <T> List<T> doSpecialTenantFilter(Collection<T> values,
                                         org.alfresco.util.collections.Function<T,String> processKeyGetter)

For "default" domain return ALL workflows For tenant-specific workflows exclude "default"

getTaskFullTypeDefinition

public org.alfresco.service.cmr.dictionary.TypeDefinition getTaskFullTypeDefinition(String name,
                                                                                    boolean isStart)

Returns an anonymous TypeDefinition for the given name with all the mandatory aspects applied.

Parameters:

name - the name of the task definition.

isStart - is theis a start task?

Returns:

the task TypeDefinition.

getTaskTypeDefinition

public org.alfresco.service.cmr.dictionary.TypeDefinition getTaskTypeDefinition(String name,
                                                                                boolean isStart)

Gets the Task TypeDefinition for the given name.

Parameters:

name - the name of the task definition.

isStart - is theis a start task?

Returns:

the task TypeDefinition.

mapQNameToName

public String mapQNameToName(org.alfresco.service.namespace.QName name)

Map QName to workflow variable name

Parameters:

name - QName

Returns:

workflow variable name

mapNameToQName

public org.alfresco.service.namespace.QName mapNameToQName(String name)

Map QName to workflow variable name

Parameters:

name - QName

Returns:

workflow variable name

clearQNameCache

public void clearQNameCache()

isIgnoreTenantCheck

public boolean isIgnoreTenantCheck()

setIgnoreTenantCheck

public void setIgnoreTenantCheck(boolean ignoreTenantCheck)