public class DocumentServiceImpl extends Object implements org.kuali.rice.krad.service.DocumentService
Constructor and Description |
---|
DocumentServiceImpl() |
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) |
AlertServiceImpl |
getAlertService() |
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
|
void |
processGlobalAlerts(org.kuali.rice.krad.document.Document 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.
|
public DocumentServiceImpl()
public AlertServiceImpl getAlertService()
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
saveDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
org.kuali.rice.krad.exception.ValidationException
DocumentService.saveDocument(org.kuali.rice.krad.document.Document)
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
saveDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
org.kuali.rice.krad.exception.ValidationException
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
routeDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.krad.exception.ValidationException
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.routeDocument(org.kuali.rice.krad.document.Document,
String, java.util.List)
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
approveDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.krad.exception.ValidationException
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.approveDocument(org.kuali.rice.krad.document.Document,
String,
java.util.List)
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
superUserApproveDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.superUserApproveDocument(org.kuali.rice.krad.document.Document,
String)
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
superUserCancelDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.superUserCancelDocument(org.kuali.rice.krad.document.Document,
String)
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
superUserDisapproveDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.superUserCancelDocument(org.kuali.rice.krad.document.Document,
String)
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
superUserDisapproveDocumentWithoutSaving
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.superUserCancelDocument(org.kuali.rice.krad.document.Document,
String)
public org.kuali.rice.krad.document.Document disapproveDocument(org.kuali.rice.krad.document.Document document, String annotation) throws Exception
disapproveDocument
in interface org.kuali.rice.krad.service.DocumentService
Exception
DocumentService.disapproveDocument(org.kuali.rice.krad.document.Document,
String)
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
cancelDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.cancelDocument(org.kuali.rice.krad.document.Document,
String)
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
recallDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
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
acknowledgeDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.acknowledgeDocument(org.kuali.rice.krad.document.Document,
String,
java.util.List)
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
blanketApproveDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.krad.exception.ValidationException
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.blanketApproveDocument(org.kuali.rice.krad.document.Document,
String,
java.util.List)
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
clearDocumentFyi
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.clearDocumentFyi(org.kuali.rice.krad.document.Document,
java.util.List)
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
completeDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.completeDocument(org.kuali.rice.krad.document.Document,
String,
java.util.List)
protected void checkForNulls(org.kuali.rice.krad.document.Document document)
public boolean documentExists(String documentHeaderId)
documentExists
in interface org.kuali.rice.krad.service.DocumentService
DocumentService.documentExists(String)
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
getNewDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.getNewDocument(Class)
public org.kuali.rice.krad.document.Document getNewDocument(String documentTypeName, String initiatorPrincipalNm) throws org.kuali.rice.kew.api.exception.WorkflowException
getNewDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.getNewDocument(String, String)
public org.kuali.rice.krad.document.Document getNewDocument(String documentTypeName) throws org.kuali.rice.kew.api.exception.WorkflowException
getNewDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.getNewDocument(String)
public org.kuali.rice.krad.document.Document getByDocumentHeaderId(String documentHeaderId) throws org.kuali.rice.kew.api.exception.WorkflowException
getByDocumentHeaderId
in interface org.kuali.rice.krad.service.DocumentService
documentHeaderId
- org.kuali.rice.kew.api.exception.WorkflowException
public org.kuali.rice.krad.document.Document getByDocumentHeaderIdSessionless(String documentHeaderId) throws org.kuali.rice.kew.api.exception.WorkflowException
getByDocumentHeaderIdSessionless
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.getByDocumentHeaderIdSessionless(String)
protected void loadNotes(org.kuali.rice.krad.document.Document document)
document
- the document for which to load the notespublic 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
getDocumentsByListOfDocumentHeaderIds
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.getDocumentsByListOfDocumentHeaderIds(Class,
java.util.List)
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
validateAndPersistDocument
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.krad.exception.ValidationException
public void prepareWorkflowDocument(org.kuali.rice.krad.document.Document document) throws org.kuali.rice.kew.api.exception.WorkflowException
prepareWorkflowDocument
in interface org.kuali.rice.krad.service.DocumentService
document
- org.kuali.rice.kew.api.exception.WorkflowException
public org.kuali.rice.krad.document.Document updateDocument(org.kuali.rice.krad.document.Document document)
updateDocument
in interface org.kuali.rice.krad.service.DocumentService
public org.kuali.rice.krad.bo.Note createNoteFromDocument(org.kuali.rice.krad.document.Document document, String text)
createNoteFromDocument
in interface org.kuali.rice.krad.service.DocumentService
DocumentService.createNoteFromDocument(org.kuali.rice.krad.document.Document,
String)
public boolean saveDocumentNotes(org.kuali.rice.krad.document.Document document)
saveDocumentNotes
in interface org.kuali.rice.krad.service.DocumentService
DocumentService.saveDocumentNotes(org.kuali.rice.krad.document.Document)
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
sendNoteRouteNotification
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService
protected boolean isNoteTargetReady(org.kuali.rice.krad.document.Document document)
document
- the document on which to check for note target readinesspublic 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
sendAdHocRequests
in interface org.kuali.rice.krad.service.DocumentService
org.kuali.rice.kew.api.exception.WorkflowException
DocumentService.sendAdHocRequests(org.kuali.rice.krad.document.Document, String, java.util.List)
public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)
protected org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()
public void setNoteService(org.kuali.rice.krad.service.NoteService noteService)
protected org.kuali.rice.krad.service.NoteService getNoteService()
public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()
public void setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService)
protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService getWorkflowDocumentService()
public void setDocumentDao(org.kuali.rice.krad.dao.DocumentDao documentDao)
protected org.kuali.rice.krad.dao.DocumentDao getDocumentDao()
public void setDataDictionaryService(org.kuali.rice.krad.service.DataDictionaryService dataDictionaryService)
protected org.kuali.rice.krad.service.DataDictionaryService getDataDictionaryService()
public void setDocumentHeaderService(org.kuali.rice.krad.service.DocumentHeaderService documentHeaderService)
protected org.kuali.rice.krad.service.DocumentHeaderService getDocumentHeaderService()
protected org.kuali.rice.krad.service.DocumentDictionaryService getDocumentDictionaryService()
public void setDocumentDictionaryService(org.kuali.rice.krad.service.DocumentDictionaryService documentDictionaryService)
public org.kuali.rice.kim.api.identity.PersonService getPersonService()
public void setKualiConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService kualiConfigurationService)
public void processGlobalAlerts(org.kuali.rice.krad.document.Document document)
Copyright © 2004–2015 The Kuali Foundation. All rights reserved.