org.alfresco.web.bean.workflow

Class ManageTaskDialog

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.workflow.ManageTaskDialog

All Implemented Interfaces:

Serializable, IDialogBean

Direct Known Subclasses:

ViewCompletedTaskDialog

public class ManageTaskDialog
extends BaseDialogBean

Bean implementation for the "Manage Task" dialog.

Author:

gavinc

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ManageTaskDialog.TaskCompleteResolver Property resolver to determine if the given node has been flagged as complete

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CLIENT_ID_PREFIX
protected ManageTaskDialog.TaskCompleteResolver	completeResolver
protected static String	ID_PREFIX
protected boolean	isItemBeingAdded
protected String[]	itemsToAdd
protected UIRichList	packageItemsRichList
protected List<String>	packageItemsToAdd
protected List<String>	packageItemsToRemove
protected List<Node>	resources
protected Node	taskNode
protected org.alfresco.service.cmr.repository.NodeRef	workflowPackage

Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors

Constructor and Description
ManageTaskDialog()

Method Summary

Modifier and Type	Method and Description
void	addPackageItems(javax.faces.event.ActionEvent event) Adds an item to the workflow package
void	cancelAddPackageItems(javax.faces.event.ActionEvent event) Cancels the adding of an item to the workflow package
protected void	createAndAddNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)
protected String	finishImpl(javax.faces.context.FacesContext context, String outcome) Performs the actual processing for the wizard.
List<DialogsConfigElement.DialogButtonConfig>	getAdditionalButtons() Returns a list of additional buttons to display in the dialog.
String	getContainerDescription() Returns the description to be used for the dialog
String	getContainerTitle() Returns the title to be used for the dialog
boolean	getFinishButtonDisabled() Determines whether the finish button on the dialog should be disabled
String	getFinishButtonLabel() Returns the label to use for the finish button
String[]	getItemsToAdd() Returns a String array of NodeRef's that are being added to the workflow package
String	getPackageActionGroup() Returns the action group the current task uses for the workflow package
String	getPackageItemActionGroup() Returns the action group the current task uses for each workflow package item
UIRichList	getPackageItemsRichList() Returns the rich list being used for the workflow package items
List<Node>	getResources() Returns a list of resources associated with this task i.e.
Node	getTaskNode() Returns the Node representing the task
String	getWorkflowDefinitionImageUrl() Returns the URL to the Workflow Definition Image of the current task
org.alfresco.service.cmr.workflow.WorkflowInstance	getWorkflowInstance() Returns the WorkflowInstance that the current task belongs to
protected org.alfresco.service.cmr.workflow.WorkflowService	getWorkflowService()
protected org.alfresco.service.cmr.workflow.WorkflowTask	getWorkflowTask()
protected org.alfresco.service.cmr.workflow.WorkflowTransition[]	getWorkflowTransitions()
void	init(Map<String,String> parameters) Initialises the dialog bean
boolean	isItemBeingAdded() Determines whether an item is currently being added to the workflow package
boolean	isPooledTask() Returns whether this is a pooled task
void	prepareForAdd(javax.faces.event.ActionEvent event) Prepares the dialog to allow the user to add an item to the workflow package
void	removePackageItem(javax.faces.event.ActionEvent event) Removes an item from the workflow package
void	restored() Called when the dialog is restored after a nested dialog is closed
String	returnOwnership()
void	setItemsToAdd(String[] itemsToAdd) Sets the NodeRef's to add as items to the workflow package
void	setPackageItemsRichList(UIRichList richList) Sets the rich list being used for the workflow package items
void	setWorkflowService(org.alfresco.service.cmr.workflow.WorkflowService workflowService) Sets the workflow service to use
String	takeOwnership()
void	togglePackageItemComplete(javax.faces.event.ActionEvent event) Toggles the complete flag for a workflow package item
String	transition()
protected void	updateResources()

Methods inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

cancel, doPostCommitProcessing, finish, formatErrorMessage, getActionsConfigId, getActionsContext, getCancelButtonLabel, getCheckOutCheckInService, getContainerSubTitle, getDefaultCancelOutcome, getDefaultFinishOutcome, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, getSearchService, getTransactionService, isFinished, setBrowseBean, setDictionaryService, setFileFolderService, setNamespaceService, setNavigator, setNodeService, setSearchService

Methods inherited from class java.lang.Object

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

Field Detail

taskNode

protected Node taskNode

workflowPackage

protected org.alfresco.service.cmr.repository.NodeRef workflowPackage

resources

protected List<Node> resources

completeResolver

protected ManageTaskDialog.TaskCompleteResolver completeResolver

packageItemsRichList

protected UIRichList packageItemsRichList

packageItemsToAdd

protected List<String> packageItemsToAdd

packageItemsToRemove

protected List<String> packageItemsToRemove

itemsToAdd

protected String[] itemsToAdd

isItemBeingAdded

protected boolean isItemBeingAdded

ID_PREFIX

protected static final String ID_PREFIX

See Also:

Constant Field Values

CLIENT_ID_PREFIX

protected static final String CLIENT_ID_PREFIX

See Also:

Constant Field Values

Constructor Detail

ManageTaskDialog

public ManageTaskDialog()

Method Detail

init

public void init(Map<String,String> parameters)

Description copied from interface: IDialogBean

Initialises the dialog bean

Specified by:

init in interface IDialogBean

Overrides:

init in class BaseDialogBean

Parameters:

parameters - Map of parameters for the dialog

restored

public void restored()

Description copied from interface: IDialogBean

Called when the dialog is restored after a nested dialog is closed

Specified by:

restored in interface IDialogBean

