|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectrailo.runtime.ext.tag.TagImpl
railo.runtime.tag.Index
public final class Index
Populates collections with indexed data.
Field Summary | |
---|---|
static String[] |
EXTENSIONS
|
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
---|---|
Index()
|
Method Summary | |
---|---|
int |
doEndTag()
|
int |
doStartTag()
|
void |
release()
|
void |
setAction(String action)
set the value action Specifies the index action. |
void |
setBody(String body)
set the value body |
void |
setCategory(String listCategories)
|
void |
setCategorytree(String categoryTree)
|
void |
setCollection(String collection)
set the value collection Specifies a collection name. |
void |
setCustom1(String custom1)
set the value custom1 A custom field you can use to store data during an indexing operation. |
void |
setCustom2(String custom2)
set the value custom2 A custom field you can use to store data during an indexing operation. |
void |
setCustom3(String custom3)
|
void |
setCustom4(String custom4)
|
void |
setExtensions(String extensions)
set the value extensions |
void |
setExternal(boolean external)
set the value external |
void |
setKey(String key)
set the value key |
void |
setLanguage(String language)
set the value language |
void |
setName(String name)
|
void |
setPrefix(String prefix)
|
void |
setQuery(String query)
set the value query Specifies the name of the query against which the collection is generated. |
void |
setRecurse(boolean recurse)
set the value recurse Yes or No. |
void |
setStatus(String status)
|
void |
setThrowontimeout(boolean throwontimeout)
set the value throwontimeout Yes or No. |
void |
setTimeout(double timeout)
|
void |
setTitle(String title)
set the value title Title for collection; Query column name for type and a valid query name; Permits searching collections by title or displaying a separate title from the key |
void |
setType(String type)
set the value type Specifies the type of entity being indexed. |
void |
setUrlpath(String urlpath)
set the value urlpath Specifies the URL path for files if type = "file" and type = "path". |
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 |
Field Detail |
---|
public static String[] EXTENSIONS
Constructor Detail |
---|
public Index()
Method Detail |
---|
public void release()
release
in interface javax.servlet.jsp.tagext.Tag
release
in class TagImpl
Tag.release()
public void setAction(String action)
action
- value to setpublic void setUrlpath(String urlpath)
urlpath
- value to setpublic void setType(String type) throws PageException
type
- value to set
PageException
public void setTimeout(double timeout) throws ApplicationException
timeout
- the timeout in seconds
ApplicationException
public void setThrowontimeout(boolean throwontimeout)
throwontimeout
- value to setpublic void setName(String name)
public void setTitle(String title)
title
- value to setpublic void setCustom1(String custom1)
custom1
- value to setpublic void setLanguage(String language)
language
- value to setpublic void setExternal(boolean external)
external
- value to set
ApplicationException
public void setExtensions(String extensions) throws PageException
extensions
- value to set
PageException
public void setKey(String key)
key
- value to setpublic void setCustom2(String custom2)
custom2
- value to setpublic void setCustom3(String custom3)
custom3
- The custom3 to set.public void setCustom4(String custom4)
custom4
- The custom4 to set.public void setQuery(String query)
query
- value to setpublic void setCollection(String collection) throws PageException
collection
- value to set
PageException
public void setRecurse(boolean recurse)
recurse
- value to setpublic void setBody(String body)
body
- value to setpublic void setCategory(String listCategories)
category
- the category to set
ApplicationException
public void setCategorytree(String categoryTree)
categoryTree
- the categoryTree to set
ApplicationException
public void setPrefix(String prefix)
prefix
- the prefix to setpublic void setStatus(String status)
status
- the status to set
ApplicationException
public int doStartTag() throws PageException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class TagImpl
SecurityException
PageException
Tag.doStartTag()
public int doEndTag()
doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class TagImpl
Tag.doEndTag()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |