com.tsgrp.opencontent.wizard.core

Interface IWizard2

All Known Implementing Classes:

AlfrescoWizard2Impl, DynamoWizard2Impl, HBaseWizard2Impl, Wizard2Impl

public interface IWizard2

Method Summary

Modifier and Type	Method and Description
void	addQuestionsAsProperties(java.lang.String ticket, EnhancedCompleteObject eco, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> psiMap) This Method is used to add the question/answer pairs from the from as properties on the eco.
boolean	closeForm(java.lang.String ticket, java.lang.String formId, java.lang.String comments) Closed the form
java.lang.String	createPageSetInstance(java.lang.String ticket, java.lang.String parentId, java.lang.String psiName, java.lang.String pageSetName, java.lang.String psiType, java.lang.String stringifiedPSI, java.util.List<java.util.Map<java.lang.String,java.lang.String>> supportingDocs, byte[] pdfRendition, java.lang.String stringifiedContext) Creates a page set instance object in the repository and returns the objectId to return back to the user.
Wizard2Result	deletePageSetInstance(java.lang.String ticket, java.lang.String psiId) Deletes the PSI with the given id.
QueryResult	executeAWQueryAction(java.lang.String ticket, Action queryAction) Executes an Active Wizard answer or question query Action
QueryResult	executeAWQueryAction(java.lang.String ticket, java.lang.String queryName, java.util.Map<java.lang.String,java.lang.String> substitutions) Executes an Active Wizard query using the given substitution map
PageSet	getPageSet(java.lang.String ticket, java.lang.String pageSetName, java.lang.String versionLabel) Returns the PageSet object for the given parameters.
PageSet[]	getPageSets(java.lang.String ticket) Returns only the ACTIVE page set objects that are available to be created by users
java.util.Map<java.lang.String,java.lang.String>	getWizardQuery(java.lang.String ticket, java.lang.String objectId) Gets a WizardQuery object with its metadata, parsing into a map.
java.lang.String	getWorkflowAttachmentId(java.lang.String ticket, java.lang.String objectId) This method retrieves the "correct" workflow attachment ID for the given object.
boolean	isAutoNumbered(java.lang.String ticket, java.lang.String pageSetName) Checks if this page set has autonumber configured
void	makeDocsEffective(java.lang.String ticket) Promotes documents' aw-status to effective based on their Effective Date.
void	makeDocsObsolete(java.lang.String ticket) Promotes documents' aw-status to obsolete based on their Effective Date.
java.lang.String	savePageSetInstance(java.lang.String ticket, java.lang.String formId, java.lang.String psiName, java.lang.String psdName, java.lang.String stringifiedPSI, java.util.List<java.util.Map<java.lang.String,java.lang.String>> supportingDocs, byte[] pdfRendition) Saves the PageSetInstance with the given formId.
void	startPeriodicReviewWorkflow(java.lang.String ticket) Executes a periodic workflow on documents that have a Periodic Review Date w/in a hardcoded # of days.

Method Detail

getPageSet

PageSet getPageSet(java.lang.String ticket,
                   java.lang.String pageSetName,
                   java.lang.String versionLabel)

Returns the PageSet object for the given parameters.

Parameters:

ticket - - OpenContent ticket

pageSetName - - name of PageSet

versionLabel - - optional - versionLabel of PageSet to pull, returns ACTIVE version if not supplied

Returns:

the PageSet

getPageSets

PageSet[] getPageSets(java.lang.String ticket)

Returns only the ACTIVE page set objects that are available to be created by users

Parameters:

ticket - - OpenContent ticket

Returns:

an array of the active PageSet objects

createPageSetInstance

java.lang.String createPageSetInstance(java.lang.String ticket,
                                       java.lang.String parentId,
                                       java.lang.String psiName,
                                       java.lang.String pageSetName,
                                       java.lang.String psiType,
                                       java.lang.String stringifiedPSI,
                                       java.util.List<java.util.Map<java.lang.String,java.lang.String>> supportingDocs,
                                       byte[] pdfRendition,
                                       java.lang.String stringifiedContext)

Creates a page set instance object in the repository and returns the objectId to return back to the user.

Parameters:

ticket - OpenContent ticket

parentId -

psiName - sets the OCConstants.ATTR_NAME field with the provided value. Note, this parameter can be null or blank if the page set is autonumbered. If the form is autonumbered, whatever is passed in for the psiName will be overwritten with the next auto number.

pageSetName - Name of PageSet to create PSI from.

psiType -

