DEPRECATED

# com.bea.p13n.content.servlets.jsp.taglib
BaseTag Class

public abstract class BaseTag
extends `TagSupport`

The base class for all content tags.

This provides support for the `BaseTag.failOnError```, `BaseTag.readOnly```, `BaseTag.useCache```, `BaseTag.cacheScope```, `BaseTag.cacheId```, and `BaseTag.cacheTimeout``` parameters.

Hierarchy
  `Object`
  `TagSupport`
  `BaseTag`

All Implemented Interfaces
  `IterationTag`, `Serializable`, `Tag`

Direct Known Subclasses
  `com.bea.p13n.content.servlets.jsp.taglib.GetPropertyTag`, `com.bea.p13n.content.servlets.jsp.taglib.PrintDocTag`, `com.bea.p13n.content.servlets.jsp.taglib.SelectByIdTag`, `com.bea.p13n.content.servlets.jsp.taglib.SelectTag`

## Field Summary

`protected `String`` | `cacheId` The cache id.
`protected `String`` | `cacheScope` The cache scope.
`protected long` | `cacheTimeout` The cache timeout.
`protected boolean` | `failOnError` Are we supposed to fail (i.e. throw an exception) on an error.
`protected boolean` | `readOnly` Are we supposed to get readonly versions of things.
`protected boolean` | `useCache` Should this try to use the `ContentCache```.

Fields from javax.servlet.jsp.tagext`.`TagSupport``
`id, pageContext`

Fields from interface javax.servlet.jsp.tagext`.`IterationTag``
`EVAL_BODY_AGAIN`

Fields from interface javax.servlet.jsp.tagext`.`Tag``
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

## Constructor Summary

BaseTag()

## Method Summary

`public `String`` | `getCacheId`() Get the cacheId which should be used.
`public `String`` | `getCacheScope`() Get the value of `BaseTag.cacheScope```.
`public `String`` | `getCacheTimeout`() Get the value of `BaseTag.cacheTimeout```.
`public `String`` | `getFailOnError`() Get the value of `BaseTag.failOnError``` as a string.
`public `HttpSession`` | `getHttpSession`() Get the current HttpSession.
`public `String`` | `getReadOnly`() Get the value of `BaseTag.readOnly``` as a String.
`public `String`` | `getUseCache`() Get the value of `BaseTag.useCache```.
`public `String`` | `getUserId`() Get the user id of the current user.
`public void` | `release`() Release the tag by setting everything to the default.
`public void` | `setCacheId`(`String` s) Set the value of `BaseTag.cacheId```.
`public void` | `setCacheScope`(`String` s) Get the value of `BaseTag.cacheScope```.
`public void` | `setCacheTimeout`(`String` v) Set the value of `BaseTag.cacheTimeout```.
`public void` | `setCacheTimeout`(long l) Set the value of `BaseTag.cacheTimeout```.
`public void` | `setFailOnError`(`String` s) Set the value of `BaseTag.failOnError```.
`public void` | `setFailOnError`(boolean b) Set the value of `BaseTag.failOnError```.
`public void` | `setReadOnly`(`String` s) Set the value of `BaseTag.readOnly```.
`public void` | `setReadOnly`(boolean b) Set the value of `BaseTag.readOnly```.
`public void` | `setUseCache`(`String` s) Set the value of `BaseTag.useCache```.
`public void` | `setUseCache`(boolean b) Set the value of `BaseTag.useCache```.
`public static `Map`` | `toDictionary`(`String` in) Convert a semi-colon separated of "name=value" pairs into a map.

Methods from `javax.servlet.jsp.tagext.`TagSupport``
`doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `javax.servlet.jsp.tagext.`IterationTag``
`doAfterBody`

Methods from interface `javax.servlet.jsp.tagext.`Tag``
`doEndTag, doStartTag, getParent, release, setPageContext, setParent`

## Field Detail

### cacheId

    protected String cacheId

  The cache id.

  When accessing the cache, in general, if this is not set, then the ID should be used.

### cacheScope

    protected String cacheScope

  The cache scope.

  This should correspond to something which the `ContentCache``` understands. The standard values are "application", "session", "page", and "request".

### cacheTimeout

    protected long cacheTimeout

  The cache timeout.

### failOnError

    protected boolean failOnError

  Are we supposed to fail (i.e. throw an exception) on an error.

### readOnly

    protected boolean readOnly

  Are we supposed to get readonly versions of things.

### useCache

    protected boolean useCache

  Should this try to use the `ContentCache```.

## Constructor Detail

### BaseTag

    public BaseTag()

## Method Detail

### getCacheId() Method

    public String getCacheId()

Get the cacheId which should be used.

### getCacheScope() Method

    public String getCacheScope()

Get the value of `BaseTag.cacheScope```.

### getCacheTimeout() Method

    public String getCacheTimeout()

Get the value of `BaseTag.cacheTimeout```.

### getFailOnError() Method

    public String getFailOnError()

Get the value of `BaseTag.failOnError``` as a string.

### getHttpSession() Method

    public HttpSession getHttpSession()

Get the current HttpSession.

### getReadOnly() Method

DEPRECATED No longer needed.

    public String getReadOnly()

Get the value of `BaseTag.readOnly``` as a String.

### getUseCache() Method

    public String getUseCache()

Get the value of `BaseTag.useCache```.

### getUserId() Method

    public String getUserId()

Get the user id of the current user.

### release() Method

    public void release()

Release the tag by setting everything to the default.

Overrides
  `TagSupport.release()`

### setCacheId(String) Method

    public void setCacheId(String s)

Set the value of `BaseTag.cacheId```.

### setCacheScope(String) Method

    public void setCacheScope(String s)

Get the value of `BaseTag.cacheScope```.

### setCacheTimeout(String) Method

    public void setCacheTimeout(String v)

Set the value of `BaseTag.cacheTimeout```.

### setCacheTimeout(long) Method

    public void setCacheTimeout(long l)

Set the value of `BaseTag.cacheTimeout```.

### setFailOnError(String) Method

    public void setFailOnError(String s)

Set the value of `BaseTag.failOnError```.

### setFailOnError(boolean) Method

    public void setFailOnError(boolean b)

Set the value of `BaseTag.failOnError```.

### setReadOnly(String) Method

DEPRECATED No longer needed.

    public void setReadOnly(String s)

Set the value of `BaseTag.readOnly```.

### setReadOnly(boolean) Method

DEPRECATED No longer needed.

    public void setReadOnly(boolean b)

Set the value of `BaseTag.readOnly```.

### setUseCache(String) Method

    public void setUseCache(String s)

Set the value of `BaseTag.useCache```.

### setUseCache(boolean) Method

    public void setUseCache(boolean b)

Set the value of `BaseTag.useCache```.

### toDictionary(String) Method

    public static Map toDictionary(String in)

Convert a semi-colon separated of "name=value" pairs into a map.