Java Doc for DocumentBase.java in  » ERP-CRM-Financial » Kuali-Financial-System » org » kuali » core » document » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » Kuali Financial System » org.kuali.core.document 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.kuali.core.bo.PersistableBusinessObjectBase
   org.kuali.core.document.DocumentBase

All known Subclasses:   org.kuali.module.purap.document.WorkflowXmlPurchaseOrderDocument,  org.kuali.module.purap.document.WorkflowXmlCreditMemoDocument,  org.kuali.core.service.mock.MockDocument,  org.kuali.core.document.TransactionalDocumentBase,  org.kuali.module.purap.document.WorkflowXmlPaymentRequestDocument,  org.kuali.module.purap.document.WorkflowXmlRequisitionDocument,  org.kuali.core.document.MaintenanceDocumentBase,
DocumentBase
abstract public class DocumentBase extends PersistableBusinessObjectBase implements Document(Code)

See Also:   Document


Field Summary
protected transient  PersistableBusinessObjectdocumentBusinessObject
    
protected  DocumentHeaderdocumentHeader
    
protected  StringdocumentNumber
    

Constructor Summary
public  DocumentBase()
     Constructs a DocumentBase.java.

Method Summary
protected  voidaddCopyErrorDocumentNote(String noteText)
     Adds a note to the document indicating it was created by a copy or error correction.
public  voiddoActionTaken(ActionTakenEventVO event)
    
public  voiddoRouteStatusChange(DocumentRouteStatusChangeVO statusChangeEvent)
    
public  ListgenerateSaveEvents()
    
public  ListgetAdHocRoutePersons()
    
public  ListgetAdHocRouteWorkgroups()
    
public  booleangetAllowsCopy()
    
public  PersistableBusinessObjectgetDocumentBusinessObject()
     Gets the documentBusinessObject attribute.
public  DocumentHeadergetDocumentHeader()
    
public  StringgetDocumentNumber()
    
protected  DocumentgetDocumentRepresentationForSerialization()
     This method was added because of performance problems with the default workflow xml serialization strategy.
public  StringgetDocumentTitle()
     This is the default document title implementation.
public  StringgetXmlForRouteReport()
    
public  voidhandleRouteLevelChange(DocumentRouteLevelChangeVO levelChangeEvent)
     The the default implementation for RouteLevelChange does nothing, but is meant to provide a hook for documents to implement for other needs.
public  voidhandleRouteStatusChange()
     This is the default implementation which checks for a different workflow statuses, and updates the Kuali status accordingly.
protected  voidlogErrors()
     This method logs errors.
public  voidpopulateDocumentForRouting()
    
public  voidpostProcessSave(KualiDocumentEvent event)
    
public  voidprepareForSave()
     If the document has a total amount, call method on document to get the total and set in doc header.
public  voidprepareForSave(KualiDocumentEvent event)
    
public  voidprocessAfterRetrieve()
     This is the default implementation which ensures that document note attachment references are loaded.
public  voidrefresh()
     Uses the persistence service's implementation of OJB's retrieveNonKey() fields method.
public  voidrefreshIfEmpty()
     Checks to see if the objectId value is empty.
public  voidrefreshReferenceObject(String referenceObjectName)
     Uses the persistence service to retrieve a reference object of a parent.
public  StringserializeDocumentToXml()
    
public  voidsetAdHocRoutePersons(List adHocRoutePersons)
    
public  voidsetAdHocRouteWorkgroups(List adHocRouteWorkgroups)
    
public  voidsetDocumentHeader(DocumentHeader documentHeader)
    
public  voidsetDocumentNumber(String documentNumber)
    
protected  voidsetNewDocumentHeader()
     Gets a new document header for this documents type and sets in the document instance.
public  voidtoCopy()
    
final public  StringtoString()
    
protected  StringtoStringBuilder(LinkedHashMap fieldValues)
    
protected  LinkedHashMaptoStringMapper()
    
public  voidvalidateBusinessRules(KualiDocumentEvent event)
    

Field Detail
documentBusinessObject
protected transient PersistableBusinessObject documentBusinessObject(Code)



documentHeader
protected DocumentHeader documentHeader(Code)



documentNumber
protected String documentNumber(Code)




Constructor Detail
DocumentBase
public DocumentBase()(Code)
Constructs a DocumentBase.java.




