com.accela.aa.emse.dom

Class DocumentScript

java.lang.Object

com.accela.aa.emse.dom.service.BaseAAScript

com.accela.aa.emse.dom.DocumentScript

All Implemented Interfaces:

com.accela.aa.emse.dom.service.ScriptAble

public class DocumentScript
extends com.accela.aa.emse.dom.service.BaseAAScript

 
  Accela Automation
  File: DocumentScript.java
 
  Accela, Inc.
  Copyright (C): 2010-2014
 
  Description:
  TODO
 
  Notes:
        $Id: DocumentScript.java 72642 2009-01-01 20:01:57Z ..\ashley.zou $ 
 
  Revision History
  <Date>,                 <Who>,                    <What>
  2010-2-23             ashley.zou              Initial.
 
 

Constructor Summary

Constructors

Constructor and Description
DocumentScript(java.lang.String serviceProviderCode, java.lang.String auditID, com.accela.aa.emse.dom.service.CachedService cachedService) Constructor for CapScript.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	assignReviewer(com.accela.orm.model.document.DocumentEntityAssociationModel documentEntityAssociationModel) Add Document Entity Associations.
ScriptResult	associateDoc2Task(java.util.List<DocumentModel> docList, com.accela.aa.workflow.workflow.TaskItemModel taskItemModel) Associate doc2 task.
ScriptResult	associateReviewer2Doc(java.util.List<DocumentModel> docList, java.util.List<com.accela.aa.aamain.people.SysUserModel> reviewerList, com.accela.aa.workflow.workflow.TaskItemModel taskItemModel) Associate reviewer2 doc.
ScriptResult	createDocument(DocumentModel documentModel) Creates the document.
ScriptResult	getACADocumentUrl(java.lang.String url, DocumentModel documentModel) get ACA URL
ScriptResult	getCapDocumentList(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String currentUserID) get cap document list
ScriptResult	getCapTaskByCapID(com.accela.aa.aamain.cap.CapIDModel capID) Gets the cap task by cap id.
ScriptResult	getDocumentByPK(java.lang.String documentID) get document by PK
ScriptResult	getDocumentListByEntity(java.lang.String entityID, java.lang.String entityType) get document list by entity: 1, for License Professional: the entityID is licSeqNbr, and the entityType is 'LICENSEPROFESSIONAL'
ScriptResult	getOriginalDoc(DocumentModel resubmitDocModel) Get Original Document By Resubmit Document.
ScriptResult	getRelatedReviewers(java.lang.Long docID, com.accela.aa.workflow.workflow.TaskItemModel taskItemModel) Gets the related reviewers.
ScriptResult	getTaskItemModel()
ScriptResult	newDocumentContentModel() New document content model.
ScriptResult	newDocumentModel() New document model.
ScriptResult	removeDocumentByPK(java.lang.String docSeq, java.lang.String userName, java.lang.String password, java.lang.String moduleName) Removes the document by sequence number
ScriptResult	sendEmailAndSaveAsDocument(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String templateName, java.util.Hashtable<java.lang.String,java.lang.String> contentVariables, CapIDScriptModel capIDScriptModel, java.lang.String[] fileNames) send email and upload document by notification template name.
ScriptResult	sendEmailAndSaveAsDocument4Workflow(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String content, java.lang.String[] fileNames, ProcessNoteScriptModel processNoteScriptModel) Send Email and save to document
ScriptResult	sendEmailByTemplateName(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String templateName, java.util.Hashtable<java.lang.String,java.lang.String> contentVariables, java.lang.String[] fileNames) Send email by notification template name.
ScriptResult	updateDocument(DocumentModel docModel) Update Document.
ScriptResult	updateReviewTask(com.accela.orm.model.document.DocumentEntityAssociationModel documentEntityAssociationModel) update DocumentEntityAssociationModel

Methods inherited from class com.accela.aa.emse.dom.service.BaseAAScript

initScript

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentScript

public DocumentScript(java.lang.String serviceProviderCode,
              java.lang.String auditID,
              com.accela.aa.emse.dom.service.CachedService cachedService)
               throws com.accela.aa.exception.AAException

Constructor for CapScript.

Parameters:

serviceProviderCode - agency code

auditID - the caller id

Throws:

com.accela.aa.exception.AAException

Method Detail

getCapDocumentList

public ScriptResult getCapDocumentList(com.accela.aa.aamain.cap.CapIDModel capID,
                              java.lang.String currentUserID)

get cap document list

Parameters:

capID - cap id model

currentUserID - callerid

Returns:

ScriptResult

associateDoc2Task

public ScriptResult associateDoc2Task(java.util.List<DocumentModel> docList,
                             com.accela.aa.workflow.workflow.TaskItemModel taskItemModel)

Associate doc2 task.

Parameters:

docList - the doc list

taskItemModelList - the task item model list

Returns:

the script result

getOriginalDoc

public ScriptResult getOriginalDoc(DocumentModel resubmitDocModel)

Get Original Document By Resubmit Document.

Parameters:

resubmitDocModel - resubmit Doc Model

