com.tsgrp.opencontent.wizard.activiti.workflow

Class ActivitiClientWizardWorkflowImpl

java.lang.Object

com.tsgrp.opencontent.wizard.activiti.workflow.ActivitiClientWizardWorkflowImpl

All Implemented Interfaces:

IClientWizardWorkflow

public class ActivitiClientWizardWorkflowImpl
extends java.lang.Object
implements IClientWizardWorkflow

Constructor Summary

Constructors

Constructor and Description
ActivitiClientWizardWorkflowImpl()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.io.Serializable>	buildWizardApprovalWorkflowProperties(java.lang.String ticket, java.lang.String formId, WorkflowPackage pkg) Builds the appropriate wf property map with which to start an approva workflow.
java.util.Map<java.lang.String,java.io.Serializable>	buildWizardReviewWorkflowProperties(java.lang.String ticket, java.lang.String[] assignees, WorkflowPackage pkg) Builds the appropriate wf property map with which to start a review workflow.
ApprovalDetails	getCurrentApprovalDetails(java.lang.String ticket, java.lang.String formId, java.lang.String documentId) Returns an ApprovalDetails object pertaining to the specified form, or, if form is null/there is no ad for the form, an ApprovalDetails object pertaining to the specified documentId.
protected java.lang.String	getFormIdFromWorkflowInstanceId(java.lang.String ticket, java.lang.String workflowInstanceId)
java.util.List<java.lang.String>	getFormWorkflowDocs(java.lang.String ticket, java.lang.String formId)
ApprovalDetails	getFreshApprovalDetails(java.lang.String ticket, java.lang.String formId)
java.util.List<UserBean>	getPotentialApprovers(java.lang.String ticket, java.lang.String formId) Returns UserBean array of users that have been configured via the Finished form to be potential approvers or reviewers.
protected java.util.List<org.activiti.engine.task.Task>	getUnclaimedActivitiTasks(java.lang.String ticket, java.lang.String userLoginName, java.lang.String workflowInstanceId)
java.util.List<UserBean>	getWizardContributors(java.lang.String ticket) Returns UserBean array of users that are in the configurable wizard contributors group.
java.util.List<WizardTaskInstance>	getWizardTasks(java.lang.String ticket, java.lang.String userLoginName, java.lang.String workflowInstanceId, boolean getFullTasks, boolean getClaimableTasks) Retrieve a list of Active Wizard tasks for the given user login name
void	resetAndMaintainApprovalDetails(java.lang.String ticket, java.lang.String formId) If the wizardMaintainSignature property is set to true, this will reserve the existing doc signatures and form signatures onto the savedFormSignatures and savedDocSignatures so that the next signature page generated carries over the old signatures If the wizardMaintainSignature property is set to false, generates a fresh approval details
void	resetApprovalDetails(java.lang.String ticket, java.lang.String formId) Generates a fresh approval details and relates it to the form.
java.lang.String	resolveWorkflowDocId(java.lang.String ticket, java.lang.String chronId) Given an object's chronicle ID (first version ID), returns the r_object_id of the CURRENT object version
QueryResult	searchWFDocs(java.lang.String ticket, java.util.Map<java.lang.String,java.lang.String> searchPlaceholders) Searches for workflow documents
void	setApprovalDetails(java.lang.String ticket, java.lang.String formId, java.lang.String documentId, ApprovalDetails approvalDetails)
protected void	setApprovalDetailsHelper(java.lang.String ticket, java.lang.String formId, java.lang.String documentId, ApprovalDetails approvalDetails)
void	setApprovalDetailsViaWorkflowInstance(java.lang.String ticket, java.lang.String workflowInstanceId, ApprovalDetails approvalDetails)
protected void	updatePlaceholdersInSet(EnhancedQueryQualificationSet qualSet, java.util.Map<java.lang.String,java.lang.String> searchPlaceholders) Helper method that looks for placeholders in the qualification set and recursivly replaces placeholders with their values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivitiClientWizardWorkflowImpl

public ActivitiClientWizardWorkflowImpl()

Method Detail

getFormWorkflowDocs

public java.util.List<java.lang.String> getFormWorkflowDocs(java.lang.String ticket,
                                                            java.lang.String formId)
                                                     throws java.lang.Exception

Specified by:

getFormWorkflowDocs in interface IClientWizardWorkflow

Throws:

java.lang.Exception

buildWizardReviewWorkflowProperties

public java.util.Map<java.lang.String,java.io.Serializable> buildWizardReviewWorkflowProperties(java.lang.String ticket,
                                                                                                java.lang.String[] assignees,
                                                                                                WorkflowPackage pkg)

Description copied from interface: IClientWizardWorkflow

Builds the appropriate wf property map with which to start a review workflow.

Specified by:

buildWizardReviewWorkflowProperties in interface IClientWizardWorkflow

pkg - - expected to contain the form id and the ids of any workflow docs

Returns:

getFormIdFromWorkflowInstanceId

protected java.lang.String getFormIdFromWorkflowInstanceId(java.lang.String ticket,
                                                           java.lang.String workflowInstanceId)

getCurrentApprovalDetails

public ApprovalDetails getCurrentApprovalDetails(java.lang.String ticket,
                                                 java.lang.String formId,
                                                 java.lang.String documentId)
                                          throws java.lang.Throwable

Description copied from interface: IClientWizardWorkflow

Returns an ApprovalDetails object pertaining to the specified form, or, if form is null/there is no ad for the form, an ApprovalDetails object pertaining to the specified documentId. Assumes the form has been Finished, with its WizardWorkflowDefinition object built up and existing in the repo.

This method will look for a repository saved instance of the ApprovalDetails object. If one exists, this method will return that cached instance. If one does not exist, a new ApprovalDetails object will be generated, returned, and saved in the repository.

