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


org.kuali.core.maintenance.Maintainable

All known Subclasses:   org.kuali.core.maintenance.KualiMaintainableImpl,
Maintainable
public interface Maintainable extends java.io.Serializable,SelectiveReferenceRefresher(Code)
This interface defines basic methods that all maintainable objects must provide.




Method Summary
public  voidaddMultipleValueLookupResults(MaintenanceDocument document, String collectionName, Collection<PersistableBusinessObject> rawValues)
    
public  voidaddNewLineToCollection(String collectionName)
     Adds the new line for the given collection to the business object's collection.
public  List<MaintenanceLock>generateMaintenanceLocks()
    
public  ClassgetBoClass()
    
public  PersistableBusinessObjectgetBusinessObject()
     Returns instance of the business object that is being maintained.
public  StringgetDocumentTitle(MaintenanceDocument document)
     This is a hook to allow the document to override the generic document title.
public  List<String>getDuplicateIdentifierFieldsFromDataDictionary(String docTypeName, String collectionName)
    
public  Map<String, Boolean>getInactiveRecordDisplay()
     Returns the Map used to control the state of inactive record collection display.
public  StringgetMaintainableTitle()
     Returns a string that will be displayed as title on the maintenance screen.
public  StringgetMaintenanceAction()
    
public  List<String>getMultiValueIdentifierList(Collection maintCollection, List<String> duplicateIdentifierFields)
    
public  PersistableBusinessObjectgetNewCollectionLine(String collectionName)
    
public  ListgetSections(Maintainable oldMaintainable)
     Returns a list of Section objects that specify how to render the view for the maintenance object.
public  booleangetShowInactiveRecords(String collectionName)
     Indicates whether inactive records for the given collection should be display.
public  voidhandleRouteStatusChange(DocumentHeader documentHeader)
    
public  booleanhasBusinessObjectExisted(BusinessObject bo, List<String> existingIdentifierList, List<String> duplicateIdentifierFields)
    
public  booleanisBoNotesEnabled()
    
public  booleanisGenerateBlankRequiredValues()
     Indicates whether default values should be generated for blank required fields on this maintainable.
public  booleanisGenerateDefaultValues()
     Indicates whether default values are set on this maintainable.
public  MappopulateBusinessObject(Map fieldValues)
     Populates the business object based on key/value pairs.
public  MappopulateNewCollectionLines(Map fieldValues)
     Populates the new collection lines based on key/value pairs.
public  voidprepareForSave()
     This method is a hook to do any necessary pre-save processing.
public  voidprocessAfterCopy()
     This method is a hook to do any necessary post-copy processing.
public  voidprocessAfterEdit()
     This method is a hook to do any necessary post-edit processing, which is to say that it is called when a document is about to be edited; this is therefore a hook to write any code to modify the business object before it is displayed to the end user to edit.
public  voidprocessAfterRetrieve()
     This method is a hook to do any necessary post-load processing.
public  voidrefresh(String refreshCaller, Map fieldValues, MaintenanceDocument document)
     Called from a lookup return by the maintenance action.
public  voidsaveBusinessObject()
     This method will cause the Maintainable implementation to save/store the relevant business object(s).
public  voidsetBoClass(Class boClass)
    
public  voidsetBusinessObject(PersistableBusinessObject object)
     Sets an instance of a business object to be maintained.
public  voidsetDocumentNumber(String documentNumber)
    
public  voidsetGenerateBlankRequiredValues(boolean generateBlankRequiredValues)
     Indicates to maintainable whether or not to set default values for blank required fields.
public  voidsetGenerateDefaultValues(boolean generateDefault)
     Indicates to maintainable whether or not to set default values.
public  voidsetMaintenanceAction(String maintenanceAction)
    
public  voidsetShowInactiveRecords(String collectionName, boolean showInactive)
     Indicates to maintainble whether or not inactive records should be displayed for the given collection name.
public  voidsetupNewFromExisting()
     This methods will do the setting of some attributes that might be necessary if we're creating a new business object using on an existing business object.



Method Detail
addMultipleValueLookupResults
public void addMultipleValueLookupResults(MaintenanceDocument document, String collectionName, Collection<PersistableBusinessObject> rawValues)(Code)



addNewLineToCollection
public void addNewLineToCollection(String collectionName)(Code)
Adds the new line for the given collection to the business object's collection.
Parameters:
  collectionName -



generateMaintenanceLocks
public List<MaintenanceLock> generateMaintenanceLocks()(Code)
the locking representation(s) of this document, which are reproducible given the same keys and the same maintainable object



getBoClass
public Class getBoClass()(Code)



getBusinessObject
public PersistableBusinessObject getBusinessObject()(Code)
Returns instance of the business object that is being maintained.



getDocumentTitle
public String getDocumentTitle(MaintenanceDocument document)(Code)
This is a hook to allow the document to override the generic document title. String document title



getDuplicateIdentifierFieldsFromDataDictionary
public List<String> getDuplicateIdentifierFieldsFromDataDictionary(String docTypeName, String collectionName)(Code)



getInactiveRecordDisplay
public Map<String, Boolean> getInactiveRecordDisplay()(Code)
Returns the Map used to control the state of inactive record collection display. Exposed for setting from the maintenance jsp.



getMaintainableTitle
public String getMaintainableTitle()(Code)
Returns a string that will be displayed as title on the maintenance screen.



getMaintenanceAction
public String getMaintenanceAction()(Code)
Returns the maintenance action - new, edit, or copy



getMultiValueIdentifierList
public List<String> getMultiValueIdentifierList(Collection maintCollection, List<String> duplicateIdentifierFields)(Code)



getNewCollectionLine
public PersistableBusinessObject getNewCollectionLine(String collectionName)(Code)
Gets the holder for the "add line" for a collection on the business object
Parameters:
  collectionName -



getSections
public List getSections(Maintainable oldMaintainable)(Code)
Returns a list of Section objects that specify how to render the view for the maintenance object.
Parameters:
  oldMaintainable - - If this is the new maintainable, the old is passed in for reference



getShowInactiveRecords
public boolean getShowInactiveRecords(String collectionName)(Code)
Indicates whether inactive records for the given collection should be display.
Parameters:
  collectionName - - name of the collection (or sub-collection) to check inactive record display setting true if inactive records should be displayed, false otherwise



handleRouteStatusChange
public void handleRouteStatusChange(DocumentHeader documentHeader)(Code)
method to integrate with workflow, where we will actually handle the transitions of status for documents



hasBusinessObjectExisted
public boolean hasBusinessObjectExisted(BusinessObject bo, List<String> existingIdentifierList, List<String> duplicateIdentifierFields)(Code)



isBoNotesEnabled
public boolean isBoNotesEnabled()(Code)
Retrieves the status of the boNotesEnabled



isGenerateBlankRequiredValues
public boolean isGenerateBlankRequiredValues()(Code)
Indicates whether default values should be generated for blank required fields on this maintainable.



isGenerateDefaultValues
public boolean isGenerateDefaultValues()(Code)
Indicates whether default values are set on this maintainable.



populateBusinessObject
public Map populateBusinessObject(Map fieldValues)(Code)
Populates the business object based on key/value pairs.



populateNewCollectionLines
public Map populateNewCollectionLines(Map fieldValues)(Code)
Populates the new collection lines based on key/value pairs.
Parameters:
  fieldValues -



prepareForSave
public void prepareForSave()(Code)
This method is a hook to do any necessary pre-save processing.



processAfterCopy
public void processAfterCopy()(Code)
This method is a hook to do any necessary post-copy processing.



processAfterEdit
public void processAfterEdit()(Code)
This method is a hook to do any necessary post-edit processing, which is to say that it is called when a document is about to be edited; this is therefore a hook to write any code to modify the business object before it is displayed to the end user to edit.



processAfterRetrieve
public void processAfterRetrieve()(Code)
This method is a hook to do any necessary post-load processing.



refresh
public void refresh(String refreshCaller, Map fieldValues, MaintenanceDocument document)(Code)
Called from a lookup return by the maintenance action.



saveBusinessObject
public void saveBusinessObject()(Code)
This method will cause the Maintainable implementation to save/store the relevant business object(s). This typically is called only after the maint document has gone through state to final.



setBoClass
public void setBoClass(Class boClass)(Code)



setBusinessObject
public void setBusinessObject(PersistableBusinessObject object)(Code)
Sets an instance of a business object to be maintained.



setDocumentNumber
public void setDocumentNumber(String documentNumber)(Code)
Sets the financial document number
Parameters:
  documentNumber - - the Document's documentNumber



setGenerateBlankRequiredValues
public void setGenerateBlankRequiredValues(boolean generateBlankRequiredValues)(Code)
Indicates to maintainable whether or not to set default values for blank required fields.
Parameters:
  generateBlankRequiredValues -



setGenerateDefaultValues
public void setGenerateDefaultValues(boolean generateDefault)(Code)
Indicates to maintainable whether or not to set default values.
Parameters:
  generateDefault -



setMaintenanceAction
public void setMaintenanceAction(String maintenanceAction)(Code)
Sets the maintenance action - new, edit, or copy



setShowInactiveRecords
public void setShowInactiveRecords(String collectionName, boolean showInactive)(Code)
Indicates to maintainble whether or not inactive records should be displayed for the given collection name.
Parameters:
  collectionName - - name of the collection (or sub-collection) to set inactive record display setting
Parameters:
  showInactive - - true to display inactive, false to not display inactive records



setupNewFromExisting
public void setupNewFromExisting()(Code)
This methods will do the setting of some attributes that might be necessary if we're creating a new business object using on an existing business object. For example, create a division Vendor based on an existing parent Vendor. (Please see VendorMaintainableImpl.java)



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