Java Doc for DocumentRuleBase.java in  » ERP-CRM-Financial » Kuali-Financial-System » org » kuali » core » rules » 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.rules 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.kuali.core.rules.DocumentRuleBase

All known Subclasses:   org.kuali.core.maintenance.rules.MaintenanceDocumentRuleBase,  org.kuali.module.kra.budget.rules.ResearchDocumentRuleBase,  org.kuali.core.rules.LedgerPostingDocumentRuleBase,  org.kuali.core.rules.TransactionalDocumentRuleBase,
DocumentRuleBase
abstract public class DocumentRuleBase implements SaveDocumentRule,RouteDocumentRule,ApproveDocumentRule,AddNoteRule,AddAdHocRoutePersonRule,AddAdHocRouteWorkgroupRule(Code)
This class contains all of the business rules that are common to all documents.




Method Summary
protected  DictionaryValidationServicegetDictionaryValidationService()
    
protected  KualiConfigurationServicegetKualiConfigurationService()
    
protected  KualiModuleServicegetKualiModuleService()
    
public  intgetMaxDictionaryValidationDepth()
    
protected  UniversalUserServicegetUniversalUserService()
    
protected  KualiWorkflowInfogetWorkflowInfoService()
    
public  booleanisAddHocRoutePersonValid(Document document, AdHocRoutePerson person)
     Verifies that the adHocRoutePerson's fields are valid - it does required and format checks.
public  booleanisAddHocRouteWorkgroupValid(AdHocRouteWorkgroup workgroup)
     Verifies that the adHocRouteWorkgroup's fields are valid - it does required and format checks.
public  booleanisDocumentAttributesValid(Document document, boolean validateRequired)
     Validates the document attributes against the data dictionary.
Parameters:
  document -
Parameters:
  validateRequired - if true, then an error will be retruned if a DD required field is empty.
public  booleanisDocumentOverviewValid(Document document)
     Verifies that the document's overview fields are valid - it does required and format checks.
public  booleanisNoteValid(Note note)
     Verifies that the note's fields are valid - it does required and format checks.
public  booleanprocessAddAdHocRoutePerson(Document document, AdHocRoutePerson adHocRoutePerson)
    
public  booleanprocessAddAdHocRouteWorkgroup(Document document, AdHocRouteWorkgroup adHocRouteWorkgroup)
    
public  booleanprocessAddNote(Document document, Note note)
     Runs all business rules needed prior to adding a document note.
public  booleanprocessApproveDocument(ApproveDocumentEvent approveEvent)
     Runs all business rules needed prior to approving.
protected  booleanprocessCustomAddAdHocRoutePersonBusinessRules(Document document, AdHocRoutePerson person)
     This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "add ad hoc route person" event.
protected  booleanprocessCustomAddAdHocRouteWorkgroupBusinessRules(Document document, AdHocRouteWorkgroup workgroup)
     This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "add ad hoc route workgroup" event.
protected  booleanprocessCustomAddNoteBusinessRules(Document document, Note note)
     This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "add document note" event.
protected  booleanprocessCustomApproveDocumentBusinessRules(ApproveDocumentEvent approveEvent)
     This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "approve document" event.
protected  booleanprocessCustomRouteDocumentBusinessRules(Document document)
     This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "route document" event.
protected  booleanprocessCustomSaveDocumentBusinessRules(Document document)
     This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "save document" event.
public  booleanprocessRouteDocument(Document document)
     Runs all business rules needed prior to routing.
public  booleanprocessSaveDocument(Document document)
     Runs all business rules needed prior to saving.
public  voidsetMaxDictionaryValidationDepth(int maxDictionaryValidationDepth)
    



Method Detail
getDictionaryValidationService
protected DictionaryValidationService getDictionaryValidationService()(Code)



getKualiConfigurationService
protected KualiConfigurationService getKualiConfigurationService()(Code)



getKualiModuleService
protected KualiModuleService getKualiModuleService()(Code)



getMaxDictionaryValidationDepth
public int getMaxDictionaryValidationDepth()(Code)
Gets the maximum number of levels the data-dictionary based validation will recurse for the document



getUniversalUserService
protected UniversalUserService getUniversalUserService()(Code)



getWorkflowInfoService
protected KualiWorkflowInfo getWorkflowInfoService()(Code)



isAddHocRoutePersonValid
public boolean isAddHocRoutePersonValid(Document document, AdHocRoutePerson person)(Code)
Verifies that the adHocRoutePerson's fields are valid - it does required and format checks.
Parameters:
  person - boolean True if valid, false otherwise.



isAddHocRouteWorkgroupValid
public boolean isAddHocRouteWorkgroupValid(AdHocRouteWorkgroup workgroup)(Code)
Verifies that the adHocRouteWorkgroup's fields are valid - it does required and format checks.
Parameters:
  workgroup - boolean True if valid, false otherwise.



isDocumentAttributesValid
public boolean isDocumentAttributesValid(Document document, boolean validateRequired)(Code)
Validates the document attributes against the data dictionary.
Parameters:
  document -
Parameters:
  validateRequired - if true, then an error will be retruned if a DD required field is empty. if false, no required checking is done True if the document attributes are valid, false otherwise.



isDocumentOverviewValid
public boolean isDocumentOverviewValid(Document document)(Code)
Verifies that the document's overview fields are valid - it does required and format checks.
Parameters:
  document - boolean True if the document description is valid, false otherwise.



isNoteValid
public boolean isNoteValid(Note note)(Code)
Verifies that the note's fields are valid - it does required and format checks.
Parameters:
  note - boolean True if the document description is valid, false otherwise.



processAddAdHocRoutePerson
public boolean processAddAdHocRoutePerson(Document document, AdHocRoutePerson adHocRoutePerson)(Code)

See Also:   org.kuali.core.rule.AddAdHocRoutePersonRule.processAddAdHocRoutePerson(org.kuali.core.document.Documentorg.kuali.core.bo.AdHocRoutePerson)



processAddAdHocRouteWorkgroup
public boolean processAddAdHocRouteWorkgroup(Document document, AdHocRouteWorkgroup adHocRouteWorkgroup)(Code)

See Also:   org.kuali.core.rule.AddAdHocRouteWorkgroupRule.processAddAdHocRouteWorkgroup(org.kuali.core.document.Documentorg.kuali.core.bo.AdHocRouteWorkgroup)



processAddNote
public boolean processAddNote(Document document, Note note)(Code)
Runs all business rules needed prior to adding a document note. This method will return false if any business rule fails.
See Also:   org.kuali.core.rule.AddDocumentNoteRule.processAddDocumentNote(org.kuali.core.document.Documentorg.kuali.core.document.DocumentNote)



processApproveDocument
public boolean processApproveDocument(ApproveDocumentEvent approveEvent)(Code)
Runs all business rules needed prior to approving. This includes both common rules for all documents, plus class-specific business rules. This method will return false if any business rule fails, or if the document is in an invalid state, and not approveble.
See Also:   org.kuali.core.rule.ApproveDocumentRule.processApproveDocument(org.kuali.core.rule.event.ApproveDocumentEvent)



processCustomAddAdHocRoutePersonBusinessRules
protected boolean processCustomAddAdHocRoutePersonBusinessRules(Document document, AdHocRoutePerson person)(Code)
This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "add ad hoc route person" event.
Parameters:
  document -
Parameters:
  person - boolean True if the rules checks passed, false otherwise.



processCustomAddAdHocRouteWorkgroupBusinessRules
protected boolean processCustomAddAdHocRouteWorkgroupBusinessRules(Document document, AdHocRouteWorkgroup workgroup)(Code)
This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "add ad hoc route workgroup" event.
Parameters:
  document -
Parameters:
  workgroup - boolean True if the rules checks passed, false otherwise.



processCustomAddNoteBusinessRules
protected boolean processCustomAddNoteBusinessRules(Document document, Note note)(Code)
This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "add document note" event.
Parameters:
  document -
Parameters:
  note - boolean True if the rules checks passed, false otherwise.



processCustomApproveDocumentBusinessRules
protected boolean processCustomApproveDocumentBusinessRules(ApproveDocumentEvent approveEvent)(Code)
This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "approve document" event.
Parameters:
  document - boolean True if the rules checks passed, false otherwise.



processCustomRouteDocumentBusinessRules
protected boolean processCustomRouteDocumentBusinessRules(Document document)(Code)
This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "route document" event.
Parameters:
  document - boolean True if the rules checks passed, false otherwise.



processCustomSaveDocumentBusinessRules
protected boolean processCustomSaveDocumentBusinessRules(Document document)(Code)
This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "save document" event.
Parameters:
  document - boolean True if the rules checks passed, false otherwise.



processRouteDocument
public boolean processRouteDocument(Document document)(Code)
Runs all business rules needed prior to routing. This includes both common rules for all maintenance documents, plus class-specific business rules. This method will return false if any business rule fails, or if the document is in an invalid state, and not routable (see isDocumentValidForRouting()).
See Also:   org.kuali.core.rule.RouteDocumentRule.processRouteDocument(org.kuali.core.document.Document)



processSaveDocument
public boolean processSaveDocument(Document document)(Code)
Runs all business rules needed prior to saving. This includes both common rules for all documents, plus class-specific business rules. This method will only return false if it fails the isValidForSave() test. Otherwise, it will always return positive regardless of the outcome of the business rules. However, any error messages resulting from the business rules will still be populated, for display to the consumer of this service.
See Also:   org.kuali.core.rule.SaveDocumentRule.processSaveDocument(org.kuali.core.document.Document)



setMaxDictionaryValidationDepth
public void setMaxDictionaryValidationDepth(int maxDictionaryValidationDepth)(Code)
Gets the maximum number of levels the data-dictionary based validation will recurse for the document
Parameters:
  maxDictionaryValidationDepth -



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.