[jbossseam-issues] [JBoss JIRA] Closed: (JBSEAM-1842) Need javadoc for Home and EntityHome classes

Pete Muir (JIRA) jira-events at lists.jboss.org
Sun Nov 18 08:15:18 EST 2007

     [ http://jira.jboss.com/jira/browse/JBSEAM-1842?page=all ]

Pete Muir closed JBSEAM-1842.

    Resolution: Done


Please review the javadoc I wrote, and if some is confusing/wrong/incomplete open new issues :)

> Need javadoc for Home and EntityHome classes
> --------------------------------------------
>                 Key: JBSEAM-1842
>                 URL: http://jira.jboss.com/jira/browse/JBSEAM-1842
>             Project: JBoss Seam
>          Issue Type: Feature Request
>          Components: Documentation
>    Affects Versions: 2.0.0.BETA1
>            Reporter: steve tynor
>             Fix For: 2.0.1.GA
> Seamgen generates classes derived from EntityHome which often must be customized by the end user developer.  Currently there is no documentation, not even javadocs, for the various functions inherited from Home and EntityHome (what is the "contract" for the wire()/isWired() functions?  If a new instance needs to be initialized with default values, where should that be done (createInstance()?  wire()? somewhere else?).   How is getDefinedInstance() intended to be used?  Under what circumstances should setId() be called?
> Seamgen is all well and good for getting a sort-of-working CRUD application up and running, but the generated files invariably need to be edited / adapted / customized and without documentation for how they are intended to be used, each end user developer must guess at what the seamgen framework intends.

This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


More information about the seam-issues mailing list