com.tsgrp.opencontent.wizard.workflow

Interface IClientWizardWorkflow

All Known Implementing Classes:

ActivitiClientWizardWorkflowImpl

public interface IClientWizardWorkflow

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[] assigneeUserLoginNames, 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.
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.
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)
void	setApprovalDetailsViaWorkflowInstance(java.lang.String ticket, java.lang.String workflowInstanceId, ApprovalDetails approvalDetails)

Method Detail

getFormWorkflowDocs

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

Throws:

java.lang.Exception

getCurrentApprovalDetails

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

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).

Parameters:

ticket -

formId -

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

Returns:

non null approval details object

Throws:

throwable - - if there was any problem with retrieving the approval details

java.lang.Throwable

resetAndMaintainApprovalDetails

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

Parameters:

ticket -

formId -

resetApprovalDetails

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

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

Parameters:

ticket -

formId -

getFreshApprovalDetails

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

Throws:

java.lang.Throwable

setApprovalDetails

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

setApprovalDetailsViaWorkflowInstance

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

buildWizardReviewWorkflowProperties

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

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

Parameters:

ticket -

assigneeUserLoginNames -

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

Returns:

buildWizardApprovalWorkflowProperties

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.

Parameters:

ticket -

assigneeUserLoginNames -

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

Returns:

getPotentialApprovers

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. Assumes the specified form has been Finished.

Parameters:

ticket -

formId -

Returns:

getWizardContributors

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

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

Parameters:

ticket -

Returns:

getWizardTasks

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

Parameters:

ticket -

userLoginName -

workflowInstanceId -

getFullTasks -

getClaimableTasks -

Returns:

resolveWorkflowDocId

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

Parameters:

ticket -

chronId - the i_chronicle_id of the object

Returns:

the r_object_id of the CURRENT object version

searchWFDocs

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

Searches for workflow documents

Parameters:

ticket -

searchPlaceholders -

Returns:

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