Package org.kuali.rice.krad.service.impl

Class DocumentServiceImpl

java.lang.Object

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

All Implemented Interfaces:

DocumentService

public class DocumentServiceImpl
extends Object
implements DocumentService

Service implementation for the Document structure. It contains all of the document level type of processing and calling back into documents for various centralization of functionality. This is the default, Kuali delivered implementation which utilizes Workflow.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

Fields

Modifier and Type	Field	Description
protected DataDictionaryService	dataDictionaryService
protected org.kuali.rice.core.api.datetime.DateTimeService	dateTimeService
protected DocumentAdHocService	documentAdHocService
protected DocumentDictionaryService	documentDictionaryService
protected DocumentHeaderService	documentHeaderService
protected org.kuali.rice.core.api.config.property.ConfigurationService	kualiConfigurationService
protected LegacyDataAdapter	legacyDataAdapter
protected NoteService	noteService
protected org.kuali.rice.kim.api.identity.PersonService	personService
protected WorkflowDocumentService	workflowDocumentService

Constructor Summary

Constructors

Constructor	Description
DocumentServiceImpl()

Method Summary

Modifier and Type	Method	Description
Document	acknowledgeDocument(Document document, String annotation, String adHocRouteNodeName, List<AdHocRouteRecipient> adHocRecipients)
Document	acknowledgeDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients)
Document	approveDocument(Document document, String annotation, String adHocRouteNodeName, List<AdHocRouteRecipient> adHocRecipients)
Document	approveDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients)
Document	blanketApproveDocument(Document document, String annotation, String adHocRouteNodeName, List<AdHocRouteRecipient> adHocRecipients)
Document	blanketApproveDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients)
Document	cancelDocument(Document document, String annotation)
protected void	checkForNulls(Document document)
Document	clearDocumentFyi(Document document, String adHocRouteNodeName, List<AdHocRouteRecipient> adHocRecipients)
Document	clearDocumentFyi(Document document, List<AdHocRouteRecipient> adHocRecipients)
Document	completeDocument(Document document, String annotation, String adHocRouteNodeName, List<AdHocRouteRecipient> adHocRecipients)
Document	completeDocument(Document document, String annotation, List adHocRecipients)
Note	createNoteFromDocument(Document document, String text)
Document	disapproveDocument(Document document, String annotation)
boolean	documentExists(String documentHeaderId)
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)
Document	getByDocumentHeaderIdSessionless(String documentHeaderId)
protected DataDictionaryService	getDataDictionaryService()
protected org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService()
protected DocumentDictionaryService	getDocumentDictionaryService()
DocumentHeaderService	getDocumentHeaderService()
List<Document>	getDocumentsByListOfDocumentHeaderIds(Class<? extends Document> documentClass, List<String> documentHeaderIds)	The default implementation - this retrieves all documents by a list of documentHeader for a given class.
protected LegacyDataAdapter	getLegacyDataAdapter()
Document	getNewDocument(Class<? extends Document> documentClass)	Creates a new document by class.
Document	getNewDocument(String documentTypeName)	Creates a new document by document type name.
Document	getNewDocument(String documentTypeName, String initiatorPrincipalNm)	Creates a new document by document type name.
protected NoteService	getNoteService()
org.kuali.rice.kim.api.identity.PersonService	getPersonService()
protected WorkflowDocumentService	getWorkflowDocumentService()
protected boolean	isNoteTargetReady(Document document)	Determines if the given document's note target is ready for notes to be attached and persisted against it.
protected void	loadNotes(Document document)	Loads the Notes for the note target on this Document.
void	prepareWorkflowDocument(Document document)	Sets the title and app document id in the flex document
Document	recallDocument(Document document, String annotation, boolean cancel)
Document	routeDocument(Document document, String annotation, String adHocRouteNodeName, List<AdHocRouteRecipient> adHocRecipients)
Document	routeDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients)
Document	saveDocument(Document document)
Document	saveDocument(Document document, Class<? extends DocumentEvent> kualiDocumentEventClass)
Document	saveDocument(Document document, DocumentEvent event)	saves the document with the custom document event passed in
boolean	saveDocumentNotes(Document document)
Document	sendAdHocRequests(Document document, String annotation, String adHocRouteNodeName, List<AdHocRouteRecipient> adHocRecipients)
Document	sendAdHocRequests(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients)
Document	sendNoteRouteNotification(Document document, Note note, org.kuali.rice.kim.api.identity.Person sender)
void	setDataDictionaryService(DataDictionaryService dataDictionaryService)
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)
void	setDocumentAdHocService(DocumentAdHocService documentAdHocService)
void	setDocumentDictionaryService(DocumentDictionaryService documentDictionaryService)
void	setDocumentHeaderService(DocumentHeaderService documentHeaderService)
void	setKualiConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService kualiConfigurationService)
void	setLegacyDataAdapter(LegacyDataAdapter legacyDataAdapter)
void	setNoteService(NoteService noteService)
void	setWorkflowDocumentService(WorkflowDocumentService workflowDocumentService)
Document	superUserApproveDocument(Document document, String annotation)
Document	superUserCancelDocument(Document document, String annotation)
Document	superUserDisapproveDocument(Document document, String annotation)
Document	superUserDisapproveDocumentWithoutSaving(Document document, String annotation)
Document	updateDocument(Document document)	This is to allow for updates of document statuses and other related requirements for updates outside of the initial save and route
Document	validateAndPersistDocument(Document document, DocumentEvent event)	Validates and persists a document.

Methods inherited from class java.lang.Object

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

Field Details

dateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService dateTimeService

noteService

protected NoteService noteService

workflowDocumentService

protected WorkflowDocumentService workflowDocumentService

legacyDataAdapter

protected LegacyDataAdapter legacyDataAdapter

dataDictionaryService

protected DataDictionaryService dataDictionaryService

documentDictionaryService

protected DocumentDictionaryService documentDictionaryService

personService

protected org.kuali.rice.kim.api.identity.PersonService personService

kualiConfigurationService

protected org.kuali.rice.core.api.config.property.ConfigurationService kualiConfigurationService

documentHeaderService

protected DocumentHeaderService documentHeaderService

documentAdHocService

protected DocumentAdHocService documentAdHocService

Constructor Details

DocumentServiceImpl

public DocumentServiceImpl()

Method Details

saveDocument

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

Specified by:

saveDocument in interface DocumentService

Throws:

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

ValidationException

See Also:

• DocumentService.saveDocument(org.kuali.rice.krad.document.Document)

saveDocument

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

saves the document with the custom document event passed in

Specified by:

saveDocument in interface DocumentService

Throws:

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

saveDocument

public Document saveDocument(Document document,
 Class<? extends DocumentEvent> kualiDocumentEventClass)
                      throws org.kuali.rice.kew.api.exception.WorkflowException,
ValidationException

Specified by:

saveDocument in interface DocumentService

Throws:

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

ValidationException

routeDocument

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

Specified by:

routeDocument in interface DocumentService

Throws:

ValidationException

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

See Also:

• DocumentService.routeDocument(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

routeDocument

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

Specified by:

routeDocument in interface DocumentService

Throws:

ValidationException

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

See Also:

• DocumentService.routeDocument(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

approveDocument

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

Specified by:

approveDocument in interface DocumentService

Throws:

ValidationException

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

See Also:

• DocumentService.approveDocument(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

approveDocument

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

Specified by:

approveDocument in interface DocumentService

Throws:

ValidationException

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

See Also:

• DocumentService.approveDocument(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

superUserApproveDocument

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

Specified by:

superUserApproveDocument in interface DocumentService

Throws:

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

See Also:

• DocumentService.superUserApproveDocument(org.kuali.rice.krad.document.Document, java.lang.String)

superUserCancelDocument

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

Specified by:

superUserCancelDocument in interface DocumentService

Throws:

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

See Also:

• DocumentService.superUserCancelDocument(org.kuali.rice.krad.document.Document, java.lang.String)

superUserDisapproveDocument

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

Specified by:

superUserDisapproveDocument in interface DocumentService

Throws:

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

See Also:

• DocumentService.superUserCancelDocument(org.kuali.rice.krad.document.Document, java.lang.String)

superUserDisapproveDocumentWithoutSaving

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

Specified by:

superUserDisapproveDocumentWithoutSaving in interface DocumentService

Throws:

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

See Also:

• DocumentService.superUserCancelDocument(org.kuali.rice.krad.document.Document, java.lang.String)

disapproveDocument

public Document disapproveDocument(Document document,
 String annotation)
                            throws Exception

Specified by:

disapproveDocument in interface DocumentService

Throws:

Exception

See Also:

• DocumentService.disapproveDocument(org.kuali.rice.krad.document.Document, java.lang.String)

cancelDocument

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

Specified by:

cancelDocument in interface DocumentService

Throws:

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

See Also:

• DocumentService.cancelDocument(org.kuali.rice.krad.document.Document, java.lang.String)

recallDocument

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

Specified by:

recallDocument in interface DocumentService

Throws:

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

acknowledgeDocument

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

Specified by:

acknowledgeDocument in interface DocumentService

Throws:

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

See Also:

• DocumentService.acknowledgeDocument(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

acknowledgeDocument

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

Specified by:

acknowledgeDocument in interface DocumentService

Throws:

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

blanketApproveDocument

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

Specified by:

blanketApproveDocument in interface DocumentService

Throws:

ValidationException

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

See Also:

• DocumentService.blanketApproveDocument(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

blanketApproveDocument

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

Specified by:

blanketApproveDocument in interface DocumentService

Throws:

ValidationException

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

See Also:

• DocumentService.blanketApproveDocument(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

clearDocumentFyi

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

Specified by:

clearDocumentFyi in interface DocumentService

Throws:

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

See Also:

• DocumentService.clearDocumentFyi(org.kuali.rice.krad.document.Document, java.util.List)

clearDocumentFyi

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

Specified by:

clearDocumentFyi in interface DocumentService

Throws:

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

completeDocument

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

Specified by:

completeDocument in interface DocumentService

Throws:

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

completeDocument

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

Specified by:

completeDocument in interface DocumentService

Throws:

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

See Also:

• DocumentService.completeDocument(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

checkForNulls

protected void checkForNulls(Document document)

documentExists

public boolean documentExists(String documentHeaderId)

Specified by:

documentExists in interface DocumentService

See Also:

• DocumentService.documentExists(java.lang.String)

getNewDocument

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

Creates a new document by class.

Specified by:

getNewDocument in interface DocumentService

Throws:

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

See Also:

• DocumentService.getNewDocument(java.lang.Class)

getNewDocument

public 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 DocumentService

Throws:

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

See Also:

• DocumentService.getNewDocument(String, String)

getNewDocument

public 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 DocumentService

Throws:

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

See Also:

• DocumentService.getNewDocument(java.lang.String)

getByDocumentHeaderId

public 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 DocumentService

Parameters:

documentHeaderId -

Returns:

Document

Throws:

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

getByDocumentHeaderIdSessionless

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

Specified by:

getByDocumentHeaderIdSessionless in interface DocumentService

Throws:

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

See Also:

• DocumentService.getByDocumentHeaderIdSessionless(java.lang.String)

loadNotes

protected void loadNotes(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<Document> getDocumentsByListOfDocumentHeaderIds(Class<? extends 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 DocumentService

Throws:

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

See Also:

• DocumentService.getDocumentsByListOfDocumentHeaderIds(java.lang.Class, java.util.List)

validateAndPersistDocument

public Document validateAndPersistDocument(Document document,
 DocumentEvent event)
                                    throws ValidationException

Validates and persists a document.

Specified by:

validateAndPersistDocument in interface DocumentService

Throws:

ValidationException

prepareWorkflowDocument

public void prepareWorkflowDocument(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 DocumentService

Parameters:

document -

Throws:

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

updateDocument

public Document updateDocument(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 DocumentService

createNoteFromDocument

public Note createNoteFromDocument(Document document,
 String text)

Specified by:

createNoteFromDocument in interface DocumentService

See Also:

• DocumentService.createNoteFromDocument(org.kuali.rice.krad.document.Document, java.lang.String)

saveDocumentNotes

public boolean saveDocumentNotes(Document document)

Specified by:

saveDocumentNotes in interface DocumentService

See Also:

• DocumentService.saveDocumentNotes(org.kuali.rice.krad.document.Document)

sendNoteRouteNotification

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

Specified by:

sendNoteRouteNotification in interface DocumentService

Throws:

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

See Also:

• DocumentService

isNoteTargetReady

protected boolean isNoteTargetReady(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 Document sendAdHocRequests(Document document,
 String annotation,
 List<AdHocRouteRecipient> adHocRecipients)
                           throws org.kuali.rice.kew.api.exception.WorkflowException

Specified by:

sendAdHocRequests in interface DocumentService

Throws:

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

See Also:

• DocumentService.sendAdHocRequests(org.kuali.rice.krad.document.Document, String, java.util.List)

sendAdHocRequests

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

Specified by:

sendAdHocRequests in interface DocumentService

Throws:

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

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(NoteService noteService)

getNoteService

protected NoteService getNoteService()

setLegacyDataAdapter

public void setLegacyDataAdapter(LegacyDataAdapter legacyDataAdapter)

getLegacyDataAdapter

protected LegacyDataAdapter getLegacyDataAdapter()

setWorkflowDocumentService

public void setWorkflowDocumentService(WorkflowDocumentService workflowDocumentService)

getWorkflowDocumentService

protected WorkflowDocumentService getWorkflowDocumentService()

setDataDictionaryService

public void setDataDictionaryService(DataDictionaryService dataDictionaryService)

getDataDictionaryService

protected DataDictionaryService getDataDictionaryService()

getDocumentDictionaryService

protected DocumentDictionaryService getDocumentDictionaryService()

setDocumentDictionaryService

public void setDocumentDictionaryService(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)

getDocumentHeaderService

public DocumentHeaderService getDocumentHeaderService()

setDocumentHeaderService

public void setDocumentHeaderService(DocumentHeaderService documentHeaderService)

setDocumentAdHocService

public void setDocumentAdHocService(DocumentAdHocService documentAdHocService)