Method Detail
addCopyErrorDocumentNote
protected void addCopyErrorDocumentNote(String noteText)(Code)
Adds a note to the document indicating it was created by a copy or error correction.
Parameters:
  noteText - - text for note



doActionTaken
public void doActionTaken(ActionTakenEventVO event)(Code)

See Also:   org.kuali.core.document.Document.doActionTaken(edu.iu.uis.eden.clientapp.vo.ActionTakenEventVO)



doRouteStatusChange
public void doRouteStatusChange(DocumentRouteStatusChangeVO statusChangeEvent) throws Exception(Code)



generateSaveEvents
public List generateSaveEvents()(Code)
Hook for override
See Also:   org.kuali.core.document.Document.generateSaveEvents



getAdHocRoutePersons
public List getAdHocRoutePersons()(Code)

See Also:   org.kuali.core.document.Document.getAdHocRoutePersons



getAdHocRouteWorkgroups
public List getAdHocRouteWorkgroups()(Code)

See Also:   org.kuali.core.document.Document.getAdHocRouteWorkgroups



getAllowsCopy
public boolean getAllowsCopy()(Code)

See Also:   org.kuali.core.document.Document.getAllowsCopy



getDocumentBusinessObject
public PersistableBusinessObject getDocumentBusinessObject()(Code)
Gets the documentBusinessObject attribute. Returns the documentBusinessObject.



getDocumentHeader
public DocumentHeader getDocumentHeader()(Code)

See Also:   org.kuali.core.document.Document.getDocumentHeader



getDocumentNumber
public String getDocumentNumber()(Code)

See Also:   org.kuali.core.document.Document.getDocumentNumber



getDocumentRepresentationForSerialization
protected Document getDocumentRepresentationForSerialization()(Code)
This method was added because of performance problems with the default workflow xml serialization strategy. This allows individual "big" document implementations to defer to a service that can be overriden for translation of the real document into a much smaller object structure for serialization. the Document instance that should be used to generate the xml for workfow



getDocumentTitle
public String getDocumentTitle()(Code)
This is the default document title implementation. It concatenates the document's data dictionary file label attribute and the document's document header description together. This title is used to populate workflow and will show up in document search results and user action lists.
See Also:   org.kuali.core.document.Document.getDocumentTitle



getXmlForRouteReport
public String getXmlForRouteReport()(Code)

See Also:   org.kuali.core.document.Document.getXmlForRouteReport



handleRouteLevelChange
public void handleRouteLevelChange(DocumentRouteLevelChangeVO levelChangeEvent)(Code)
The the default implementation for RouteLevelChange does nothing, but is meant to provide a hook for documents to implement for other needs.
See Also:   org.kuali.core.document.Document.handleRouteLevelChange(edu.iu.uis.eden.clientapp.vo.DocumentRouteLevelChangeVO)



handleRouteStatusChange
public void handleRouteStatusChange()(Code)
This is the default implementation which checks for a different workflow statuses, and updates the Kuali status accordingly.
See Also:   org.kuali.core.document.Document.handleRouteStatusChange



logErrors
protected void logErrors()(Code)
This method logs errors.



populateDocumentForRouting
public void populateDocumentForRouting()(Code)

See Also:   org.kuali.core.document.Document.populateDocumentForRouting



postProcessSave
public void postProcessSave(KualiDocumentEvent event)(Code)



prepareForSave
public void prepareForSave()(Code)
If the document has a total amount, call method on document to get the total and set in doc header.
See Also:   org.kuali.core.document.Document.prepareForSave



prepareForSave
public void prepareForSave(KualiDocumentEvent event)(Code)
Override this method with implementation specific prepareForSave logic
See Also:   org.kuali.core.document.Document.prepareForSave(org.kuali.core.rule.event.KualiDocumentEvent)



processAfterRetrieve
public void processAfterRetrieve()(Code)
This is the default implementation which ensures that document note attachment references are loaded.
See Also:   org.kuali.core.document.Document.processAfterRetrieve



refresh
public void refresh()(Code)
Uses the persistence service's implementation of OJB's retrieveNonKey() fields method.
See Also:   org.kuali.core.bo.BusinessObject.refresh



refreshIfEmpty
public void refreshIfEmpty()(Code)
Checks to see if the objectId value is empty. If so, it will try to refresh the object from the DB.
See Also:   org.kuali.core.document.Document.refreshIfEmpty



