railo.runtime.tag
Class Search

java.lang.Object
  extended by railo.runtime.ext.tag.TagImpl
      extended by railo.runtime.tag.Search
All Implemented Interfaces:
javax.servlet.jsp.tagext.Tag

public final class Search
extends TagImpl


Field Summary
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
Search()
           
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
 void release()
           
 void setCategory(String listCategories)
           
 void setCategorytree(String categoryTree)
           
 void setCollection(String collection)
          set the value collection The logical collection name that is the target of the search operation or an external collection with fully qualified path.
 void setContextbytes(double contextBytes)
           
 void setContexthighlightbegin(String contextHighlightBegin)
           
 void setContexthighlightend(String contextHighlightEnd)
           
 void setContextpassages(double contextPassages)
           
 void setCriteria(String criteria)
          set the value criteria Specifies the criteria for the search following the syntactic rules specified by type.
 void setExternal(boolean external)
          set the value external
 void setLanguage(String language)
          set the value language
 void setMaxrows(double maxrows)
          set the value maxrows Specifies the maximum number of entries for index queries.
 void setName(String name)
          set the value name A name for the search query.
 void setPreviouscriteria(String previousCriteria)
           
 void setStartrow(double startrow)
          set the value startrow Specifies the first row number to be retrieved.
 void setStatus(String status)
           
 void setSuggestions(String suggestions)
           
 void setType(String type)
          set the value type Specifies the criteria type for the search.
 
Methods inherited from class railo.runtime.ext.tag.TagImpl
getParent, required, required, required, required, setPageContext, setPageContext, setParent
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Search

public Search()
Method Detail

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class TagImpl

setType

public void setType(String type)
             throws ApplicationException
set the value type Specifies the criteria type for the search.

Parameters:
type - value to set
Throws:
ApplicationException

setMaxrows

public void setMaxrows(double maxrows)
set the value maxrows Specifies the maximum number of entries for index queries. If omitted, all rows are returned.

Parameters:
maxrows - value to set

setCriteria

public void setCriteria(String criteria)
set the value criteria Specifies the criteria for the search following the syntactic rules specified by type.

Parameters:
criteria - value to set

setStartrow

public void setStartrow(double startrow)
set the value startrow Specifies the first row number to be retrieved. Default is 1.

Parameters:
startrow - value to set

setCollection

public void setCollection(String collection)
                   throws PageException
set the value collection The logical collection name that is the target of the search operation or an external collection with fully qualified path.

Parameters:
collection - value to set
Throws:
PageException

setLanguage

public void setLanguage(String language)
set the value language

Parameters:
language - value to set

setExternal

public void setExternal(boolean external)
                 throws ApplicationException
set the value external

Parameters:
external - value to set
Throws:
ApplicationException

setName

public void setName(String name)
set the value name A name for the search query.

Parameters:
name - value to set

setCategory

public void setCategory(String listCategories)
Parameters:
category - the category to set
Throws:
ApplicationException

setCategorytree

public void setCategorytree(String categoryTree)
Parameters:
categoryTree - the categoryTree to set
Throws:
ApplicationException

setContextbytes

public void setContextbytes(double contextBytes)
                     throws ApplicationException
Parameters:
contextBytes - the contextBytes to set
Throws:
ApplicationException

setContexthighlightbegin

public void setContexthighlightbegin(String contextHighlightBegin)
Parameters:
contextHighlightBegin - the contextHighlightBegin to set
Throws:
ApplicationException

setContexthighlightend

public void setContexthighlightend(String contextHighlightEnd)
Parameters:
contextHighlightEnd - the contextHighlightEnd to set
Throws:
ApplicationException

setContextpassages

public void setContextpassages(double contextPassages)
                        throws ApplicationException
Parameters:
contextPassages - the contextPassages to set
Throws:
ApplicationException

setPreviouscriteria

public void setPreviouscriteria(String previousCriteria)
                         throws ApplicationException
Parameters:
previousCriteria - the previousCriteria to set
Throws:
ApplicationException

setStatus

public void setStatus(String status)
Parameters:
status - the status to set
Throws:
ApplicationException

setSuggestions

public void setSuggestions(String suggestions)
                    throws PageException
Parameters:
suggestions - the suggestions to set
Throws:
ApplicationException
PageException

doStartTag

public int doStartTag()
               throws PageException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class TagImpl
Throws:
PageException

doEndTag

public int doEndTag()
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class TagImpl


Copyright © 2012 Railo