public interface IWizard2
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.
|
PageSet getPageSet(java.lang.String ticket, java.lang.String pageSetName, java.lang.String versionLabel)
PageSet
object for the given parameters.ticket
- - OpenContent ticketpageSetName
- - name of PageSetversionLabel
- - optional - versionLabel of PageSet to pull, returns ACTIVE version if not suppliedPageSet[] getPageSets(java.lang.String ticket)
ticket
- - OpenContent ticketjava.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)
ticket
- OpenContent ticketparentId
- 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 submittedsupportingDocs
- these are the supporting doc ids that a user uploads passed in as a map of object names and their idsrelationType
- pdfRendition
- This is a pdf rendition of the page set instancecontext
- for streamline mode, workflow doc reference, etcjava.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)
ticket
- OpenContent ticketformId
- the formId of the PSIpsiName
- sets the OCConstants.ATTR_NAME
field with the provided value. Note, this parameter can be null or blankstringifiedPSI
- This is a stringified version of the page set instance that the user submittedsupportingDocs
- these are the supporting doc ids that a user uploads passed in as a map of object names and their associated objectIDspdfRendition
- This is a pdf rendition of the page set instanceQueryResult executeAWQueryAction(java.lang.String ticket, Action queryAction)
ticket
- OC ticketqueryAction
- the query action to runQueryResult
QueryResult executeAWQueryAction(java.lang.String ticket, java.lang.String queryName, java.util.Map<java.lang.String,java.lang.String> substitutions)
ticket
- auth ticketqueryName
- the name of the query to runsubstitutions
- the map of substitutionsQueryResult
Wizard2Result deletePageSetInstance(java.lang.String ticket, java.lang.String psiId)
ticket
- - OpenContent ticketpsiId
- - object id of the PSI.Wizard2Result
error
returns true if there is an error deleting the PSI, actual deletion return false.boolean isAutoNumbered(java.lang.String ticket, java.lang.String pageSetName)
ticket
- pageSetName
- boolean closeForm(java.lang.String ticket, java.lang.String formId, java.lang.String comments)
ticket
- formId
- - a string, used to identify the formcomments
- - a string that include the comments for closurejava.util.Map<java.lang.String,java.lang.String> getWizardQuery(java.lang.String ticket, java.lang.String objectId)
IWizard2Admin
.ticket
- - resolved cookie/param ticketobjectId
- - WizardQuery objectIdvoid addQuestionsAsProperties(java.lang.String ticket, EnhancedCompleteObject eco, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> psiMap)
ticket
- an OpenContent Ticketeco
- The EnhancedCompleteObject to add the properties topsiMap
- The Page Set Instance.java.lang.String getWorkflowAttachmentId(java.lang.String ticket, java.lang.String objectId)
ticket
- OC TicketobjectId
- The object to find the workflow attachment ID forvoid startPeriodicReviewWorkflow(java.lang.String ticket)
ticket
- void makeDocsEffective(java.lang.String ticket)
ticket
- void makeDocsObsolete(java.lang.String ticket)
ticket
-