Class ChangeResponseControl
- java.lang.Object
-
- com.ibm.wsspi.security.wim.model.Control
-
- com.ibm.wsspi.security.wim.model.SearchResponseControl
-
- com.ibm.wsspi.security.wim.model.ChangeResponseControl
-
public class ChangeResponseControl extends SearchResponseControl
Java class for ChangeResponseControl complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="ChangeResponseControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}SearchResponseControl"> <sequence> <element name="checkPoint" type="{http://www.ibm.com/websphere/wim}CheckPointType" maxOccurs="unbounded" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>The ChangeResponseControl object extends the SearchResponseControl object and defines a single property: checkPoint.
The ChangeReponseControl data object is returned to the client application with changed entities as the result of a search for changed entities using the ChangeControl data object. This response control also returns the checkpoint to be used during a subsequent search for changed entities.
- checkPoint: defines the checkpoint for repositories configured in VMM. It is a list that contains the repositoryId and the repositoryCheckPoint.
There could be one or more instances of checkPoint in a ChangeResponseControl data object, depending on the number of repositories involved in a search.
-
-
Constructor Summary
Constructors Constructor Description ChangeResponseControl()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Objectget(java.lang.String propName)Gets the value of the requested propertyjava.util.List<CheckPointType>getCheckPoint()Gets the value of the checkPoint property.java.lang.StringgetDataType(java.lang.String propName)Gets the Java type of the value of the provided property.static java.util.ListgetPropertyNames(java.lang.String entityTypeName)Gets a list of all supported properties for this model object, ChangeResponseControlstatic java.util.HashSetgetSubTypes()Gets a set of any model objects which extend this model object, ChangeResponseControljava.util.ArrayListgetSuperTypes()Gets a list of any model objects which this model object, ChangeResponseControl, is an extension of.java.lang.StringgetTypeName()Gets the name of this model object, ChangeResponseControlbooleanisSet(java.lang.String propName)Returns true if the requested property is set; false, otherwise.booleanisSetCheckPoint()Returns true if the checkPoint property is set; false, otherwise.booleanisSubType(java.lang.String superTypeName)Returns a true if the provided model object is one that this model object extends; false, otherwise.voidset(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.java.lang.StringtoString()Returns this model object, ChangeResponseControl, and its contents as a Stringvoidunset(java.lang.String propName)Sets the value of provided property to null.voidunsetCheckPoint()Resets the checkPoint property to null.-
Methods inherited from class com.ibm.wsspi.security.wim.model.SearchResponseControl
isHasMoreResults, isSetHasMoreResults, setHasMoreResults, unsetHasMoreResults
-
-
-
-
Method Detail
-
getCheckPoint
public java.util.List<CheckPointType> getCheckPoint()
Gets the value of the checkPoint property.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
setmethod 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
-
isSetCheckPoint
public boolean isSetCheckPoint()
Returns true if the checkPoint property is set; false, otherwise.- Returns:
- returned object is
boolean
-
unsetCheckPoint
public void unsetCheckPoint()
Resets the checkPoint property to null.
-
get
public java.lang.Object get(java.lang.String propName)
Gets the value of the requested property- Overrides:
getin classSearchResponseControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
Object
-
isSet
public boolean isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.- Overrides:
isSetin classSearchResponseControl- Returns:
- returned object is
boolean
-
set
public void set(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.- Overrides:
setin classSearchResponseControl- Parameters:
propName- allowed object isStringvalue- allowed object isObject
-
unset
public void unset(java.lang.String propName)
Sets the value of provided property to null.- Overrides:
unsetin classSearchResponseControl- Parameters:
propName- allowed object isString
-
getTypeName
public java.lang.String getTypeName()
Gets the name of this model object, ChangeResponseControl- Overrides:
getTypeNamein classSearchResponseControl- Returns:
- returned object is
String
-
getPropertyNames
public static java.util.List getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, ChangeResponseControl- Parameters:
entityTypeName- allowed object isString- Returns:
- returned object is
List
-
getDataType
public java.lang.String getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property. For example: String, List- Overrides:
getDataTypein classSearchResponseControl- Parameters:
propName- allowed object isString- Returns:
- returned object is
String
-
getSuperTypes
public java.util.ArrayList getSuperTypes()
Gets a list of any model objects which this model object, ChangeResponseControl, is an extension of.- Overrides:
getSuperTypesin classSearchResponseControl- Returns:
- returned object is
ArrayList
-
isSubType
public boolean isSubType(java.lang.String superTypeName)
Returns a true if the provided model object is one that this model object extends; false, otherwise.- Overrides:
isSubTypein classSearchResponseControl- Parameters:
superTypeName- allowed object isString- Returns:
- returned object is
boolean
-
getSubTypes
public static java.util.HashSet getSubTypes()
Gets a set of any model objects which extend this model object, ChangeResponseControl- Returns:
- returned object is
HashSet
-
toString
public java.lang.String toString()
Returns this model object, ChangeResponseControl, and its contents as a String- Overrides:
toStringin classSearchResponseControl- Returns:
- returned object is
String
-
-