public class CacheControl extends Control
Java class for CacheControl complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="CacheControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}Control"> <sequence> <element name="mode" type="{http://www.w3.org/2001/XMLSchema}string"/> </sequence> </extension> </complexContent> </complexType>
The CacheControl object extends the Control object and defines a single property: mode.
The CacheControl object specifies whether the repository adapter cache should be cleared before an operation is performed and the mode of clearing the cache. The CacheControl object can be passed to the get(), search(), and update() APIs. The LDAP adapter uses the CacheControl to clear its cache; the other out-of-the-box adapters ignore the CacheControl as they not have a cache. If you are using a custom adapter, you can implement its own handling for clearing cache using the CacheControl.
The mode property specifies the mode of clearing the repository adapter cache before an operation is performed. Valid values are:
The values are not case-sensitive. There is no default value for this property. If you do not specify a value, or specify a value other than clearEntity or clearAll, an error message appears.
Constructor and Description |
---|
CacheControl() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
get(java.lang.String propName)
Gets the value of the requested property
|
java.lang.String |
getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property.
|
java.lang.String |
getMode()
Gets the value of the mode property.
|
static java.util.List |
getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, CacheControl
|
static java.util.HashSet |
getSubTypes()
Gets a set of any model objects which extend this model object, CacheControl
|
java.util.ArrayList |
getSuperTypes()
Gets a list of any model objects which this model object, CacheControl, is
an extension of.
|
java.lang.String |
getTypeName()
Gets the name of this model object, CacheControl
|
boolean |
isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.
|
boolean |
isSetMode()
Returns true if the mode property is set; false, otherwise.
|
boolean |
isSubType(java.lang.String superTypeName)
Returns a true if the provided model object is one that this
model object extends; false, otherwise.
|
void |
set(java.lang.String propName,
java.lang.Object value)
Sets the value of the provided property to the provided value.
|
void |
setMode(java.lang.String value)
Sets the value of the mode property.
|
java.lang.String |
toString()
Returns this model object, CacheControl, and its contents as a String
|
void |
unset(java.lang.String propName)
Sets the value of provided property to null.
|
public java.lang.String getMode()
String
public void setMode(java.lang.String value)
value
- allowed object is String
public boolean isSetMode()
boolean
public java.lang.Object get(java.lang.String propName)
public boolean isSet(java.lang.String propName)
public void set(java.lang.String propName, java.lang.Object value)
public void unset(java.lang.String propName)
public java.lang.String getTypeName()
getTypeName
in class Control
String
public static java.util.List getPropertyNames(java.lang.String entityTypeName)
entityTypeName
- allowed object is String
List
public java.lang.String getDataType(java.lang.String propName)
getDataType
in class Control
propName
- allowed object is String
String
public java.util.ArrayList getSuperTypes()
getSuperTypes
in class Control
ArrayList
public boolean isSubType(java.lang.String superTypeName)
public static java.util.HashSet getSubTypes()
HashSet