Package 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
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 org.kuali.rice.krad.service.DataDictionaryService
    dataDictionaryService
     
    protected org.kuali.rice.core.api.datetime.DateTimeService
    dateTimeService
     
    protected org.kuali.rice.krad.service.DocumentAdHocService
    documentAdHocService
     
    protected org.kuali.rice.krad.service.DocumentDictionaryService
    documentDictionaryService
     
    protected org.kuali.rice.krad.service.DocumentHeaderService
    documentHeaderService
     
    protected org.kuali.rice.core.api.config.property.ConfigurationService
    kualiConfigurationService
     
    protected org.kuali.rice.krad.service.LegacyDataAdapter
    legacyDataAdapter
     
    protected org.kuali.rice.krad.service.NoteService
    noteService
     
    protected org.kuali.rice.kim.api.identity.PersonService
    personService
     
    protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService
    workflowDocumentService
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentServiceImpl()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.kuali.rice.krad.document.Document
    acknowledgeDocument(org.kuali.rice.krad.document.Document document, String annotation, String adHocRouteNodeName, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
     
    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, String adHocRouteNodeName, 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, String adHocRouteNodeName, 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, String adHocRouteNodeName, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
     
    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, String adHocRouteNodeName, 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)
     
    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.service.DocumentDictionaryService
    getDocumentDictionaryService()
     
    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.
    protected org.kuali.rice.krad.service.LegacyDataAdapter
    getLegacyDataAdapter()
     
    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, String adHocRouteNodeName, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
     
    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.DocumentEvent> kualiDocumentEventClass)
     
    org.kuali.rice.krad.document.Document
    saveDocument(org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.rules.rule.event.DocumentEvent event)
    saves the document with the custom document event passed in
    boolean
    saveDocumentNotes(org.kuali.rice.krad.document.Document document)
     
    org.kuali.rice.krad.document.Document
    sendAdHocRequests(org.kuali.rice.krad.document.Document document, String annotation, String adHocRouteNodeName, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
     
    org.kuali.rice.krad.document.Document
    sendAdHocRequests(org.kuali.rice.krad.document.Document document, String annotation, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> adHocRecipients)
     
    org.kuali.rice.krad.document.Document
    sendNoteRouteNotification(org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.bo.Note note, org.kuali.rice.kim.api.identity.Person sender)
     
    void
    setDataDictionaryService(org.kuali.rice.krad.service.DataDictionaryService dataDictionaryService)
     
    void
    setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)
     
    void
    setDocumentAdHocService(org.kuali.rice.krad.service.DocumentAdHocService documentAdHocService)
     
    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
    setLegacyDataAdapter(org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter)
     
    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.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 org.kuali.rice.krad.service.NoteService noteService

    • workflowDocumentService

      protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService

    • legacyDataAdapter

      protected org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter

    • dataDictionaryService

      protected org.kuali.rice.krad.service.DataDictionaryService dataDictionaryService

    • documentDictionaryService

      protected org.kuali.rice.krad.service.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 org.kuali.rice.krad.service.DocumentHeaderService documentHeaderService

    • documentAdHocService

      protected org.kuali.rice.krad.service.DocumentAdHocService documentAdHocService

  • Constructor Details

    • DocumentServiceImpl

      public DocumentServiceImpl()

  • Method Details

    • 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(org.kuali.rice.krad.document.Document)

    • saveDocument

      public org.kuali.rice.krad.document.Document saveDocument(org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.rules.rule.event.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 org.kuali.rice.krad.service.DocumentService
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • 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.DocumentEvent> 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(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

    • routeDocument

      public org.kuali.rice.krad.document.Document routeDocument(org.kuali.rice.krad.document.Document document, String annotation, String adHocRouteNodeName, 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(org.kuali.rice.krad.document.Document, java.lang.String, java.util.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(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

    • approveDocument

      public org.kuali.rice.krad.document.Document approveDocument(org.kuali.rice.krad.document.Document document, String annotation, String adHocRouteNodeName, 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(org.kuali.rice.krad.document.Document, java.lang.String, java.util.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(org.kuali.rice.krad.document.Document, java.lang.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(org.kuali.rice.krad.document.Document, java.lang.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(org.kuali.rice.krad.document.Document, java.lang.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(org.kuali.rice.krad.document.Document, java.lang.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(org.kuali.rice.krad.document.Document, java.lang.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(org.kuali.rice.krad.document.Document, java.lang.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(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

    • acknowledgeDocument

      public org.kuali.rice.krad.document.Document acknowledgeDocument(org.kuali.rice.krad.document.Document document, String annotation, String adHocRouteNodeName, 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

    • 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(org.kuali.rice.krad.document.Document, java.lang.String, java.util.List)

    • blanketApproveDocument

      public org.kuali.rice.krad.document.Document blanketApproveDocument(org.kuali.rice.krad.document.Document document, String annotation, String adHocRouteNodeName, 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(org.kuali.rice.krad.document.Document, java.lang.String, java.util.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(org.kuali.rice.krad.document.Document, java.util.List)

    • clearDocumentFyi

      public org.kuali.rice.krad.document.Document clearDocumentFyi(org.kuali.rice.krad.document.Document document, String adHocRouteNodeName, 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

    • completeDocument

      public org.kuali.rice.krad.document.Document completeDocument(org.kuali.rice.krad.document.Document document, String annotation, String adHocRouteNodeName, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> 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

    • 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(org.kuali.rice.krad.document.Document, java.lang.String, java.util.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.Class, java.util.List)

    • validateAndPersistDocument

      public org.kuali.rice.krad.document.Document validateAndPersistDocument(org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.rules.rule.event.DocumentEvent 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(org.kuali.rice.krad.document.Document, java.lang.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(org.kuali.rice.krad.document.Document)

    • sendNoteRouteNotification

      public org.kuali.rice.krad.document.Document 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 org.kuali.rice.krad.document.Document 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(org.kuali.rice.krad.document.Document, String, java.util.List)

    • sendAdHocRequests

      public org.kuali.rice.krad.document.Document sendAdHocRequests(org.kuali.rice.krad.document.Document document, String annotation, String adHocRouteNodeName, 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

    • 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()

    • setLegacyDataAdapter

      public void setLegacyDataAdapter(org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter)

    • getLegacyDataAdapter

      protected org.kuali.rice.krad.service.LegacyDataAdapter getLegacyDataAdapter()

    • setWorkflowDocumentService

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

    • getWorkflowDocumentService

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

    • setDataDictionaryService

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

    • getDataDictionaryService

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

    • 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)

    • getDocumentHeaderService

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

    • setDocumentHeaderService

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

    • setDocumentAdHocService

      public void setDocumentAdHocService(org.kuali.rice.krad.service.DocumentAdHocService documentAdHocService)