refreshReferenceObject
public void refreshReferenceObject(String referenceObjectName)(Code)
Uses the persistence service to retrieve a reference object of a parent.
See Also:   org.kuali.core.document.Document.refreshReferenceObject(java.lang.String)



serializeDocumentToXml
public String serializeDocumentToXml()(Code)



setAdHocRoutePersons
public void setAdHocRoutePersons(List adHocRoutePersons)(Code)

See Also:   org.kuali.core.document.Document.setAdHocRoutePersons(java.util.List)



setAdHocRouteWorkgroups
public void setAdHocRouteWorkgroups(List adHocRouteWorkgroups)(Code)

See Also:   org.kuali.core.document.Document.setAdHocRouteWorkgroups(java.util.List)



setDocumentHeader
public void setDocumentHeader(DocumentHeader documentHeader)(Code)

See Also:   org.kuali.core.document.Document.setDocumentHeader(org.kuali.core.document.DocumentHeader)



setDocumentNumber
public void setDocumentNumber(String documentNumber)(Code)

See Also:   org.kuali.core.document.Document.setDocumentNumber(java.lang.String)



setNewDocumentHeader
protected void setNewDocumentHeader() throws WorkflowException(Code)
Gets a new document header for this documents type and sets in the document instance.
throws:
  WorkflowException -



toCopy
public void toCopy() throws WorkflowException, IllegalStateException(Code)

See Also:   org.kuali.core.document.Copyable.toCopy



toString
final public String toString()(Code)

See Also:   java.lang.Object.toString



toStringBuilder
protected String toStringBuilder(LinkedHashMap fieldValues)(Code)

Parameters:
  fieldValues - consistently-formatted String containing the given fieldnames and their values



toStringMapper
protected LinkedHashMap toStringMapper()(Code)
Map containing the fieldValues of the key fields for this class, indexed by fieldName



validateBusinessRules
public void validateBusinessRules(KualiDocumentEvent event)(Code)



Fields inherited from org.kuali.core.bo.PersistableBusinessObjectBase
protected Long versionNumber(Code)(Java Doc)

Methods inherited from org.kuali.core.bo.PersistableBusinessObjectBase
public boolean addNote(Note note)(Code)(Java Doc)
public void afterDelete(PersistenceBroker persistenceBroker) throws PersistenceBrokerException(Code)(Java Doc)
public void afterInsert(PersistenceBroker persistenceBroker) throws PersistenceBrokerException(Code)(Java Doc)
public void afterLookup(PersistenceBroker persistenceBroker) throws PersistenceBrokerException(Code)(Java Doc)
public void afterUpdate(PersistenceBroker persistenceBroker) throws PersistenceBrokerException(Code)(Java Doc)
public void beforeDelete(PersistenceBroker persistenceBroker) throws PersistenceBrokerException(Code)(Java Doc)
public void beforeInsert(PersistenceBroker persistenceBroker) throws PersistenceBrokerException(Code)(Java Doc)
public void beforeUpdate(PersistenceBroker persistenceBroker) throws PersistenceBrokerException(Code)(Java Doc)
public List buildListOfDeletionAwareLists()(Code)(Java Doc)
public boolean deleteNote(Note note)(Code)(Java Doc)
public Note getBoNote(int nbr)(Code)(Java Doc)
public List getBoNotes()(Code)(Java Doc)
public PersistableBusinessObjectExtension getExtension()(Code)(Java Doc)
public String getObjectId()(Code)(Java Doc)
public Long getVersionNumber()(Code)(Java Doc)
public boolean isBoNotesSupport()(Code)(Java Doc)
public boolean isNewCollectionRecord()(Code)(Java Doc)
public void linkEditableUserFields()(Code)(Java Doc)
public void refresh()(Code)(Java Doc)
public void refreshIfEmpty()(Code)(Java Doc)
public void refreshNonUpdateableReferences()(Code)(Java Doc)
public void refreshReferenceObject(String referenceObjectName)(Code)(Java Doc)
public void setBoNotes(List boNotes)(Code)(Java Doc)
public void setExtension(PersistableBusinessObjectExtension extension)(Code)(Java Doc)
public void setNewCollectionRecord(boolean isNewCollectionRecord)(Code)(Java Doc)
public void setObjectId(String objectId)(Code)(Java Doc)
public void setVersionNumber(Long versionNumber)(Code)(Java Doc)
protected Boolean supportsBoNotes()(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.