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

Class PageControl

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

Java class for PageControl complex type.

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

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

The PageControl object extends the Control object, and contains two properties:

  • size: indicates the size of the page.
  • cookie: contains the cookie returned from a PageResponseControl to the server can get the next page to the search. For the first call of a paging search, this property should not be set to any value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PageControl()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    get(String propName)
    Gets the value of the requested property
    String
    getDataType(String propName)
    Gets the Java type of the value of the provided property.
    static List
    getPropertyNames(String entityTypeName)
    Gets a list of all supported properties for this model object, PageControl
    int
    getSize()
    Gets the value of the size property.
    int
    getStartIndex()
    Gets the value of the startIndex property.
    static HashSet
    getSubTypes()
    Gets a set of any model objects which extend this model object, PageControl
    ArrayList
    getSuperTypes()
    Gets a list of any model objects which this model object, PageControl, is an extension of.
    String
    getTypeName()
    Gets the name of this model object, PageControl
    boolean
    isSet(String propName)
    Returns true if the requested property is set; false, otherwise.
    boolean
    isSetSize()
    Returns a true if the size property is set; false, otherwise.
    boolean
    isSetStartIndex()
    Returns a true if the startIndex property is set; false, otherwise.
    boolean
    isSubType(String superTypeName)
    Returns a true if the provided model object is one that this model object extends; false, otherwise.
    void
    set(String propName, Object value)
    Sets the value of the provided property to the provided value.
    void
    setSize(int value)
    Sets the value of the size property.
    void
    setStartIndex(int value)
    Sets the value of the startIndex property.
    String
    toString()
    Returns this model object, PageControl, and its contents as a String
    void
    unset(String propName)
    Sets the value of provided property to null.
    void
    unsetSize()
    Resets the size property to null
    void
    unsetStartIndex()
    Resets the startIndex property to null

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PageControl

      public PageControl()

  • Method Details

    • getSize

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

    • setSize

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

    • isSetSize

      public boolean isSetSize()
      Returns a true if the size property is set; false, otherwise.
      Returns:
      returned object is boolean

    • unsetSize

      public void unsetSize()
      Resets the size property to null

    • getStartIndex

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

    • setStartIndex

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

    • isSetStartIndex

      public boolean isSetStartIndex()
      Returns a true if the startIndex property is set; false, otherwise.
      Returns:
      returned object is boolean

    • unsetStartIndex

      public void unsetStartIndex()
      Resets the startIndex property to null

    • get

      public Object get(String propName)
      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)
      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)
      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)
      Sets the value of provided property to null.
      Overrides:
      unset in class Control
      Parameters:
      propName - allowed object is String

    • getTypeName

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

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)
      Gets a list of all supported properties for this model object, PageControl
      Parameters:
      entityTypeName - allowed object is String
      Returns:
      returned object is List

    • getDataType

      public String getDataType(String propName)
      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()
      Gets a list of any model objects which this model object, PageControl, is an extension of.
      Overrides:
      getSuperTypes in class Control
      Returns:
      returned object is ArrayList

    • isSubType

      public boolean isSubType(String superTypeName)
      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()
      Gets a set of any model objects which extend this model object, PageControl
      Returns:
      returned object is HashSet

    • toString

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