public class ChangeControl extends SearchControl
Java class for ChangeControl complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="ChangeControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}SearchControl"> <sequence> <element name="checkPoint" type="{http://www.ibm.com/websphere/wim}CheckPointType" maxOccurs="unbounded" minOccurs="0"/> <element name="changeTypes" type="{http://www.w3.org/2001/XMLSchema}token" maxOccurs="unbounded" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>
The ChangeControl object extends the SearchControl object and defines two properties: checkPoint and changeTypes.
The ChangeControl data object provides a client application with the ability to query federated repositories for changed entities, such as new, modified, and deleted entities, from a specified checkpoint onwards.
A client application can use the ChangeControl data object to synchronize its internal cache or other repositories, with the user registry, and provide a secure environment using the latest information in its cache or repositories. *
There could be one or more instances of checkPoint in a ChangeControl data object, depending on the number of repositories involved in a search.
PropertyControl.ContextProperties
Constructor and Description |
---|
ChangeControl() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
get(java.lang.String propName)
Gets the value of the requested property
|
java.util.List<java.lang.String> |
getChangeTypes()
Gets the value of the changeTypes property.
|
java.util.List<CheckPointType> |
getCheckPoint()
Gets the value of the checkPoint property.
|
java.lang.String |
getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property.
|
static java.util.List |
getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, ChangeControl
|
static java.util.HashSet |
getSubTypes()
Gets a set of any model objects which extend this model object, ChangeControl
|
java.util.ArrayList |
getSuperTypes()
Gets a list of any model objects which this model object, ChangeControl, is
an extension of.
|
java.lang.String |
getTypeName()
Gets the name of this model object, ChangeControl
|
boolean |
isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.
|
boolean |
isSetChangeTypes()
Returns true if the changeTypes property is set; false, otherwise.
|
boolean |
isSetCheckPoint()
Returns true if the checkPoint 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.
|
java.lang.String |
toString()
Returns this model object, ChangeControl, and its contents as a String
|
void |
unset(java.lang.String propName)
Sets the value of provided property to null.
|
void |
unsetChangeTypes()
Resets the changeTypes property to null.
|
void |
unsetCheckPoint()
Resets the checkPoint property to null.
|
getCountLimit, getExpression, getSearchBases, getSearchLimit, getTimeLimit, isReturnSubType, isSetCountLimit, isSetExpression, isSetReturnSubType, isSetSearchBases, isSetSearchLimit, isSetTimeLimit, setCountLimit, setExpression, setReturnSubType, setSearchLimit, setTimeLimit, unsetCountLimit, unsetReturnSubType, unsetSearchBases, unsetSearchLimit, unsetTimeLimit
getContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
public java.util.List<CheckPointType> getCheckPoint()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set
method for the checkPoint property.
For example, to add a new item, do as follows:
getCheckPoint().add(newItem);
Objects of the following type(s) are allowed in the list CheckPointType
public boolean isSetCheckPoint()
boolean
public void unsetCheckPoint()
public java.util.List<java.lang.String> getChangeTypes()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set
method for the changeTypes property.
For example, to add a new item, do as follows:
getChangeTypes().add(newItem);
Objects of the following type(s) are allowed in the list String
public boolean isSetChangeTypes()
boolean
public void unsetChangeTypes()
public java.lang.Object get(java.lang.String propName)
get
in class SearchControl
propName
- allowed object is String
Object
public boolean isSet(java.lang.String propName)
isSet
in class SearchControl
boolean
public void set(java.lang.String propName, java.lang.Object value)
set
in class SearchControl
propName
- allowed object is String
value
- allowed object is Object
public void unset(java.lang.String propName)
unset
in class SearchControl
propName
- allowed object is String
public java.lang.String getTypeName()
getTypeName
in class SearchControl
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 SearchControl
propName
- allowed object is String
String
public java.util.ArrayList getSuperTypes()
getSuperTypes
in class SearchControl
ArrayList
public boolean isSubType(java.lang.String superTypeName)
isSubType
in class SearchControl
superTypeName
- allowed object is String
boolean
public static java.util.HashSet getSubTypes()
HashSet
public java.lang.String toString()
toString
in class SearchControl
String