Java Doc for FinderComponent.java in  » J2EE » Jaffa » org » jaffa » components » finder » 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 » J2EE » Jaffa » org.jaffa.components.finder   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.jaffa.presentation.portlet.component.Component       org.jaffa.components.finder.FinderComponent All known Subclasses:   org.jaffa.applications.test.modules.material.components.itemfinder.ui.ItemFinderComponent,  org.jaffa.components.lookup.LookupComponent, FinderComponent abstract public class FinderComponent extends Component (Code) This is the base class for all Finder components. It has the following properties - 1- displayResultsScreen : If set to true, then the Results screen will directly brought up, bypassing the Criteria screen. 2- sortDropDown : The sort criteria to use for the inquiry 3- exportType : The export option to use for the inquiry (initialized to regular Web Pages) 4- maxRecords: The maximum number of records to retrieve. All records will be retrieved, if no value is specified. 5- finderListener : The Listener object, which will refresh the Results screen, on a new inquiry 6- headerDto : This is a convenience property to pass to Tx, where required author:    GautamJ Field Summary final public static  String ATTRIBUTE_EXPORT_TYPE_XML      This request stream attribute is set by a FinderCriteriaForm, after a query, and if the exportType is XML. The ResultsJsp will use display the XML stored by this attribute. final public static  String EXPORT_TYPE_EXCEL      A global constant for the Excel export option. final public static  String EXPORT_TYPE_WEB_PAGE      A global constant for the Web Page export option. final public static  String EXPORT_TYPE_XML      A global constant for the XML export option. Method Summary protected  void addSortCriteria(FinderInDto inputDto)      Interprets the value of the 'sortDropDown' property adding suitable values to the input Dto. public  Boolean getDisplayResultsScreen()      Getter for property displayResultsScreen. public  String getExportType()      Getter for property exportType. public  IFinderListener getFinderListener()      Getter for property finderListener. protected  HeaderDto getHeaderDto()      Returns the HeaderDto. public  Integer getMaxRecords()      Getter for property maxRecords. public  String getSortDropDown()      Getter for property sortDropDown. public  void incrementMaxRecords()      This will set the property 'maxRecords' to the value following the current one, in the list of values returned by CriteriaDropDownOptions.getMaxRecordsDropDownOptions(). protected  void invokeFinderListener()      Invokes the inquiryDone() method of the registered IFinderListener object in the same thread. protected  void invokeFinderListener(EventObject eventObject)      Invokes the inquiryDone() method of the registered IFinderListener object in the same thread. public  void quit()      This clears the listener and then invokes the quit() method of the base class. public  void setDisplayResultsScreen(Boolean displayResultsScreen)      Setter for property displayResultsScreen. public  void setExportType(String exportType)      Setter for property exportType. public  void setFinderListener(IFinderListener finderListener)      Setter for property finderListener. public  void setMaxRecords(Integer maxRecords)      Setter for property maxRecords. public  void setSortDropDown(String sortDropDown)      Setter for property sortDropDown. Field Detail ATTRIBUTE_EXPORT_TYPE_XML final public static String ATTRIBUTE_EXPORT_TYPE_XML(Code) This request stream attribute is set by a FinderCriteriaForm, after a query, and if the exportType is XML. The ResultsJsp will use display the XML stored by this attribute. EXPORT_TYPE_EXCEL final public static String EXPORT_TYPE_EXCEL(Code) A global constant for the Excel export option. EXPORT_TYPE_WEB_PAGE final public static String EXPORT_TYPE_WEB_PAGE(Code) A global constant for the Web Page export option. EXPORT_TYPE_XML final public static String EXPORT_TYPE_XML(Code) A global constant for the XML export option. Method Detail addSortCriteria protected void addSortCriteria(FinderInDto inputDto)(Code) Interprets the value of the 'sortDropDown' property adding suitable values to the input Dto. Parameters:   inputDto - The Dto to which the orderby fields will be added. getDisplayResultsScreen public Boolean getDisplayResultsScreen()(Code) Getter for property displayResultsScreen. Value of property displayResultsScreen. getExportType public String getExportType()(Code) Getter for property exportType. Value of property exportType. getFinderListener public IFinderListener getFinderListener()(Code) Getter for property finderListener. Value of property finderListener. getHeaderDto protected HeaderDto getHeaderDto()(Code) Returns the HeaderDto. This can be used for passing the header info to the Tx, where required. the HeaderDto. getMaxRecords public Integer getMaxRecords()(Code) Getter for property maxRecords. Value of property maxRecords. getSortDropDown public String getSortDropDown()(Code) Getter for property sortDropDown. Value of property sortDropDown. incrementMaxRecords public void incrementMaxRecords()(Code) This will set the property 'maxRecords' to the value following the current one, in the list of values returned by CriteriaDropDownOptions.getMaxRecordsDropDownOptions(). invokeFinderListener protected void invokeFinderListener()(Code) Invokes the inquiryDone() method of the registered IFinderListener object in the same thread. invokeFinderListener protected void invokeFinderListener(EventObject eventObject)(Code) Invokes the inquiryDone() method of the registered IFinderListener object in the same thread. Parameters:   eventObject - The EventObject which will probably contain the component itself. quit public void quit()(Code) This clears the listener and then invokes the quit() method of the base class. setDisplayResultsScreen public void setDisplayResultsScreen(Boolean displayResultsScreen)(Code) Setter for property displayResultsScreen. Parameters:   displayResultsScreen - New value of property displayResultsScreen. setExportType public void setExportType(String exportType)(Code) Setter for property exportType. Parameters:   exportType - New value of property exportType. setFinderListener public void setFinderListener(IFinderListener finderListener)(Code) Setter for property finderListener. Parameters:   finderListener - New value of property finderListener. setMaxRecords public void setMaxRecords(Integer maxRecords)(Code) Setter for property maxRecords. Parameters:   maxRecords - New value of property maxRecords. setSortDropDown public void setSortDropDown(String sortDropDown)(Code) Setter for property sortDropDown. Parameters:   sortDropDown - New value of property sortDropDown. Methods inherited from org.jaffa.presentation.portlet.component.Component public void addChildComponent(Component component)(Code)(Java Doc) public void addFormKeyChangeListener(FormKeyChangeListener listener)(Code)(Java Doc) abstract public FormKey display() throws FrameworkException, ApplicationExceptions(Code)(Java Doc) public ComponentDefinition getComponentDefinition()(Code)(Java Doc) public String getComponentId()(Code)(Java Doc) public FormKey getContainerFormKey()(Code)(Java Doc) public FormKeyChangeListener[] getFormKeyChangeListeners()(Code)(Java Doc) public FormKey getReturnToFormKey()(Code)(Java Doc) public String getToken()(Code)(Java Doc) public UserSession getUserSession()(Code)(Java Doc) public boolean isActive()(Code)(Java Doc) public void quit()(Code)(Java Doc) public FormKey quitAndReturnToCallingScreen()(Code)(Java Doc) public void reflectAndSetParms(HttpServletRequest request)(Code)(Java Doc) public void removeFormKeyChangeListener(FormKeyChangeListener listener)(Code)(Java Doc) public Collection returnChildComponents()(Code)(Java Doc) public DateTime returnLastActivityDate()(Code)(Java Doc) public Component run(String component)(Code)(Java Doc) public void setContainerFormKey(FormKey containerFormKey)(Code)(Java Doc) public void setReturnToFormKey(FormKey returnToFormKey)(Code)(Java Doc) public void setToken(String token)(Code)(Java Doc) public void updateLastActivityDate()(Code)(Java Doc) 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)