CacheVariable

CacheVariable

This type is a class for model objects.

* No description is available *
Package: webappext

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Collection attributes having this type:
  CacheEntryIDGeneration.cacheVariables

Attributes Summary

type : CacheVariableKind Only one option may be chosen. Type can either be "Request Parameter", "Request Attribute", or "Session Parameter". User data from an HTML form would be a Request Parameter, while a tag could be either a Request Attribute or a Session Parameter.

id : EString The name of the variable. Equivalent to the "id" attribute in a .

method : EString String, only available if Type is "Request Attribute" or "Session Parameter". Defaults to toString. Request Attributes and Session Parameters are actually Java objects, so a method must be called on that object to retrieve data for the cache to use. Only used if the type is REQUEST_ATTRIBUTE or SESSION_PARAMETER.

required : EBoolean hether this variables presence in the request/session is required to cache an invocation of this servlet.

dataId : EString The data id string combines with the value of this variable to form a group id; thus, cache entries that have the same value for this variable will all be part of the same group. This group can then be invalidated all at once.

invalidate : EString Works just like data ids, except all members of the group generated will be removed from the cache.

Attribute Details

type  -  Only one option may be chosen. Type can either be "Request Parameter", "Request Attribute", or "Session Parameter". User data from an HTML form would be a Request Parameter, while a tag could be either a Request Attribute or a Session Parameter.
    Data Type: CacheVariableKind
    Default value:  unspecified
    Allowed values:
        0 - REQUEST_PARAMETER
        1 - REQUEST_ATTRIBUTE
        2 - SESSION_PARAMETER
        3 - COOKIE
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

id  -  The name of the variable. Equivalent to the "id" attribute in a .
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

method  -  String, only available if Type is "Request Attribute" or "Session Parameter". Defaults to toString. Request Attributes and Session Parameters are actually Java objects, so a method must be called on that object to retrieve data for the cache to use. Only used if the type is REQUEST_ATTRIBUTE or SESSION_PARAMETER.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

required  -  hether this variables presence in the request/session is required to cache an invocation of this servlet.
    Data Type: EBoolean
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

dataId  -  The data id string combines with the value of this variable to form a group id; thus, cache entries that have the same value for this variable will all be part of the same group. This group can then be invalidated all at once.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

invalidate  -  Works just like data ids, except all members of the group generated will be removed from the cache.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

(C) COPYRIGHT International Business Machines Corp. 1996-2006

Attributes Summary
type : CacheVariableKind	Only one option may be chosen. Type can either be "Request Parameter", "Request Attribute", or "Session Parameter". User data from an HTML form would be a Request Parameter, while a tag could be either a Request Attribute or a Session Parameter.
id : EString	The name of the variable. Equivalent to the "id" attribute in a .
method : EString	String, only available if Type is "Request Attribute" or "Session Parameter". Defaults to toString. Request Attributes and Session Parameters are actually Java objects, so a method must be called on that object to retrieve data for the cache to use. Only used if the type is REQUEST_ATTRIBUTE or SESSION_PARAMETER.
required : EBoolean	hether this variables presence in the request/session is required to cache an invocation of this servlet.
dataId : EString	The data id string combines with the value of this variable to form a group id; thus, cache entries that have the same value for this variable will all be part of the same group. This group can then be invalidated all at once.
invalidate : EString	Works just like data ids, except all members of the group generated will be removed from the cache.