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

Class Locality

java.lang.Object
com.ibm.wsspi.security.wim.model.Entity
com.ibm.wsspi.security.wim.model.GeographicLocation
com.ibm.wsspi.security.wim.model.Locality
public class Locality extends GeographicLocation

Java class for Locality complex type.

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

 <complexType name="Locality">
 <complexContent>
 <extension base="{http://www.ibm.com/websphere/wim}GeographicLocation">
 <sequence>
 <element ref="{http://www.ibm.com/websphere/wim}l" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}localityName" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}st" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}stateOrProvinceName" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}street" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}seeAlso" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}description" maxOccurs="unbounded" minOccurs="0"/>
 </sequence>
 </extension>
 </complexContent>
 </complexType>

The Locality object extends the GeographicLocation object and defines several properties: l, localityName, st, stateOrProvinceName, street and description. This object represents a geographic area.

  • l: a short form for the localityName.
  • localityName: contains the name of a locality, such as a city, county or other geographic region.
  • st: a short form for stateOrProvinceName.
  • stateOrProvinceName: contains the full name of a state or province (stateOrProvinceName).
  • street: contains the physical address of the object to which the entry corresponds, such as an address for package delivery.
  • description: describes this object.

  • Constructor Details

    • Locality

      public Locality()

  • Method Details

    • getL

      public String getL()
      Gets the value of the l property.
      Returns:
      possible object is String

    • setL

      public void setL(String value)
      Sets the value of the l property.
      Parameters:
      value - allowed object is String

    • isSetL

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

    • getLocalityName

      public String getLocalityName()
      Gets the value of the localityName property.
      Returns:
      possible object is String

    • setLocalityName

      public void setLocalityName(String value)
      Sets the value of the localityName property.
      Parameters:
      value - allowed object is String

    • isSetLocalityName

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

    • getSt

      public List<String> getSt()
      Gets the value of the st 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 st property.

      For example, to add a new item, do as follows: 

       getSt().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • isSetSt

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

    • unsetSt

      public void unsetSt()
      Resets the value of the st property to null

    • getStateOrProvinceName

      public List<String> getStateOrProvinceName()
      Gets the value of the stateOrProvinceName 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 stateOrProvinceName property.

      For example, to add a new item, do as follows: 

       getStateOrProvinceName().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • isSetStateOrProvinceName

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

    • unsetStateOrProvinceName

      public void unsetStateOrProvinceName()
      Resets the value of the stateOrProvinceName property to null

    • getStreet

      public List<String> getStreet()
      Gets the value of the street 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 street property.

      For example, to add a new item, do as follows: 

       getStreet().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • isSetStreet

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

    • unsetStreet

      public void unsetStreet()
      Resets the value of the street property to null

    • getSeeAlso

      public List<String> getSeeAlso()
      Gets the value of the seeAlso 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 seeAlso property.

      For example, to add a new item, do as follows: 

       getSeeAlso().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • isSetSeeAlso

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

    • unsetSeeAlso

      public void unsetSeeAlso()
      Resets the value of the seeAlso property to null

    • getDescription

      public List<String> getDescription()
      Gets the value of the description 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 description property.

      For example, to add a new item, do as follows: 

       getDescription().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • isSetDescription

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

    • unsetDescription

      public void unsetDescription()
      Resets the value of the description property to null

    • get

      public Object get(String propName)
      Gets the value of the requested property
      Overrides:
      get in class GeographicLocation
      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 GeographicLocation
      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 GeographicLocation
      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 GeographicLocation
      Parameters:
      propName - allowed object is String

    • getTypeName

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

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)
      Gets a list of all supported properties for this model object, Locality
      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 GeographicLocation
      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, Locality, is an extension of.
      Overrides:
      getSuperTypes in class GeographicLocation
      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 GeographicLocation
      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, Locality
      Returns:
      returned object is HashSet

    • toString

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

    • isMultiValuedProperty

      public boolean isMultiValuedProperty(String propName)
      Description copied from class: Entity
      Return whether the specified property is a multi-valued property and capable of holding multiple values.
      Overrides:
      isMultiValuedProperty in class Entity
      Parameters:
      propName - The property name to check.
      Returns:
      True if the property is multi-value, false otherwise.