org.alfresco.repo.web.scripts.workflow

Class WorkflowModelBuilder

java.lang.Object

org.alfresco.repo.web.scripts.workflow.WorkflowModelBuilder

public class WorkflowModelBuilder
extends Object

Since:

3.4

Author:

Nick Smith

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERSON_AVATAR
static String	PERSON_FIRST_NAME
static String	PERSON_LAST_NAME
static String	PERSON_USER_NAME
static String	TASK_CREATOR
static String	TASK_DEFINITION
static String	TASK_DEFINITION_ID
static String	TASK_DEFINITION_NODE
static String	TASK_DEFINITION_TYPE
static String	TASK_DEFINITION_URL
static String	TASK_DESCRIPTION
static String	TASK_ID
static String	TASK_IS_CLAIMABLE
static String	TASK_IS_EDITABLE
static String	TASK_IS_POOLED
static String	TASK_IS_REASSIGNABLE
static String	TASK_IS_RELEASABLE
static String	TASK_NAME
static String	TASK_OUTCOME
static String	TASK_OUTCOME_MESSAGE_PREFIX
static String	TASK_OWNER
static String	TASK_PATH
static String	TASK_PROPERTIES
static String	TASK_PROPERTIY_LABELS
static String	TASK_STATE
static String	TASK_TITLE
static String	TASK_URL
static String	TASK_WORKFLOW_INSTANCE
static String	TASK_WORKFLOW_INSTANCE_CONTEXT
static String	TASK_WORKFLOW_INSTANCE_DEFINITION
static String	TASK_WORKFLOW_INSTANCE_DEFINITION_URL
static String	TASK_WORKFLOW_INSTANCE_DESCRIPTION
static String	TASK_WORKFLOW_INSTANCE_DIAGRAM_URL
static String	TASK_WORKFLOW_INSTANCE_DUE_DATE
static String	TASK_WORKFLOW_INSTANCE_END_DATE
static String	TASK_WORKFLOW_INSTANCE_ID
static String	TASK_WORKFLOW_INSTANCE_INITIATOR
static String	TASK_WORKFLOW_INSTANCE_INITIATOR_FIRSTNAME
static String	TASK_WORKFLOW_INSTANCE_INITIATOR_LASTNAME
static String	TASK_WORKFLOW_INSTANCE_INITIATOR_USERNAME
static String	TASK_WORKFLOW_INSTANCE_IS_ACTIVE
static String	TASK_WORKFLOW_INSTANCE_MESSAGE
static String	TASK_WORKFLOW_INSTANCE_NAME
static String	TASK_WORKFLOW_INSTANCE_PACKAGE
static String	TASK_WORKFLOW_INSTANCE_PRIORITY
static String	TASK_WORKFLOW_INSTANCE_START_DATE
static String	TASK_WORKFLOW_INSTANCE_START_TASK_INSTANCE_ID
static String	TASK_WORKFLOW_INSTANCE_TASKS
static String	TASK_WORKFLOW_INSTANCE_TITLE
static String	TASK_WORKFLOW_INSTANCE_URL
static String	TYPE_DEFINITION_DESCRIPTION
static String	TYPE_DEFINITION_NAME
static String	TYPE_DEFINITION_TITLE
static String	TYPE_DEFINITION_URL
static String	WORKFLOW_DEFINITION_DESCRIPTION
static String	WORKFLOW_DEFINITION_ID
static String	WORKFLOW_DEFINITION_NAME
static String	WORKFLOW_DEFINITION_START_TASK_DEFINITION_TYPE
static String	WORKFLOW_DEFINITION_START_TASK_DEFINITION_URL
static String	WORKFLOW_DEFINITION_TASK_DEFINITIONS
static String	WORKFLOW_DEFINITION_TITLE
static String	WORKFLOW_DEFINITION_URL
static String	WORKFLOW_DEFINITION_VERSION
static String	WORKFLOW_NODE_DESCRIPTION
static String	WORKFLOW_NODE_IS_TASK_NODE
static String	WORKFLOW_NODE_NAME
static String	WORKFLOW_NODE_TITLE
static String	WORKFLOW_NODE_TRANSITION_DESCRIPTION
static String	WORKFLOW_NODE_TRANSITION_ID
static String	WORKFLOW_NODE_TRANSITION_IS_DEFAULT
static String	WORKFLOW_NODE_TRANSITION_IS_HIDDEN
static String	WORKFLOW_NODE_TRANSITION_TITLE
static String	WORKFLOW_NODE_TRANSITIONS