stringifiedPSI - This is a stringified version of the page set instance that the user submitted

supportingDocs - these are the supporting doc ids that a user uploads passed in as a map of object names and their ids

relationType -

pdfRendition - This is a pdf rendition of the page set instance

context - for streamline mode, workflow doc reference, etc

Returns:

String ObjectId

savePageSetInstance

java.lang.String savePageSetInstance(java.lang.String ticket,
                                     java.lang.String formId,
                                     java.lang.String psiName,
                                     java.lang.String psdName,
                                     java.lang.String stringifiedPSI,
                                     java.util.List<java.util.Map<java.lang.String,java.lang.String>> supportingDocs,
                                     byte[] pdfRendition)

Saves the PageSetInstance with the given formId.

Parameters:

ticket - OpenContent ticket

formId - the formId of the PSI

psiName - sets the OCConstants.ATTR_NAME field with the provided value. Note, this parameter can be null or blank

stringifiedPSI - This is a stringified version of the page set instance that the user submitted

supportingDocs - these are the supporting doc ids that a user uploads passed in as a map of object names and their associated objectIDs

pdfRendition - This is a pdf rendition of the page set instance

Returns:

executeAWQueryAction

QueryResult executeAWQueryAction(java.lang.String ticket,
                                 Action queryAction)

Executes an Active Wizard answer or question query Action

Parameters:

ticket - OC ticket

queryAction - the query action to run

Returns:

QueryResult

executeAWQueryAction

QueryResult executeAWQueryAction(java.lang.String ticket,
                                 java.lang.String queryName,
                                 java.util.Map<java.lang.String,java.lang.String> substitutions)

Executes an Active Wizard query using the given substitution map

Parameters:

ticket - auth ticket

queryName - the name of the query to run

substitutions - the map of substitutions

Returns:

QueryResult

deletePageSetInstance

Wizard2Result deletePageSetInstance(java.lang.String ticket,
                                    java.lang.String psiId)

Deletes the PSI with the given id.

Parameters:

ticket - - OpenContent ticket

psiId - - object id of the PSI.

Returns:

• Wizard2Result
• error returns true if there is an error deleting the PSI, actual deletion return false.

isAutoNumbered

boolean isAutoNumbered(java.lang.String ticket,
                       java.lang.String pageSetName)

Checks if this page set has autonumber configured

Parameters:

ticket -

pageSetName -

Returns:

true if the page set should be autonumbered, false if not or an error

closeForm

boolean closeForm(java.lang.String ticket,
                  java.lang.String formId,
                  java.lang.String comments)

Closed the form

Parameters:

ticket -

formId - - a string, used to identify the form

comments - - a string that include the comments for closure

Returns:

- returns true if form is closed properly

getWizardQuery

java.util.Map<java.lang.String,java.lang.String> getWizardQuery(java.lang.String ticket,
                                                                java.lang.String objectId)

Gets a WizardQuery object with its metadata, parsing into a map. This method is for runtime query instances in a PSI. For wizard admin, use IWizard2Admin.

Parameters:

ticket - - resolved cookie/param ticket

objectId - - WizardQuery objectId

Returns:

mapped WizardQuery object

addQuestionsAsProperties

void addQuestionsAsProperties(java.lang.String ticket,
                              EnhancedCompleteObject eco,
                              java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> psiMap)

This Method is used to add the question/answer pairs from the from as properties on the eco.

Parameters:

ticket - an OpenContent Ticket

eco - The EnhancedCompleteObject to add the properties to

psiMap - The Page Set Instance.

getWorkflowAttachmentId

java.lang.String getWorkflowAttachmentId(java.lang.String ticket,
                                         java.lang.String objectId)

This method retrieves the "correct" workflow attachment ID for the given object. By default, this is the same as the chronicle ID; however, some repositories may require this ID to be a different ID.

Parameters:

ticket - OC Ticket

objectId - The object to find the workflow attachment ID for

Returns:

the workflow attachment ID

startPeriodicReviewWorkflow

void startPeriodicReviewWorkflow(java.lang.String ticket)

Executes a periodic workflow on documents that have a Periodic Review Date w/in a hardcoded # of days.

Parameters:

ticket -

makeDocsEffective

void makeDocsEffective(java.lang.String ticket)

Promotes documents' aw-status to effective based on their Effective Date.

Parameters:

ticket -

makeDocsObsolete

void makeDocsObsolete(java.lang.String ticket)

Promotes documents' aw-status to obsolete based on their Effective Date.

Parameters:

ticket -