The methods of the StartSearchControl class are listed below. For a complete list of StartSearchControl class members, see the StartSearchControl Members topic.
![]() ![]() | Public method to let other objects see what types banner search returns. |
![]() | |
![]() | |
![]() | Determines whether the specified Object is equal to the current Object. |
![]() | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. |
![]() | |
![]() | Gets the Type of the current instance. |
![]() | |
![]() | Returns a String that represents the current Object. |
![]() | This is a "hook" that subclasses can override to make special- purpose modifications to a search query just before it runs, or to redirect specific searches to a different page. See portalui.browsing.search.results.BannerStartSearchControl.CustomizeQuery() to customize banner search. The provided QueryArguments object contains the query as specified in the URL (see the javadocs or n-docs for that class). The subclass can do either of two things with this object: (1) return a Redirect that forwards the user on to some other page - for example, if the query has special syntax like a ">" in front of the query string (2) replace the members of the QueryArguments to substitute a different search - for example, you can replace the simple string userQuery with an IPTFilter that runs a complex search. Then return null to stay on the search page instead of redirecting. |
![]() | |
![]() | Overrides superclass method; indicates we are initializing the model and that SearchResultControl.Execute() shouldn't try to deal with an uninitialized model. |
![]() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. |
![]() | This is a "hook" that subclasses can override to add additional settings to a partcular class of search (such as banner search). It's an alternative to encoding the settings in every search form that initiates such a search. See portalui.browsing.search.results.BannerStartSearchControl for a usage example. |
![]() | Subclasses may override this method to log a string as the "userQuery" in the search server log files. This method will always be called last, after GetCustomSearchSettings() and CustomizeQuery(). |
![]() | Creates a shallow copy of the current Object. |
![]() | Helper method to grab query parameters out of the provided arguments and return them in a temporary QueryArguments structure. The argument names may be prepended with the provided prefix. If no args were found or the query could not be reconstructed, this method should return null. |
StartSearchControl Class | com.plumtree.portaluiinfrastructure.search Namespace