| org.kuali.core.service.DocumentService
All known Subclasses: org.kuali.core.service.impl.DocumentServiceImpl,
| DocumentService | | public interface DocumentService (Code) | | This is the DocumentService interface which must have an implementation that accompanies it. This interfaces defines all of the
generally required methods for all document instances
|
| Method Summary | |
| public Document | acknowledgeDocument(Document document, String annotation, List adHocRecipients)
acknowledge this document, optionally providing an annotation for the acknowledgement which will show up in the route log for
the document for this acknowledgement, additionally optionally provide a list of ad hoc recipients that should recieve this
document. | | public boolean | addNoteToDocument(Document document, Note note)
| | public Document | approveDocument(Document document, String annotation, List adHocRoutingRecipients)
| | public Document | blanketApproveDocument(Document document, String annotation, List adHocRecipients)
blanket approve this document which will approve the document and stand in for an approve for all typically generated
approval actions requested for this document. | | public Document | cancelDocument(Document document, String annotation)
| | public Document | clearDocumentFyi(Document document, List adHocRecipients)
| | public Note | createNoteFromDocument(Document document, String text)
| | public Document | disapproveDocument(Document document, String annotation)
| | public boolean | documentExists(String documentHeaderId)
| | public Collection | findByDocumentHeaderStatusCode(Class clazz, String statusCode)
Retrieves a collection of documents with type of given Class, and with the passed status code. | | public Document | getByDocumentHeaderId(String documentHeaderId)
| | public List | getDocumentsByListOfDocumentHeaderIds(Class clazz, List documentHeaderIds)
This method retrieves a list of fully-populated documents given a list of document header id values. | | public Collection | getFinalDocumentHeadersByDate(Date documentFinalDate)
Retrieves a collection of DocumentHeaders by the date that they were finalized. | | public Document | getNewDocument(String documentTypeName)
| | public Document | getNewDocument(Class documentClass)
| | public PersistableBusinessObject | getNoteParent(Document document, Note newNote)
| | public void | prepareWorkflowDocument(Document document)
| | public Document | routeDocument(Document document, String annotation, List adHocRoutingRecipients)
| | public Document | saveDocument(Document document)
This is a helper method that performs the same as the
DocumentService.saveDocument(Document,Class) method. | | public Document | saveDocument(Document document, Class kualiDocumentEventClass)
Saves the passed-in document. | | public Document | superUserApproveDocument(Document document, String annotation)
| | public Document | superUserCancelDocument(Document document, String annotation)
| | public Document | superUserDisapproveDocument(Document document, String annotation)
| | public void | updateDocument(Document document)
|
| acknowledgeDocument | | public Document acknowledgeDocument(Document document, String annotation, List adHocRecipients) throws WorkflowException(Code) | | acknowledge this document, optionally providing an annotation for the acknowledgement which will show up in the route log for
the document for this acknowledgement, additionally optionally provide a list of ad hoc recipients that should recieve this
document. The list of ad hoc recipients for this document should have an action requested of acknowledge or fyi as all other
actions requested will be discarded as invalid based on the action being taken being an acknowledgement.
Parameters:
document -
Parameters:
annotation -
Parameters:
adHocRecipients -
throws:
EdenException - |
| addNoteToDocument | | public boolean addNoteToDocument(Document document, Note note)(Code) | | This method adds a note to a document
Parameters:
document -
Parameters:
note - the added Note |
| approveDocument | | public Document approveDocument(Document document, String annotation, List adHocRoutingRecipients) throws WorkflowException(Code) | | approve this document, optionally providing an annotation which will show up in the route log for this document for this
action taken, and optionally providing a list of ad hoc recipients for the document
Parameters:
document -
Parameters:
annotation -
Parameters:
adHocRoutingRecipients -
throws:
EdenException -
throws:
ValidationErrorList - |
| blanketApproveDocument | | public Document blanketApproveDocument(Document document, String annotation, List adHocRecipients) throws WorkflowException(Code) | | blanket approve this document which will approve the document and stand in for an approve for all typically generated
approval actions requested for this document. The user must have blanket approval authority for this document by being
registered as a user in the blanket approval workgroup that is associated with this document type. Optionally an annotation
can be provided which will show up for this action taken on the document in the route log. Additionally optionally provide a
list of ad hoc recipients for this document, which should be restricted to actions requested of acknowledge and fyi as all
other actions requested will be discarded
Parameters:
document -
Parameters:
annotation -
Parameters:
adHocRecipients -
throws:
EdenException -
throws:
ValidationErrorList - |
| cancelDocument | | public Document cancelDocument(Document document, String annotation) throws WorkflowException(Code) | | cancel this document, optionally providing an annotation for the disapproval which will show up in the route log for the
document for this action taken
Parameters:
document -
Parameters:
annotation -
throws:
EdenException - |
| clearDocumentFyi | | public Document clearDocumentFyi(Document document, List adHocRecipients) throws WorkflowException(Code) | | clear the fyi request for this document, optionally providing a list of ad hoc recipients for this document, which should be
restricted to action requested of fyi as all other actions requested will be discarded
Parameters:
document -
Parameters:
adHocRecipients -
throws:
EdenException - |
| createNoteFromDocument | | public Note createNoteFromDocument(Document document, String text) throws Exception(Code) | | This method creates a note from a given document and note text
Parameters:
document -
Parameters:
text -
throws:
Exception - |
| disapproveDocument | | public Document disapproveDocument(Document document, String annotation) throws Exception(Code) | | disapprove this document, optionally providing an annotation for the disapproval which will show up in the route log for the
document for this action taken
Parameters:
document -
Parameters:
annotation - Document
throws:
Exception - |
| documentExists | | public boolean documentExists(String documentHeaderId)(Code) | |
Parameters:
documentHeaderId - true if a document with the given documentHeaderId exists |
| findByDocumentHeaderStatusCode | | public Collection findByDocumentHeaderStatusCode(Class clazz, String statusCode) throws WorkflowException(Code) | | Retrieves a collection of documents with type of given Class, and with the passed status code.
Parameters:
clazz -
Parameters:
statusCode - |
| getDocumentsByListOfDocumentHeaderIds | | public List getDocumentsByListOfDocumentHeaderIds(Class clazz, List documentHeaderIds) throws WorkflowException(Code) | | This method retrieves a list of fully-populated documents given a list of document header id values.
Parameters:
clazz -
Parameters:
documentHeaderIds - List of fully-populated documents
throws:
WorkflowException - |
| getFinalDocumentHeadersByDate | | public Collection getFinalDocumentHeadersByDate(Date documentFinalDate) throws WorkflowException(Code) | | Retrieves a collection of DocumentHeaders by the date that they were finalized.
Parameters:
documentFinalDate - Collection of DocumentHeaders
throws:
WorkflowException - |
| getNoteParent | | public PersistableBusinessObject getNoteParent(Document document, Note newNote)(Code) | | This method gets the parent for a note from a document
Parameters:
document -
Parameters:
newNote - Business Object that the note is attached to. |
| routeDocument | | public Document routeDocument(Document document, String annotation, List adHocRoutingRecipients) throws WorkflowException(Code) | | start the route the document for approval, optionally providing a list of ad hoc recipients, and additionally provideing a
annotation to show up in the route log for the document
Parameters:
document -
Parameters:
annotation -
Parameters:
adHocRoutingRecipients -
throws:
EdenException -
throws:
ValidationErrorList - |
| saveDocument | | public Document saveDocument(Document document, Class kualiDocumentEventClass) throws WorkflowException(Code) | | Saves the passed-in document. This will persist it both to the Kuali database, and also initiate it (if necessary) within
workflow, so its available in the initiator's action list. This method uses the passed in KualiDocumentEvent class when saving
the document. The KualiDocumentEvent class must implement the
SaveEvent interface.
Note that the system does not support passing in Workflow Annotations or AdHoc Route Recipients on a SaveDocument call. These
are sent to workflow on a routeDocument action, or any of the others which actually causes a routing action to happen in
workflow.
NOTE: This method will not check the document action flags to check if a save is valid
Parameters:
document - The document to be saved
Parameters:
kualiDocumentEventClass - The event class to use when saving (class must implement the SaveEvent interface) the document that was passed in
throws:
WorkflowException - |
| superUserApproveDocument | | public Document superUserApproveDocument(Document document, String annotation) throws WorkflowException(Code) | | approve this document as super user, optionally providing an annotation which will show up in the route log for this document
for this action taken
Parameters:
document -
Parameters:
annotation -
throws:
EdenException -
throws:
ValidationErrorList - |
| superUserCancelDocument | | public Document superUserCancelDocument(Document document, String annotation) throws WorkflowException(Code) | | cancel this document as super user, optionally providing an annotation which will show up in the route log for this document
for this action taken
Parameters:
document -
Parameters:
annotation -
throws:
WorkflowException - |
| superUserDisapproveDocument | | public Document superUserDisapproveDocument(Document document, String annotation) throws WorkflowException(Code) | | disapprove this document as super user, optionally providing an annotation which will show up in the route log for this document
for this action taken
Parameters:
document -
Parameters:
annotation -
throws:
WorkflowException - |
| updateDocument | | public void updateDocument(Document document)(Code) | | This method is to allow for documents to be updated which is currently used to update the document status as well as to allow
for locked docs to be unlocked
Parameters:
document - |
|
|