Returns:

the script result

updateDocument

public ScriptResult updateDocument(DocumentModel docModel)

Update Document.

Parameters:

docModel - Doc Model

Returns:

the script result

assignReviewer

public ScriptResult assignReviewer(com.accela.orm.model.document.DocumentEntityAssociationModel documentEntityAssociationModel)

Add Document Entity Associations.

Parameters:

documentEntityAssociationModel - Document Entity Association Model

Returns:

the script result

associateReviewer2Doc

public ScriptResult associateReviewer2Doc(java.util.List<DocumentModel> docList,
                                 java.util.List<com.accela.aa.aamain.people.SysUserModel> reviewerList,
                                 com.accela.aa.workflow.workflow.TaskItemModel taskItemModel)

Associate reviewer2 doc.

Parameters:

docList - the doc list

reviewerList - the reviewer list

taskItemModel - the task item model

Returns:

the script result

getRelatedReviewers

public ScriptResult getRelatedReviewers(java.lang.Long docID,
                               com.accela.aa.workflow.workflow.TaskItemModel taskItemModel)

Gets the related reviewers.

Parameters:

docID - the doc id

taskItemModel -

Returns:

the related reviewers

updateReviewTask

public ScriptResult updateReviewTask(com.accela.orm.model.document.DocumentEntityAssociationModel documentEntityAssociationModel)

update DocumentEntityAssociationModel

Parameters:

documentEntityAssociationModels -

Returns:

the script result

getCapTaskByCapID

public ScriptResult getCapTaskByCapID(com.accela.aa.aamain.cap.CapIDModel capID)

Gets the cap task by cap id.

Parameters:

capID - the cap id

Returns:

the cap task by cap id

getTaskItemModel

public ScriptResult getTaskItemModel()

getDocumentByPK

public ScriptResult getDocumentByPK(java.lang.String documentID)

get document by PK

Parameters:

documentID -

Returns:

Throws:

java.lang.Exception

sendEmailByTemplateName

public ScriptResult sendEmailByTemplateName(java.lang.String from,
                                   java.lang.String to,
                                   java.lang.String cc,
                                   java.lang.String templateName,
                                   java.util.Hashtable<java.lang.String,java.lang.String> contentVariables,
                                   java.lang.String[] fileNames)

Send email by notification template name.

Parameters:

from - email address from

to - email address to

cc - email address cc

templateName - template name

contentVariables - variables for email subject and content

fileNames - the file names of attachment

Returns:

sendEmailAndSaveAsDocument

public ScriptResult sendEmailAndSaveAsDocument(java.lang.String from,
                                      java.lang.String to,
                                      java.lang.String cc,
                                      java.lang.String templateName,
                                      java.util.Hashtable<java.lang.String,java.lang.String> contentVariables,
                                      CapIDScriptModel capIDScriptModel,
                                      java.lang.String[] fileNames)

send email and upload document by notification template name.

Parameters:

templateName - notification template name

contentVariables - Hashtable

CapIDScriptModel - capIDScriptModel

fileNames - attached file names in email content

Returns:

sendEmailAndSaveAsDocument4Workflow

public ScriptResult sendEmailAndSaveAsDocument4Workflow(java.lang.String from,
                                               java.lang.String to,
                                               java.lang.String cc,
                                               java.lang.String subject,
                                               java.lang.String content,
                                               java.lang.String[] fileNames,
                                               ProcessNoteScriptModel processNoteScriptModel)

Send Email and save to document

Parameters:

from - the email address that send the email

to - the email address to send

cc - the email address to CC, can be null

subject - the mail subject

content - the mail content

fileNames - the fileNames array

ProcessNoteScriptModel - processNoteScriptModel such as included AttachTo, EdmsName, DocGroup, DocCategory, and CAPID.

Returns:

Result the Result object, getSuccess() can identify whether the email is sent successfully, if fail, getMessage() can tell why.

getACADocumentUrl

public ScriptResult getACADocumentUrl(java.lang.String url,
                             DocumentModel documentModel)

get ACA URL

Parameters:

url -

documentModel -

Returns:

removeDocumentByPK

public ScriptResult removeDocumentByPK(java.lang.String docSeq,
                              java.lang.String userName,
                              java.lang.String password,
                              java.lang.String moduleName)

Removes the document by sequence number

Parameters:

docSeq - the doc sequence number

userName -

password -

moduleName -

Returns:

the script result

createDocument

public ScriptResult createDocument(DocumentModel documentModel)

Creates the document.

Parameters:

documentModel - the document model

Returns:

the script result

newDocumentModel

public ScriptResult newDocumentModel()

New document model.

Returns:

the script result

newDocumentContentModel

public ScriptResult newDocumentContentModel()

New document content model.

Returns:

the script result

getDocumentListByEntity

public ScriptResult getDocumentListByEntity(java.lang.String entityID,
                                   java.lang.String entityType)

get document list by entity: 1, for License Professional: the entityID is licSeqNbr, and the entityType is 'LICENSEPROFESSIONAL'

Parameters:

entityID -

entityType -

Returns: