com.ibm.wsspi.security.wim.model

Class 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.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Object get(java.lang.String propName)
      Gets the value of the requested 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, ChangeResponseControl
      static java.util.HashSet getSubTypes()
      Gets a set of any model objects which extend this model object, ChangeResponseControl
      java.util.ArrayList getSuperTypes()
      Gets a list of any model objects which this model object, ChangeResponseControl, is an extension of.
      java.lang.String getTypeName()
      Gets the name of this model object, ChangeResponseControl
      boolean isSet(java.lang.String propName)
      Returns true if the requested 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, ChangeResponseControl, and its contents as a String
      void unset(java.lang.String propName)
      Sets the value of provided property to null.
      void unsetCheckPoint()
      Resets the checkPoint property to null.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ChangeResponseControl

        public ChangeResponseControl()
    • 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 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

      • 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:
        get in class SearchResponseControl
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is Object
      • isSet

        public boolean isSet(java.lang.String propName)
        Returns true if the requested property is set; false, otherwise.
        Overrides:
        isSet in class SearchResponseControl
        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:
        set in class SearchResponseControl
        Parameters:
        propName - allowed object is String
        value - allowed object is Object
      • unset

        public void unset(java.lang.String propName)
        Sets the value of provided property to null.
        Overrides:
        unset in class SearchResponseControl
        Parameters:
        propName - allowed object is String
      • getTypeName

        public java.lang.String getTypeName()
        Gets the name of this model object, ChangeResponseControl
        Overrides:
        getTypeName in class SearchResponseControl
        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 is String
        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:
        getDataType in class SearchResponseControl
        Parameters:
        propName - allowed object is String
        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:
        getSuperTypes in class SearchResponseControl
        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:
        isSubType in class SearchResponseControl
        Parameters:
        superTypeName - allowed object is String
        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:
        toString in class SearchResponseControl
        Returns:
        returned object is String