Constructor Summary

Constructors

Constructor and Description
WorkflowModelBuilder(org.alfresco.service.namespace.NamespaceService namespaceService, org.alfresco.service.cmr.repository.NodeService nodeService, AuthenticationService authenticationService, PersonService personService, WorkflowService workflowService, org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	buildDetailed(WorkflowDefinition workflowDefinition) Returns a detailed representation of a WorkflowDefinition.
Map<String,Object>	buildDetailed(WorkflowInstance workflowInstance, boolean includeTasks) Returns a detailed representation of a WorkflowInstance.
Map<String,Object>	buildDetailed(WorkflowTask workflowTask) Returns a detailed representation of a WorkflowTask.
Map<String,Object>	buildSimple(WorkflowDefinition workflowDefinition) Returns a simple representation of a WorkflowDefinition.
Map<String,Object>	buildSimple(WorkflowInstance workflowInstance) Returns a simple representation of a WorkflowInstance.
Map<String,Object>	buildSimple(WorkflowTask task, Collection<String> propertyFilters) Returns a simple representation of a WorkflowTask.

Methods inherited from class java.lang.Object

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

Field Detail

PERSON_LAST_NAME

public static final String PERSON_LAST_NAME

See Also:

Constant Field Values

PERSON_FIRST_NAME

public static final String PERSON_FIRST_NAME

See Also:

Constant Field Values

PERSON_USER_NAME

public static final String PERSON_USER_NAME

See Also:

Constant Field Values

PERSON_AVATAR

public static final String PERSON_AVATAR

See Also:

Constant Field Values

TASK_PROPERTIES

public static final String TASK_PROPERTIES

See Also:

Constant Field Values

TASK_PROPERTIY_LABELS

public static final String TASK_PROPERTIY_LABELS

See Also:

Constant Field Values

TASK_OWNER

public static final String TASK_OWNER

See Also:

Constant Field Values

TASK_CREATOR

public static final String TASK_CREATOR

See Also:

Constant Field Values

TASK_STATE

public static final String TASK_STATE

See Also:

Constant Field Values

TASK_DESCRIPTION

public static final String TASK_DESCRIPTION

See Also:

Constant Field Values

TASK_TITLE

public static final String TASK_TITLE

See Also:

Constant Field Values

TASK_NAME

public static final String TASK_NAME

See Also:

Constant Field Values

TASK_URL

public static final String TASK_URL

See Also:

Constant Field Values

TASK_IS_POOLED

public static final String TASK_IS_POOLED

See Also:

Constant Field Values

TASK_IS_EDITABLE

public static final String TASK_IS_EDITABLE

See Also:

Constant Field Values

TASK_IS_REASSIGNABLE

public static final String TASK_IS_REASSIGNABLE

See Also:

Constant Field Values

TASK_IS_CLAIMABLE

public static final String TASK_IS_CLAIMABLE

See Also:

Constant Field Values

TASK_IS_RELEASABLE

public static final String TASK_IS_RELEASABLE

See Also:

Constant Field Values

TASK_ID

public static final String TASK_ID

See Also:

Constant Field Values

TASK_PATH

public static final String TASK_PATH

See Also:

Constant Field Values

TASK_DEFINITION

public static final String TASK_DEFINITION

See Also:

Constant Field Values

TASK_OUTCOME

public static final String TASK_OUTCOME

See Also:

Constant Field Values

TASK_DEFINITION_ID

public static final String TASK_DEFINITION_ID

See Also:

Constant Field Values

TASK_DEFINITION_URL

public static final String TASK_DEFINITION_URL

See Also:

Constant Field Values

TASK_DEFINITION_TYPE

public static final String TASK_DEFINITION_TYPE

See Also:

Constant Field Values

TASK_DEFINITION_NODE

public static final String TASK_DEFINITION_NODE

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE

public static final String TASK_WORKFLOW_INSTANCE

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_ID

public static final String TASK_WORKFLOW_INSTANCE_ID

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_URL

public static final String TASK_WORKFLOW_INSTANCE_URL

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_NAME

public static final String TASK_WORKFLOW_INSTANCE_NAME

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_TITLE

public static final String TASK_WORKFLOW_INSTANCE_TITLE

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_DESCRIPTION

public static final String TASK_WORKFLOW_INSTANCE_DESCRIPTION

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_MESSAGE

public static final String TASK_WORKFLOW_INSTANCE_MESSAGE

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_IS_ACTIVE

public static final String TASK_WORKFLOW_INSTANCE_IS_ACTIVE

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_START_DATE

public static final String TASK_WORKFLOW_INSTANCE_START_DATE

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_DUE_DATE

public static final String TASK_WORKFLOW_INSTANCE_DUE_DATE

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_END_DATE

public static final String TASK_WORKFLOW_INSTANCE_END_DATE

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_PRIORITY

public static final String TASK_WORKFLOW_INSTANCE_PRIORITY

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_INITIATOR

public static final String TASK_WORKFLOW_INSTANCE_INITIATOR

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_CONTEXT

public static final String TASK_WORKFLOW_INSTANCE_CONTEXT

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_PACKAGE

public static final String TASK_WORKFLOW_INSTANCE_PACKAGE

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_START_TASK_INSTANCE_ID

public static final String TASK_WORKFLOW_INSTANCE_START_TASK_INSTANCE_ID

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_DEFINITION

public static final String TASK_WORKFLOW_INSTANCE_DEFINITION

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_TASKS

public static final String TASK_WORKFLOW_INSTANCE_TASKS

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_DEFINITION_URL

public static final String TASK_WORKFLOW_INSTANCE_DEFINITION_URL

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_DIAGRAM_URL

public static final String TASK_WORKFLOW_INSTANCE_DIAGRAM_URL

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_INITIATOR_USERNAME

public static final String TASK_WORKFLOW_INSTANCE_INITIATOR_USERNAME

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_INITIATOR_FIRSTNAME

public static final String TASK_WORKFLOW_INSTANCE_INITIATOR_FIRSTNAME

See Also:

Constant Field Values

TASK_WORKFLOW_INSTANCE_INITIATOR_LASTNAME

public static final String TASK_WORKFLOW_INSTANCE_INITIATOR_LASTNAME

See Also:

Constant Field Values

TYPE_DEFINITION_NAME

public static final String TYPE_DEFINITION_NAME

See Also:

Constant Field Values

TYPE_DEFINITION_TITLE

public static final String TYPE_DEFINITION_TITLE

See Also:

Constant Field Values

TYPE_DEFINITION_DESCRIPTION

public static final String TYPE_DEFINITION_DESCRIPTION

See Also:

Constant Field Values

TYPE_DEFINITION_URL

public static final String TYPE_DEFINITION_URL

See Also:

Constant Field Values

WORKFLOW_NODE_NAME

public static final String WORKFLOW_NODE_NAME

See Also:

Constant Field Values

WORKFLOW_NODE_TITLE

public static final String WORKFLOW_NODE_TITLE

See Also:

Constant Field Values

WORKFLOW_NODE_DESCRIPTION

public static final String WORKFLOW_NODE_DESCRIPTION

See Also:

Constant Field Values

WORKFLOW_NODE_IS_TASK_NODE

public static final String WORKFLOW_NODE_IS_TASK_NODE

See Also:

Constant Field Values

WORKFLOW_NODE_TRANSITIONS

public static final String WORKFLOW_NODE_TRANSITIONS

See Also:

Constant Field Values

WORKFLOW_NODE_TRANSITION_ID

public static final String WORKFLOW_NODE_TRANSITION_ID

See Also:

Constant Field Values

WORKFLOW_NODE_TRANSITION_TITLE

public static final String WORKFLOW_NODE_TRANSITION_TITLE

See Also:

Constant Field Values

WORKFLOW_NODE_TRANSITION_DESCRIPTION

public static final String WORKFLOW_NODE_TRANSITION_DESCRIPTION

See Also:

Constant Field Values

WORKFLOW_NODE_TRANSITION_IS_DEFAULT

public static final String WORKFLOW_NODE_TRANSITION_IS_DEFAULT

See Also:

Constant Field Values

WORKFLOW_NODE_TRANSITION_IS_HIDDEN

public static final String WORKFLOW_NODE_TRANSITION_IS_HIDDEN

See Also:

Constant Field Values

WORKFLOW_DEFINITION_ID

public static final String WORKFLOW_DEFINITION_ID

See Also:

Constant Field Values

WORKFLOW_DEFINITION_URL

public static final String WORKFLOW_DEFINITION_URL

See Also:

Constant Field Values

WORKFLOW_DEFINITION_NAME

public static final String WORKFLOW_DEFINITION_NAME

See Also:

Constant Field Values

WORKFLOW_DEFINITION_TITLE

public static final String WORKFLOW_DEFINITION_TITLE

See Also:

Constant Field Values

WORKFLOW_DEFINITION_DESCRIPTION

public static final String WORKFLOW_DEFINITION_DESCRIPTION

See Also:

Constant Field Values

WORKFLOW_DEFINITION_VERSION

public static final String WORKFLOW_DEFINITION_VERSION

See Also:

Constant Field Values

WORKFLOW_DEFINITION_START_TASK_DEFINITION_URL

public static final String WORKFLOW_DEFINITION_START_TASK_DEFINITION_URL

See Also:

Constant Field Values

WORKFLOW_DEFINITION_START_TASK_DEFINITION_TYPE

public static final String WORKFLOW_DEFINITION_START_TASK_DEFINITION_TYPE

See Also:

Constant Field Values

WORKFLOW_DEFINITION_TASK_DEFINITIONS

public static final String WORKFLOW_DEFINITION_TASK_DEFINITIONS

See Also:

Constant Field Values

TASK_OUTCOME_MESSAGE_PREFIX

public static final String TASK_OUTCOME_MESSAGE_PREFIX

See Also:

Constant Field Values

Constructor Detail

WorkflowModelBuilder

public WorkflowModelBuilder(org.alfresco.service.namespace.NamespaceService namespaceService,
                            org.alfresco.service.cmr.repository.NodeService nodeService,
                            AuthenticationService authenticationService,
                            PersonService personService,
                            WorkflowService workflowService,
                            org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Method Detail

buildSimple

public Map<String,Object> buildSimple(WorkflowTask task,
                                      Collection<String> propertyFilters)

Returns a simple representation of a WorkflowTask.

Parameters:

task - The task to be represented.

propertyFilters - Specify which properties to include.

Returns:

Map

buildDetailed

public Map<String,Object> buildDetailed(WorkflowTask workflowTask)

Returns a detailed representation of a WorkflowTask.

Parameters:

workflowTask - The task to be represented.

Returns:

Map

buildSimple

public Map<String,Object> buildSimple(WorkflowInstance workflowInstance)

Returns a simple representation of a WorkflowInstance.

Parameters:

workflowInstance - The workflow instance to be represented.

Returns:

Map

buildDetailed

public Map<String,Object> buildDetailed(WorkflowInstance workflowInstance,
                                        boolean includeTasks)

Returns a detailed representation of a WorkflowInstance.

Parameters:

workflowInstance - The workflow instance to be represented.

includeTasks - should we include task in model?

Returns:

Map

buildSimple

public Map<String,Object> buildSimple(WorkflowDefinition workflowDefinition)

Returns a simple representation of a WorkflowDefinition.

Parameters:

workflowDefinition - the WorkflowDefinition object to be represented.

Returns:

Map

buildDetailed

public Map<String,Object> buildDetailed(WorkflowDefinition workflowDefinition)

Returns a detailed representation of a WorkflowDefinition.

Parameters:

workflowDefinition - the WorkflowDefinition object to be represented.

Returns:

Map