Package com.ibm.wsspi.security.wim.model

Class PageResponseControl

java.lang.Object
com.ibm.wsspi.security.wim.model.Control
com.ibm.wsspi.security.wim.model.PageResponseControl
public class PageResponseControl extends Control

Java class for PageResponseControl complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="PageResponseControl">
 <complexContent>
 <extension base="{http://www.ibm.com/websphere/wim}Control">
 <attribute name="cookie" type="{http://www.w3.org/2001/XMLSchema}hexBinary" />
 <attribute name="totalSize" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
 </extension>
 </complexContent>
 </complexType>

The PageResponseControl object extends the Control object, and defines two properties:

  • cookie: contains the cookie to be used for the subsequent calls in a paging search.
  • totalSize: indicates the totalSize of the paging search.

  • Constructor Details

    • PageResponseControl

      public PageResponseControl()

  • Method Details

    • getTotalSize

      public int getTotalSize()
      Gets the value of the totalSize property.
      Returns:
      possible object is Integer

    • setTotalSize

      public void setTotalSize(int value)
      Sets the value of the totalSize property.
      Parameters:
      value - allowed object is Integer

    • isSetTotalSize

      public boolean isSetTotalSize()

    • unsetTotalSize

      public void unsetTotalSize()

    • get

      public Object get(String propName)
      Description copied from class: Control
      Gets the value of the requested property
      Overrides:
      get in class Control
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is Object

    • isSet

      public boolean isSet(String propName)
      Description copied from class: Control
      Returns true if the requested property is set; false, otherwise.
      Overrides:
      isSet in class Control
      Returns:
      returned object is boolean

    • set

      public void set(String propName, Object value)
      Description copied from class: Control
      Sets the value of the provided property to the provided value.
      Overrides:
      set in class Control
      Parameters:
      propName - allowed object is String
      value - allowed object is Object

    • unset

      public void unset(String propName)
      Description copied from class: Control
      Sets the value of provided property to null.
      Overrides:
      unset in class Control
      Parameters:
      propName - allowed object is String

    • getTypeName

      public String getTypeName()
      Description copied from class: Control
      Gets the name of this model object, Control
      Overrides:
      getTypeName in class Control
      Returns:
      returned object is String

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)

    • getDataType

      public String getDataType(String propName)
      Description copied from class: Control
      Gets the Java type of the value of the provided property. For example: String, List
      Overrides:
      getDataType in class Control
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is String

    • getSuperTypes

      public ArrayList getSuperTypes()
      Description copied from class: Control
      Gets a list of any model objects which this model object, Control, is an extension of.
      Overrides:
      getSuperTypes in class Control
      Returns:
      returned object is ArrayList

    • isSubType

      public boolean isSubType(String superTypeName)
      Description copied from class: Control
      Returns a true if the provided model object is one that this model object extends; false, otherwise.
      Overrides:
      isSubType in class Control
      Parameters:
      superTypeName - allowed object is String
      Returns:
      returned object is boolean

    • getSubTypes

      public static HashSet getSubTypes()

    • toString

      public String toString()
      Description copied from class: Control
      Returns this model object, Control, and its contents as a String
      Overrides:
      toString in class Control
      Returns:
      returned object is String