com.tsgrp.opencontent.wizard

Class PSIJSONUtil

java.lang.Object

com.tsgrp.opencontent.wizard.PSIJSONUtil

public class PSIJSONUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PSIJSONUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	attachWorkflowDocuments(java.lang.String psiObjectId, java.lang.String stringifiedContext, java.lang.String ticket) Attaches workflow documents to an in-stream PSI.
protected boolean	containsGroupedQuestion(java.lang.String text, java.util.List<java.lang.String> questions)
protected static byte[]	generatePDFFromMailMergeTemplate(java.lang.String ticket, java.lang.String stringifiedPSI, java.lang.String mmDocId, java.util.Map<java.lang.String,java.lang.String> allShortLabelsToAnswers) Generates a PDF from a completed Wizard Form (PSI) and uses the answers to fill out and return a completed Mail Merge Document
static java.lang.String	getAdobeTemplate(java.lang.String psdName) Return the PDF name to use for the Adobe generation for the given page set definition.
static java.lang.String	getDisplayValueFromOptions(org.json.JSONArray arr, java.lang.String value) helper function for getting a single display value from a list of options belonging to a question
static java.lang.String	getMailMergeTemplate(java.lang.String ticket, java.lang.String psdName) Util funtion that will return the objectId of the MailMerge Template if it exists
static java.util.ArrayList<java.lang.String>	getRelatedSupportingDocs(java.lang.String psiId, java.lang.String ticket) Util method for returning all the related supporting docs for a page set instance (psiId)
static java.util.ArrayList<java.lang.String>	getSupportingDocsFromPageSetInstance(java.lang.String formId, boolean onFlowpath, java.lang.String ticket) Util method for retrieving all supporting doc ids from a page set instance
static java.lang.String	getWizardFormContent(java.lang.String ticket, java.lang.String formId)
static boolean	hasFolderContext(java.lang.String psiId, java.lang.String ticket)
static java.util.Map<java.lang.String,TemplateAnswer>	indexQuestionsAndAnswers(java.lang.String ticket, java.lang.String formId, boolean useDisplayValues) Util method for retrieving all questions and answers on a form
static java.util.List<java.lang.String>	indexTimingRecipients(java.lang.String timing, java.lang.String ticket, java.lang.String objectId, java.lang.String type) Utility for retrieving all email addresses from a Wizard PSI based on the configured timings.
static byte[]	jsonToPdf(java.lang.String ticket, java.lang.String jsonPsi, boolean createSecondaryDoc) Util function for translating a JSON Page Set Instance into a PDF rendition
static boolean	pageIsInFlowpath(org.json.JSONArray flowpath, org.json.JSONObject page) Recurse through the flowpath and discover if a page is visible or not
static void	relateForm(java.lang.String psiId, java.lang.String stringifiedContext, java.lang.String ticket)
static void	resolveSupportingDocRelations(java.lang.String psiId, java.lang.String ticket) publicly facing api call for correctly removing supporting docs in the following situations: - remove relationship between psi and supporting doc if: - not on flowpath - not on an answered question

Methods inherited from class java.lang.Object

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

Constructor Detail

PSIJSONUtil

public PSIJSONUtil()

Method Detail

resolveSupportingDocRelations

public static void resolveSupportingDocRelations(java.lang.String psiId,
                                                 java.lang.String ticket)

publicly facing api call for correctly removing supporting docs in the following situations: - remove relationship between psi and supporting doc if: - not on flowpath - not on an answered question

Parameters:

psiId - page set instance with supproting docs

ticket - valid oc ticket

hasFolderContext

public static boolean hasFolderContext(java.lang.String psiId,
                                       java.lang.String ticket)

getRelatedSupportingDocs

public static java.util.ArrayList<java.lang.String> getRelatedSupportingDocs(java.lang.String psiId,
                                                                             java.lang.String ticket)

Util method for returning all the related supporting docs for a page set instance (psiId)

Parameters:

psiId - objectId of a page set instance

ticket - valid OC ticket

Returns:

list of related supporting docs

getSupportingDocsFromPageSetInstance

public static java.util.ArrayList<java.lang.String> getSupportingDocsFromPageSetInstance(java.lang.String formId,
                                                                                         boolean onFlowpath,
                                                                                         java.lang.String ticket)

Util method for retrieving all supporting doc ids from a page set instance

Parameters:

formId - json of a page set instance

onFlowpath - flag for if the page should be on the flowpath

ticket - valid OC ticket

Returns:

list of supporting objectIds

getDisplayValueFromOptions