Overrides:

restored in class BaseDialogBean

finishImpl

protected String finishImpl(javax.faces.context.FacesContext context,
                            String outcome)
                     throws Exception

Description copied from class: BaseDialogBean

Performs the actual processing for the wizard. NOTE: This method is called within the context of a transaction so no transaction handling is required

Specified by:

finishImpl in class BaseDialogBean

Parameters:

context - FacesContext

outcome - The default outcome

Returns:

The outcome

Throws:

Exception

getAdditionalButtons

public List<DialogsConfigElement.DialogButtonConfig> getAdditionalButtons()

Description copied from interface: IDialogBean

Returns a list of additional buttons to display in the dialog.

Specified by:

getAdditionalButtons in interface IDialogBean

Overrides:

getAdditionalButtons in class BaseDialogBean

Returns:

List of button configurations, null if there are no buttons

getFinishButtonLabel

public String getFinishButtonLabel()

Description copied from interface: IDialogBean

Returns the label to use for the finish button

Specified by:

getFinishButtonLabel in interface IDialogBean

Overrides:

getFinishButtonLabel in class BaseDialogBean

Returns:

The finish button label

getFinishButtonDisabled

public boolean getFinishButtonDisabled()

Description copied from interface: IDialogBean

Determines whether the finish button on the dialog should be disabled

Specified by:

getFinishButtonDisabled in interface IDialogBean

Overrides:

getFinishButtonDisabled in class BaseDialogBean

Returns:

true if the button should be disabled

getContainerTitle

public String getContainerTitle()

Description copied from interface: IDialogBean

Returns the title to be used for the dialog

If this returns null the DialogManager will lookup the title via the dialog configuration

Specified by:

getContainerTitle in interface IDialogBean

Overrides:

getContainerTitle in class BaseDialogBean

Returns:

The title or null if the title is to be acquired via configuration

getContainerDescription

public String getContainerDescription()

Description copied from interface: IDialogBean

Returns the description to be used for the dialog

If this returns null the DialogManager will lookup the description via the dialog configuration

Specified by:

getContainerDescription in interface IDialogBean

Overrides:

getContainerDescription in class BaseDialogBean

Returns:

The title or null if the title is to be acquired via configuration

takeOwnership

public String takeOwnership()

returnOwnership

public String returnOwnership()

transition

public String transition()

prepareForAdd

public void prepareForAdd(javax.faces.event.ActionEvent event)

Prepares the dialog to allow the user to add an item to the workflow package

Parameters:

event - The event

cancelAddPackageItems

public void cancelAddPackageItems(javax.faces.event.ActionEvent event)

Cancels the adding of an item to the workflow package

Parameters:

event - The event

addPackageItems

public void addPackageItems(javax.faces.event.ActionEvent event)

Adds an item to the workflow package

Parameters:

event - The event

removePackageItem

public void removePackageItem(javax.faces.event.ActionEvent event)

Removes an item from the workflow package

Parameters:

event - The event containing a reference to the item to remove

togglePackageItemComplete

public void togglePackageItemComplete(javax.faces.event.ActionEvent event)

Toggles the complete flag for a workflow package item

Parameters:

event - The event containing a reference to the item to toggle the status for

getItemsToAdd

public String[] getItemsToAdd()

Returns a String array of NodeRef's that are being added to the workflow package

Returns:

String array of NodeRef's

setItemsToAdd

public void setItemsToAdd(String[] itemsToAdd)

Sets the NodeRef's to add as items to the workflow package

Parameters:

itemsToAdd - NodeRef's to add to the workflow package

isItemBeingAdded

public boolean isItemBeingAdded()

Determines whether an item is currently being added to the workflow package

Returns:

true if an item is being added

setPackageItemsRichList

public void setPackageItemsRichList(UIRichList richList)

Sets the rich list being used for the workflow package items

Parameters:

richList - The rich list instance

getPackageItemsRichList

public UIRichList getPackageItemsRichList()

Returns the rich list being used for the workflow package items

Returns:

The rich list instance

getTaskNode

public Node getTaskNode()

Returns the Node representing the task

Returns:

The node

isPooledTask

public boolean isPooledTask()

Returns whether this is a pooled task

Returns:

true => pooled

getWorkflowInstance

public org.alfresco.service.cmr.workflow.WorkflowInstance getWorkflowInstance()

Returns the WorkflowInstance that the current task belongs to

Returns:

The workflow instance

getWorkflowDefinitionImageUrl

public String getWorkflowDefinitionImageUrl()

Returns the URL to the Workflow Definition Image of the current task

Returns:

the url

getPackageActionGroup

public String getPackageActionGroup()

Returns the action group the current task uses for the workflow package

Returns:

action group id

getPackageItemActionGroup

public String getPackageItemActionGroup()

Returns the action group the current task uses for each workflow package item

Returns:

action group id

getResources

public List<Node> getResources()

Returns a list of resources associated with this task i.e. the children of the workflow package

Returns:

The list of nodes

setWorkflowService

public void setWorkflowService(org.alfresco.service.cmr.workflow.WorkflowService workflowService)

Sets the workflow service to use

Parameters:

workflowService - WorkflowService instance

getWorkflowService

protected org.alfresco.service.cmr.workflow.WorkflowService getWorkflowService()

getWorkflowTask

protected org.alfresco.service.cmr.workflow.WorkflowTask getWorkflowTask()

getWorkflowTransitions

protected org.alfresco.service.cmr.workflow.WorkflowTransition[] getWorkflowTransitions()

createAndAddNode

protected void createAndAddNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)

updateResources

protected void updateResources()