If client code needs to make any adjustments to the approval details object instance, please use this method to retrieve the approval details instance, make any changes to the ApprovalDetails object, then call #setApprovalDetails(String, String, ApprovalDetails).

Specified by:

getCurrentApprovalDetails in interface IClientWizardWorkflow

documentId - - used only if there is no form passed in

Returns:

non null approval details object

Throws:

java.lang.Throwable

resetAndMaintainApprovalDetails

public void resetAndMaintainApprovalDetails(java.lang.String ticket,
                                            java.lang.String formId)

Description copied from interface: IClientWizardWorkflow

If the wizardMaintainSignature property is set to true, this will reserve the existing doc signatures and form signatures onto the savedFormSignatures and savedDocSignatures so that the next signature page generated carries over the old signatures If the wizardMaintainSignature property is set to false, generates a fresh approval details

Specified by:

resetAndMaintainApprovalDetails in interface IClientWizardWorkflow

resetApprovalDetails

public void resetApprovalDetails(java.lang.String ticket,
                                 java.lang.String formId)

Description copied from interface: IClientWizardWorkflow

Generates a fresh approval details and relates it to the form.

Specified by:

resetApprovalDetails in interface IClientWizardWorkflow

setApprovalDetails

public void setApprovalDetails(java.lang.String ticket,
                               java.lang.String formId,
                               java.lang.String documentId,
                               ApprovalDetails approvalDetails)

Specified by:

setApprovalDetails in interface IClientWizardWorkflow

setApprovalDetailsViaWorkflowInstance

public void setApprovalDetailsViaWorkflowInstance(java.lang.String ticket,
                                                  java.lang.String workflowInstanceId,
                                                  ApprovalDetails approvalDetails)

Specified by:

setApprovalDetailsViaWorkflowInstance in interface IClientWizardWorkflow

setApprovalDetailsHelper

protected void setApprovalDetailsHelper(java.lang.String ticket,
                                        java.lang.String formId,
                                        java.lang.String documentId,
                                        ApprovalDetails approvalDetails)

getPotentialApprovers

public java.util.List<UserBean> getPotentialApprovers(java.lang.String ticket,
                                                      java.lang.String formId)

Description copied from interface: IClientWizardWorkflow

Returns UserBean array of users that have been configured via the Finished form to be potential approvers or reviewers. Assumes the specified form has been Finished.

Specified by:

getPotentialApprovers in interface IClientWizardWorkflow

Returns:

getWizardContributors

public java.util.List<UserBean> getWizardContributors(java.lang.String ticket)

Description copied from interface: IClientWizardWorkflow

Returns UserBean array of users that are in the configurable wizard contributors group.

Specified by:

getWizardContributors in interface IClientWizardWorkflow

Returns:

buildWizardApprovalWorkflowProperties

public java.util.Map<java.lang.String,java.io.Serializable> buildWizardApprovalWorkflowProperties(java.lang.String ticket,
                                                                                                  java.lang.String formId,
                                                                                                  WorkflowPackage pkg)

Description copied from interface: IClientWizardWorkflow

Builds the appropriate wf property map with which to start an approva workflow.

Specified by:

buildWizardApprovalWorkflowProperties in interface IClientWizardWorkflow

pkg - - expected to contain the form id and the ids of any workflow docs

Returns:

getUnclaimedActivitiTasks

protected java.util.List<org.activiti.engine.task.Task> getUnclaimedActivitiTasks(java.lang.String ticket,
                                                                                  java.lang.String userLoginName,
                                                                                  java.lang.String workflowInstanceId)

getWizardTasks

public java.util.List<WizardTaskInstance> getWizardTasks(java.lang.String ticket,
                                                         java.lang.String userLoginName,
                                                         java.lang.String workflowInstanceId,
                                                         boolean getFullTasks,
                                                         boolean getClaimableTasks)

Description copied from interface: IClientWizardWorkflow

Retrieve a list of Active Wizard tasks for the given user login name

Specified by:

getWizardTasks in interface IClientWizardWorkflow

Returns:

getFreshApprovalDetails

public ApprovalDetails getFreshApprovalDetails(java.lang.String ticket,
                                               java.lang.String formId)
                                        throws java.lang.Throwable

Specified by:

getFreshApprovalDetails in interface IClientWizardWorkflow

Throws:

java.lang.Throwable

resolveWorkflowDocId

public java.lang.String resolveWorkflowDocId(java.lang.String ticket,
                                             java.lang.String chronId)

Description copied from interface: IClientWizardWorkflow

Given an object's chronicle ID (first version ID), returns the r_object_id of the CURRENT object version

Specified by:

resolveWorkflowDocId in interface IClientWizardWorkflow

chronId - the i_chronicle_id of the object

Returns:

the r_object_id of the CURRENT object version

See Also:

IClientWizardWorkflow.resolveWorkflowDocId(String ticket, String chronId)

searchWFDocs

public QueryResult searchWFDocs(java.lang.String ticket,
                                java.util.Map<java.lang.String,java.lang.String> searchPlaceholders)

Description copied from interface: IClientWizardWorkflow

Searches for workflow documents

Specified by:

searchWFDocs in interface IClientWizardWorkflow

Returns:

a QueryResult object containing an array of document results from the search

See Also:

com.tsgrp.opencontent.wizard.workflow.IClientWizardWorkflow#searchWFDocs(String ticket, Map searchPlaceholders)

updatePlaceholdersInSet

protected void updatePlaceholdersInSet(EnhancedQueryQualificationSet qualSet,
                                       java.util.Map<java.lang.String,java.lang.String> searchPlaceholders)

Helper method that looks for placeholders in the qualification set and recursivly replaces placeholders with their values.

Parameters:

qualSet -

searchPlaceholders -