public static java.lang.String getDisplayValueFromOptions(org.json.JSONArray arr,
                                                          java.lang.String value)

helper function for getting a single display value from a list of options belonging to a question

Parameters:

arr - an array of options ex. [{displayValue: 'Review', value: 'review'}]

value - target value to get the associated displayValue with

Returns:

the display values of an array of options that include a value and displayValue for each option.

pageIsInFlowpath

public static boolean pageIsInFlowpath(org.json.JSONArray flowpath,
                                       org.json.JSONObject page)

Recurse through the flowpath and discover if a page is visible or not

Parameters:

flowpath - - tree representing all possible paths through the form

page - - JSONObject that includes the id and any children of the target page

Returns:

true if the page is found and visible, false if not. Throws an error if the page isn't in the flowpath at all. Flowpath is expected to contain every page.

getWizardFormContent

public static java.lang.String getWizardFormContent(java.lang.String ticket,
                                                    java.lang.String formId)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

indexQuestionsAndAnswers

public static java.util.Map<java.lang.String,TemplateAnswer> indexQuestionsAndAnswers(java.lang.String ticket,
                                                                                      java.lang.String formId,
                                                                                      boolean useDisplayValues)

Util method for retrieving all questions and answers on a form

Parameters:

ticket - valid OC ticket

formId - id of a page set instance

Returns:

map of short-label questions and their answer values

containsGroupedQuestion

protected boolean containsGroupedQuestion(java.lang.String text,
                                          java.util.List<java.lang.String> questions)

jsonToPdf

public static byte[] jsonToPdf(java.lang.String ticket,
                               java.lang.String jsonPsi,
                               boolean createSecondaryDoc)

Util function for translating a JSON Page Set Instance into a PDF rendition

Parameters:

ticket - - valid OC ticket

jsonPsi - - stringified json of a page set instance

createSecondaryDoc - - indicates whether a secondary doc will be created and related to the form

Returns:

byte stream of the PDF content

getAdobeTemplate

public static java.lang.String getAdobeTemplate(java.lang.String psdName)

Return the PDF name to use for the Adobe generation for the given page set definition. This method checks for a template with the same name as the PSD, all lower case and underscores instead of spaces and ending in '-template.pdf'. Otherwise, the default template name is returned. For example: The PSD with the name 'My Form Name' template should have a custom template called my_form_name-template.pdf. Otherwise, return null.

Parameters:

psdName - the page set definition name

Returns:

the name of the template to use, either form specific or the default

getMailMergeTemplate

public static java.lang.String getMailMergeTemplate(java.lang.String ticket,
                                                    java.lang.String psdName)

Util funtion that will return the objectId of the MailMerge Template if it exists

Parameters:

ticket -

psdName - the page set definition name

Returns:

objectId of MailMerge Template if it exists, empty string if it doesn't

generatePDFFromMailMergeTemplate

protected static byte[] generatePDFFromMailMergeTemplate(java.lang.String ticket,
                                                         java.lang.String stringifiedPSI,
                                                         java.lang.String mmDocId,
                                                         java.util.Map<java.lang.String,java.lang.String> allShortLabelsToAnswers)

Generates a PDF from a completed Wizard Form (PSI) and uses the answers to fill out and return a completed Mail Merge Document

Parameters:

ticket -

stringifiedPSI - the stringified completed Page Set Instance

mmDocId - objectId of the Mail Merge doc template

allShortLabelsToAnswers - map of answers on each page of the form

Returns:

a PDF byte array of the completed Mail Merge template

attachWorkflowDocuments

public static java.lang.String[] attachWorkflowDocuments(java.lang.String psiObjectId,
                                                         java.lang.String stringifiedContext,
                                                         java.lang.String ticket)

Attaches workflow documents to an in-stream PSI. This is used when creating a form and attaching a workflow document at the same time (from stage or search).

Parameters:

psiObjectId -

stringifiedContext -

ticket -

Returns:

indexTimingRecipients

public static java.util.List<java.lang.String> indexTimingRecipients(java.lang.String timing,
                                                                     java.lang.String ticket,
                                                                     java.lang.String objectId,
                                                                     java.lang.String type)

Utility for retrieving all email addresses from a Wizard PSI based on the configured timings.

Parameters:

timing: - SUBMIT: these recipients receive an email when this form is routed for approval APPROVE: these recipients receive an email when this form is approved REJECT: these recipients receive an email when this form is rejected and sent back to draft

Returns:

email addresses based on the passed in timing

relateForm

public static void relateForm(java.lang.String psiId,
                              java.lang.String stringifiedContext,
                              java.lang.String ticket)