org.kuali.rice.krad.service.impl

Class DocumentServiceImpl

java.lang.Object

org.kuali.rice.krad.service.impl.DocumentServiceImpl

All Implemented Interfaces:

org.kuali.rice.krad.service.DocumentService

public class DocumentServiceImpl
extends Object
implements org.kuali.rice.krad.service.DocumentService

Created by gopalp on 7/7/15.

Constructor Summary

Constructors

Constructor and Description
DocumentServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
org.kuali.rice.krad.document.Document	acknowledgeDocument(org.kuali.rice.krad.document.Document document, String annotation, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
org.kuali.rice.krad.document.Document	approveDocument(org.kuali.rice.krad.document.Document document, String annotation, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
org.kuali.rice.krad.document.Document	blanketApproveDocument(org.kuali.rice.krad.document.Document document, String annotation, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
org.kuali.rice.krad.document.Document	cancelDocument(org.kuali.rice.krad.document.Document document, String annotation)
protected void	checkForNulls(org.kuali.rice.krad.document.Document document)
org.kuali.rice.krad.document.Document	clearDocumentFyi(org.kuali.rice.krad.document.Document document, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
org.kuali.rice.krad.document.Document	completeDocument(org.kuali.rice.krad.document.Document document, String annotation, List adHocRecipients)
org.kuali.rice.krad.bo.Note	createNoteFromDocument(org.kuali.rice.krad.document.Document document, String text)
org.kuali.rice.krad.document.Document	disapproveDocument(org.kuali.rice.krad.document.Document document, String annotation)
boolean	documentExists(String documentHeaderId)
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
org.kuali.rice.krad.document.Document	getByDocumentHeaderId(String documentHeaderId) This is temporary until workflow 2.0 and reads from a table to get documents whose status has changed to A (approved - no outstanding approval actions requested)
org.kuali.rice.krad.document.Document	getByDocumentHeaderIdSessionless(String documentHeaderId)
protected org.kuali.rice.krad.service.DataDictionaryService	getDataDictionaryService()
protected org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService()
protected org.kuali.rice.krad.dao.DocumentDao	getDocumentDao()
protected org.kuali.rice.krad.service.DocumentDictionaryService	getDocumentDictionaryService()
protected org.kuali.rice.krad.service.DocumentHeaderService	getDocumentHeaderService()
List<org.kuali.rice.krad.document.Document>	getDocumentsByListOfDocumentHeaderIds(Class<? extends org.kuali.rice.krad.document.Document> documentClass, List<String> documentHeaderIds) The default implementation - this retrieves all documents by a list of documentHeader for a given class.
org.kuali.rice.krad.document.Document	getNewDocument(Class<? extends org.kuali.rice.krad.document.Document> documentClass) Creates a new document by class.
org.kuali.rice.krad.document.Document	getNewDocument(String documentTypeName) Creates a new document by document type name.
org.kuali.rice.krad.document.Document	getNewDocument(String documentTypeName, String initiatorPrincipalNm) Creates a new document by document type name.
protected org.kuali.rice.krad.service.NoteService	getNoteService()
org.kuali.rice.kim.api.identity.PersonService	getPersonService()
protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService	getWorkflowDocumentService()
protected boolean	isNoteTargetReady(org.kuali.rice.krad.document.Document document) Determines if the given document's note target is ready for notes to be attached and persisted against it.
protected void	loadNotes(org.kuali.rice.krad.document.Document document) Loads the Notes for the note target on this Document.
void	prepareWorkflowDocument(org.kuali.rice.krad.document.Document document) Sets the title and app document id in the flex document
org.kuali.rice.krad.document.Document	recallDocument(org.kuali.rice.krad.document.Document document, String annotation, boolean cancel)
org.kuali.rice.krad.document.Document	routeDocument(org.kuali.rice.krad.document.Document document, String annotation, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
org.kuali.rice.krad.document.Document	saveDocument(org.kuali.rice.krad.document.Document document)
org.kuali.rice.krad.document.Document	saveDocument(org.kuali.rice.krad.document.Document document, Class<? extends org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent> kualiDocumentEventClass)
boolean	saveDocumentNotes(org.kuali.rice.krad.document.Document document)
void	sendAdHocRequests(org.kuali.rice.krad.document.Document document, String annotation, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
void	sendNoteRouteNotification(org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.bo.Note note, org.kuali.rice.kim.api.identity.Person sender)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDataDictionaryService(org.kuali.rice.krad.service.DataDictionaryService dataDictionaryService)
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)
void	setDocumentDao(org.kuali.rice.krad.dao.DocumentDao documentDao)
void	setDocumentDictionaryService(org.kuali.rice.krad.service.DocumentDictionaryService documentDictionaryService)
void	setDocumentHeaderService(org.kuali.rice.krad.service.DocumentHeaderService documentHeaderService)
void	setKualiConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService kualiConfigurationService)
void	setNoteService(org.kuali.rice.krad.service.NoteService noteService)
void	setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService)
org.kuali.rice.krad.document.Document	superUserApproveDocument(org.kuali.rice.krad.document.Document document, String annotation)
org.kuali.rice.krad.document.Document	superUserCancelDocument(org.kuali.rice.krad.document.Document document, String annotation)
org.kuali.rice.krad.document.Document	superUserDisapproveDocument(org.kuali.rice.krad.document.Document document, String annotation)
org.kuali.rice.krad.document.Document	superUserDisapproveDocumentWithoutSaving(org.kuali.rice.krad.document.Document document, String annotation)
org.kuali.rice.krad.document.Document	updateDocument(org.kuali.rice.krad.document.Document document) This is to allow for updates of document statuses and other related requirements for updates outside of the initial save and route
org.kuali.rice.krad.document.Document	validateAndPersistDocument(org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event) Validates and persists a document.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentServiceImpl

public DocumentServiceImpl()

Method Detail

saveDocument

public org.kuali.rice.krad.document.Document saveDocument(org.kuali.rice.krad.document.Document document)
                                                   throws org.kuali.rice.kew.api.exception.WorkflowException,
                                                          org.kuali.rice.krad.exception.ValidationException

Specified by:

saveDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

org.kuali.rice.krad.exception.ValidationException

See Also:

DocumentService.saveDocument(Document)

saveDocument

public org.kuali.rice.krad.document.Document saveDocument(org.kuali.rice.krad.document.Document document,
                                                 Class<? extends org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent> kualiDocumentEventClass)
                                                   throws org.kuali.rice.kew.api.exception.WorkflowException,
                                                          org.kuali.rice.krad.exception.ValidationException

Specified by:

saveDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

org.kuali.rice.krad.exception.ValidationException

routeDocument

public org.kuali.rice.krad.document.Document routeDocument(org.kuali.rice.krad.document.Document document,
                                                  String annotation,
                                                  List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
                                                    throws org.kuali.rice.krad.exception.ValidationException,
                                                           org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

routeDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.krad.exception.ValidationException

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.routeDocument(Document, String, List)

approveDocument

public org.kuali.rice.krad.document.Document approveDocument(org.kuali.rice.krad.document.Document document,
                                                    String annotation,
                                                    List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
                                                      throws org.kuali.rice.krad.exception.ValidationException,
                                                             org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

approveDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.krad.exception.ValidationException

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.approveDocument(Document, String, List)

superUserApproveDocument

public org.kuali.rice.krad.document.Document superUserApproveDocument(org.kuali.rice.krad.document.Document document,
                                                             String annotation)
                                                               throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

superUserApproveDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.superUserApproveDocument(Document, String)

superUserCancelDocument

public org.kuali.rice.krad.document.Document superUserCancelDocument(org.kuali.rice.krad.document.Document document,
                                                            String annotation)
                                                              throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

superUserCancelDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.superUserCancelDocument(Document, String)

superUserDisapproveDocument

public org.kuali.rice.krad.document.Document superUserDisapproveDocument(org.kuali.rice.krad.document.Document document,
                                                                String annotation)
                                                                  throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

superUserDisapproveDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.superUserCancelDocument(Document, String)

superUserDisapproveDocumentWithoutSaving

public org.kuali.rice.krad.document.Document superUserDisapproveDocumentWithoutSaving(org.kuali.rice.krad.document.Document document,
                                                                             String annotation)
                                                                               throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

superUserDisapproveDocumentWithoutSaving in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.superUserCancelDocument(Document, String)

disapproveDocument

public org.kuali.rice.krad.document.Document disapproveDocument(org.kuali.rice.krad.document.Document document,
                                                       String annotation)
                                                         throws Exception

Specified by:

disapproveDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

Exception

See Also:

DocumentService.disapproveDocument(Document, String)

cancelDocument

public org.kuali.rice.krad.document.Document cancelDocument(org.kuali.rice.krad.document.Document document,
                                                   String annotation)
                                                     throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

cancelDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.cancelDocument(Document, String)

recallDocument

public org.kuali.rice.krad.document.Document recallDocument(org.kuali.rice.krad.document.Document document,
                                                   String annotation,
                                                   boolean cancel)
                                                     throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

recallDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

acknowledgeDocument

public org.kuali.rice.krad.document.Document acknowledgeDocument(org.kuali.rice.krad.document.Document document,
                                                        String annotation,
                                                        List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
                                                          throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

acknowledgeDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.acknowledgeDocument(Document, String, List)

blanketApproveDocument

public org.kuali.rice.krad.document.Document blanketApproveDocument(org.kuali.rice.krad.document.Document document,
                                                           String annotation,
                                                           List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
                                                             throws org.kuali.rice.krad.exception.ValidationException,
                                                                    org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

blanketApproveDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.krad.exception.ValidationException

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.blanketApproveDocument(Document, String, List)

clearDocumentFyi

public org.kuali.rice.krad.document.Document clearDocumentFyi(org.kuali.rice.krad.document.Document document,
                                                     List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
                                                       throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

clearDocumentFyi in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.clearDocumentFyi(Document, List)

completeDocument

public org.kuali.rice.krad.document.Document completeDocument(org.kuali.rice.krad.document.Document document,
                                                     String annotation,
                                                     List adHocRecipients)
                                                       throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

completeDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.completeDocument(Document, String, List)

checkForNulls

protected void checkForNulls(org.kuali.rice.krad.document.Document document)

documentExists

public boolean documentExists(String documentHeaderId)

Specified by:

documentExists in interface org.kuali.rice.krad.service.DocumentService

See Also:

DocumentService.documentExists(String)

getNewDocument

public org.kuali.rice.krad.document.Document getNewDocument(Class<? extends org.kuali.rice.krad.document.Document> documentClass)
                                                     throws org.kuali.rice.kew.api.exception.WorkflowException

Creates a new document by class.

Specified by:

getNewDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.getNewDocument(Class)

getNewDocument

public org.kuali.rice.krad.document.Document getNewDocument(String documentTypeName,
                                                   String initiatorPrincipalNm)
                                                     throws org.kuali.rice.kew.api.exception.WorkflowException

Creates a new document by document type name. The principal name passed in will be used as the document initiator. If the initiatorPrincipalNm is null or blank, the current user will be used.

Specified by:

getNewDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.getNewDocument(String, String)

getNewDocument

public org.kuali.rice.krad.document.Document getNewDocument(String documentTypeName)
                                                     throws org.kuali.rice.kew.api.exception.WorkflowException

Creates a new document by document type name.

Specified by:

getNewDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.getNewDocument(String)

getByDocumentHeaderId

public org.kuali.rice.krad.document.Document getByDocumentHeaderId(String documentHeaderId)
                                                            throws org.kuali.rice.kew.api.exception.WorkflowException

This is temporary until workflow 2.0 and reads from a table to get documents whose status has changed to A (approved - no outstanding approval actions requested)

Specified by:

getByDocumentHeaderId in interface org.kuali.rice.krad.service.DocumentService

Parameters:

documentHeaderId -

Returns:

Document

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

getByDocumentHeaderIdSessionless

public org.kuali.rice.krad.document.Document getByDocumentHeaderIdSessionless(String documentHeaderId)
                                                                       throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

getByDocumentHeaderIdSessionless in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.getByDocumentHeaderIdSessionless(String)

loadNotes

protected void loadNotes(org.kuali.rice.krad.document.Document document)

Loads the Notes for the note target on this Document.

Parameters:

document - the document for which to load the notes

getDocumentsByListOfDocumentHeaderIds

public List<org.kuali.rice.krad.document.Document> getDocumentsByListOfDocumentHeaderIds(Class<? extends org.kuali.rice.krad.document.Document> documentClass,
                                                                                List<String> documentHeaderIds)
                                                                                  throws org.kuali.rice.kew.api.exception.WorkflowException

The default implementation - this retrieves all documents by a list of documentHeader for a given class.

Specified by:

getDocumentsByListOfDocumentHeaderIds in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.getDocumentsByListOfDocumentHeaderIds(Class, List)

validateAndPersistDocument

public org.kuali.rice.krad.document.Document validateAndPersistDocument(org.kuali.rice.krad.document.Document document,
                                                               org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
                                                                 throws org.kuali.rice.krad.exception.ValidationException

Validates and persists a document.

Specified by:

validateAndPersistDocument in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.krad.exception.ValidationException

prepareWorkflowDocument

public void prepareWorkflowDocument(org.kuali.rice.krad.document.Document document)
                             throws org.kuali.rice.kew.api.exception.WorkflowException

Sets the title and app document id in the flex document

Specified by:

prepareWorkflowDocument in interface org.kuali.rice.krad.service.DocumentService

Parameters:

document -

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

updateDocument

public org.kuali.rice.krad.document.Document updateDocument(org.kuali.rice.krad.document.Document document)

This is to allow for updates of document statuses and other related requirements for updates outside of the initial save and route

Specified by:

updateDocument in interface org.kuali.rice.krad.service.DocumentService

createNoteFromDocument

public org.kuali.rice.krad.bo.Note createNoteFromDocument(org.kuali.rice.krad.document.Document document,
                                                 String text)

Specified by:

createNoteFromDocument in interface org.kuali.rice.krad.service.DocumentService

See Also:

DocumentService.createNoteFromDocument(Document, String)

saveDocumentNotes

public boolean saveDocumentNotes(org.kuali.rice.krad.document.Document document)

Specified by:

saveDocumentNotes in interface org.kuali.rice.krad.service.DocumentService

See Also:

DocumentService.saveDocumentNotes(Document)

sendNoteRouteNotification

public void sendNoteRouteNotification(org.kuali.rice.krad.document.Document document,
                             org.kuali.rice.krad.bo.Note note,
                             org.kuali.rice.kim.api.identity.Person sender)
                               throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

sendNoteRouteNotification in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService

isNoteTargetReady

protected boolean isNoteTargetReady(org.kuali.rice.krad.document.Document document)

Determines if the given document's note target is ready for notes to be attached and persisted against it. This method verifies that the document's note target is non-null as well as checking that it has a non-empty object id.

Parameters:

document - the document on which to check for note target readiness

Returns:

true if the note target is ready, false otherwise

sendAdHocRequests

public void sendAdHocRequests(org.kuali.rice.krad.document.Document document,
                     String annotation,
                     List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
                       throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

sendAdHocRequests in interface org.kuali.rice.krad.service.DocumentService

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

DocumentService.sendAdHocRequests(Document, String, List)

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

getDateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()

setNoteService

public void setNoteService(org.kuali.rice.krad.service.NoteService noteService)

getNoteService

protected org.kuali.rice.krad.service.NoteService getNoteService()

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

setWorkflowDocumentService

public void setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService)

getWorkflowDocumentService

protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService getWorkflowDocumentService()

setDocumentDao

public void setDocumentDao(org.kuali.rice.krad.dao.DocumentDao documentDao)

getDocumentDao

protected org.kuali.rice.krad.dao.DocumentDao getDocumentDao()

setDataDictionaryService

public void setDataDictionaryService(org.kuali.rice.krad.service.DataDictionaryService dataDictionaryService)

getDataDictionaryService

protected org.kuali.rice.krad.service.DataDictionaryService getDataDictionaryService()

setDocumentHeaderService

public void setDocumentHeaderService(org.kuali.rice.krad.service.DocumentHeaderService documentHeaderService)

getDocumentHeaderService

protected org.kuali.rice.krad.service.DocumentHeaderService getDocumentHeaderService()

getDocumentDictionaryService

protected org.kuali.rice.krad.service.DocumentDictionaryService getDocumentDictionaryService()

setDocumentDictionaryService

public void setDocumentDictionaryService(org.kuali.rice.krad.service.DocumentDictionaryService documentDictionaryService)

getPersonService

public org.kuali.rice.kim.api.identity.PersonService getPersonService()

setKualiConfigurationService

public void setKualiConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService kualiConfigurationService)