PointOfInterestType

```
public interface PointOfInterestType
```
A representation of the model object 'Point Of Interest Type'. Represents an observation about the point of interest of a mobile member or a device within a logical (region, zone, cell, point) tuple or a physical location (specified by either a physical location ID or a physical Cartesian location) -- in general each record of this type is an assertion about the location of the member or device -- note that there may be multiple location information records in effect for a given member or device at any time.
The following features are supported:
See Also:

LocationPackage.getPointOfInterestType()

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`getAltitude()` Returns the value of the 'Altitude' attribute.
`java.lang.String`	`getCellID()` Returns the value of the 'Cell ID' attribute.
`java.util.List`	`getDescription()` Returns the value of the 'Description' containment reference list.
`double`	`getLatitude()` Returns the value of the 'Latitude' attribute.
`double`	`getLongitude()` Returns the value of the 'Longitude' attribute.
`java.lang.String`	`getPointID()` Returns the value of the 'Point ID' attribute.
`PointOfInterestIdentifierType`	`getPointOfInterestIdentifier()` Returns the value of the 'Point Of Interest Identifier' containment reference.
`java.lang.String`	`getPOIType()` Returns the value of the 'POI Type' attribute.
`double`	`getPrecedence()` Returns the value of the 'Precedence' attribute.
`double`	`getRadius()` Returns the value of the 'Radius' attribute.
`java.lang.String`	`getRegionID()` Returns the value of the 'Region ID' attribute.
`java.lang.String`	`getStatus()` Returns the value of the 'Status' attribute.
`java.lang.String`	`getTags()` Returns the value of the 'Tags' attribute.
`UserDataType`	`getUserData()` Returns the value of the 'User Data' containment reference.
`java.lang.String`	`getZoneID()` Returns the value of the 'Zone ID' attribute.
`boolean`	`isSetAltitude()` Returns whether the value of the '`Altitude`' attribute is set.
`boolean`	`isSetLatitude()` Returns whether the value of the '`Latitude`' attribute is set.
`boolean`	`isSetLongitude()` Returns whether the value of the '`Longitude`' attribute is set.
`boolean`	`isSetPrecedence()` Returns whether the value of the '`Precedence`' attribute is set.
`boolean`	`isSetRadius()` Returns whether the value of the '`Radius`' attribute is set.
`void`	`setAltitude(double value)` Sets the value of the '`Altitude`' attribute.
`void`	`setCellID(java.lang.String value)` Sets the value of the '`Cell ID`' attribute.
`void`	`setLatitude(double value)` Sets the value of the '`Latitude`' attribute.
`void`	`setLongitude(double value)` Sets the value of the '`Longitude`' attribute.
`void`	`setPointID(java.lang.String value)` Sets the value of the '`Point ID`' attribute.
`void`	`setPointOfInterestIdentifier(PointOfInterestIdentifierType value)` Sets the value of the '`Point Of Interest Identifier`' containment reference.
`void`	`setPOIType(java.lang.String value)` Sets the value of the '`POI Type`' attribute.
`void`	`setPrecedence(double value)` Sets the value of the '`Precedence`' attribute.
`void`	`setRadius(double value)` Sets the value of the '`Radius`' attribute.
`void`	`setRegionID(java.lang.String value)` Sets the value of the '`Region ID`' attribute.
`void`	`setStatus(java.lang.String value)` Sets the value of the '`Status`' attribute.
`void`	`setTags(java.lang.String value)` Sets the value of the '`Tags`' attribute.
`void`	`setUserData(UserDataType value)` Sets the value of the '`User Data`' containment reference.
`void`	`setZoneID(java.lang.String value)` Sets the value of the '`Zone ID`' attribute.
`void`	`unsetAltitude()` Unsets the value of the '`Altitude`' attribute.
`void`	`unsetLatitude()` Unsets the value of the '`Latitude`' attribute.
`void`	`unsetLongitude()` Unsets the value of the '`Longitude`' attribute.
`void`	`unsetPrecedence()` Unsets the value of the '`Precedence`' attribute.
`void`	`unsetRadius()` Unsets the value of the '`Radius`' attribute.

- Method Detail
  - getPointOfInterestIdentifier
```
PointOfInterestIdentifierType getPointOfInterestIdentifier()
```
    Returns the value of the 'Point Of Interest Identifier' containment reference. Identifier of the point of interest. This should be a unique value generated by the application.
    
    Returns:
    
    the value of the 'Point Of Interest Identifier' containment reference.
    
    See Also:
    
    setPointOfInterestIdentifier(PointOfInterestIdentifierType), LocationPackage.getPointOfInterestType_PointOfInterestIdentifier()
  - setPointOfInterestIdentifier
```
void setPointOfInterestIdentifier(PointOfInterestIdentifierType value)
```
    Sets the value of the 'Point Of Interest Identifier' containment reference.
    
    Parameters:
    
    value - the new value of the 'Point Of Interest Identifier' containment reference.
    
    See Also:
    
    getPointOfInterestIdentifier()
  - getStatus
```
java.lang.String getStatus()
```
    Returns the value of the 'Status' attribute. Status of the point of interest record. For example, this field could be used to distinguish between Active and Expired records.
    
    Returns:
    
    the value of the 'Status' attribute.
    
    See Also:
    
    setStatus(String), LocationPackage.getPointOfInterestType_Status()
  - setStatus
```
void setStatus(java.lang.String value)
```
    Sets the value of the 'Status' attribute.
    
    Parameters:
    
    value - the new value of the 'Status' attribute.
    
    See Also:
    
    getStatus()
  - getPOIType
```
java.lang.String getPOIType()
```
    Returns the value of the 'POI Type' attribute. Part of the point of interest unique identifier. Type (classification) of the point of interest. Specifically, a point of interest representing a physical store will have the type "Store".
    
    Returns:
    
    the value of the 'POI Type' attribute.
    
    See Also:
    
    setPOIType(String), LocationPackage.getPointOfInterestType_POIType()
  - setPOIType
```
void setPOIType(java.lang.String value)
```
    Sets the value of the 'POI Type' attribute.
    
    Parameters:
    
    value - the new value of the 'POI Type' attribute.
    
    See Also:
    
    getPOIType()
  - getRegionID
```
java.lang.String getRegionID()
```
    Returns the value of the 'Region ID' attribute. Part of the point of interest unique identifier. Identifies a region.
    
    Returns:
    
    the value of the 'Region ID' attribute.
    
    See Also:
    
    setRegionID(String), LocationPackage.getPointOfInterestType_RegionID()
  - setRegionID
```
void setRegionID(java.lang.String value)
```
    Sets the value of the 'Region ID' attribute.
    
    Parameters:
    
    value - the new value of the 'Region ID' attribute.
    
    See Also:
    
    getRegionID()
  - getZoneID
```
java.lang.String getZoneID()
```
    Returns the value of the 'Zone ID' attribute. Part of the point of interest unique identifier. Identifies a sub-region within a region, such as a physical store. Specifically, each physical store defined in the WC Store Locator component will have a corresponding point of interest defined in the Location component with a zone ID equal to the physical store's external identifier and the type "Store".
    
    Returns:
    
    the value of the 'Zone ID' attribute.
    
    See Also:
    
    setZoneID(String), LocationPackage.getPointOfInterestType_ZoneID()
  - setZoneID
```
void setZoneID(java.lang.String value)
```
    Sets the value of the 'Zone ID' attribute.
    
    Parameters:
    
    value - the new value of the 'Zone ID' attribute.
    
    See Also:
    
    getZoneID()
  - getCellID
```
java.lang.String getCellID()
```
    Returns the value of the 'Cell ID' attribute. Part of the point of interest unique identifier. Identifies a sub-region within a zone, such as an aisle or department.
    
    Returns:
    
    the value of the 'Cell ID' attribute.
    
    See Also:
    
    setCellID(String), LocationPackage.getPointOfInterestType_CellID()
  - setCellID
```
void setCellID(java.lang.String value)
```
    Sets the value of the 'Cell ID' attribute.
    
    Parameters:
    
    value - the new value of the 'Cell ID' attribute.
    
    See Also:
    
    getCellID()
  - getPointID
```
java.lang.String getPointID()
```
    Returns the value of the 'Point ID' attribute. Part of the point of interest unique identifier. Identifies a point within a cell such as a kiosk or shelf.
    
    Returns:
    
    the value of the 'Point ID' attribute.
    
    See Also:
    
    setPointID(String), LocationPackage.getPointOfInterestType_PointID()
  - setPointID
```
void setPointID(java.lang.String value)
```
    Sets the value of the 'Point ID' attribute.
    
    Parameters:
    
    value - the new value of the 'Point ID' attribute.
    
    See Also:
    
    getPointID()
  - getDescription
```
java.util.List getDescription()
```
    Returns the value of the 'Description' containment reference list. The list contents are of type PointOfInterestDescriptionType. Description of the point of interest.
    
    Returns:
    
    the value of the 'Description' containment reference list.
    
    See Also:
    
    LocationPackage.getPointOfInterestType_Description()
  - getTags
```
java.lang.String getTags()
```
    Returns the value of the 'Tags' attribute. Reserved for IBM internal use.
    
    Returns:
    
    the value of the 'Tags' attribute.
    
    See Also:
    
    setTags(String), LocationPackage.getPointOfInterestType_Tags()
  - setTags
```
void setTags(java.lang.String value)
```
    Sets the value of the 'Tags' attribute.
    
    Parameters:
    
    value - the new value of the 'Tags' attribute.
    
    See Also:
    
    getTags()
  - getLatitude
```
double getLatitude()
```
    Returns the value of the 'Latitude' attribute. Latitude (in degrees) of the point of interest center.
    
    Returns:
    
    the value of the 'Latitude' attribute.
    
    See Also:
    
    isSetLatitude(), unsetLatitude(), setLatitude(double), LocationPackage.getPointOfInterestType_Latitude()
  - setLatitude
```
void setLatitude(double value)
```
    Sets the value of the 'Latitude' attribute.
    
    Parameters:
    
    value - the new value of the 'Latitude' attribute.
    
    See Also:
    
    isSetLatitude(), unsetLatitude(), getLatitude()
  - unsetLatitude
```
void unsetLatitude()
```
    Unsets the value of the 'Latitude' attribute.
    
    See Also:
    
    isSetLatitude(), getLatitude(), setLatitude(double)
  - isSetLatitude
```
boolean isSetLatitude()
```
    Returns whether the value of the 'Latitude' attribute is set.
    
    Returns:
    
    whether the value of the 'Latitude' attribute is set.
    
    See Also:
    
    unsetLatitude(), getLatitude(), setLatitude(double)
  - getLongitude
```
double getLongitude()
```
    Returns the value of the 'Longitude' attribute. Longitude (in degrees) of the point of interest center.
    
    Returns:
    
    the value of the 'Longitude' attribute.
    
    See Also:
    
    isSetLongitude(), unsetLongitude(), setLongitude(double), LocationPackage.getPointOfInterestType_Longitude()
  - setLongitude
```
void setLongitude(double value)
```
    Sets the value of the 'Longitude' attribute.
    
    Parameters:
    
    value - the new value of the 'Longitude' attribute.
    
    See Also:
    
    isSetLongitude(), unsetLongitude(), getLongitude()
  - unsetLongitude
```
void unsetLongitude()
```
    Unsets the value of the 'Longitude' attribute.
    
    See Also:
    
    isSetLongitude(), getLongitude(), setLongitude(double)
  - isSetLongitude
```
boolean isSetLongitude()
```
    Returns whether the value of the 'Longitude' attribute is set.
    
    Returns:
    
    whether the value of the 'Longitude' attribute is set.
    
    See Also:
    
    unsetLongitude(), getLongitude(), setLongitude(double)
  - getAltitude
```
double getAltitude()
```
    Returns the value of the 'Altitude' attribute. Height (in meters) of the point of interest.
    
    Returns:
    
    the value of the 'Altitude' attribute.
    
    See Also:
    
    isSetAltitude(), unsetAltitude(), setAltitude(double), LocationPackage.getPointOfInterestType_Altitude()
  - setAltitude
```
void setAltitude(double value)
```
    Sets the value of the 'Altitude' attribute.
    
    Parameters:
    
    value - the new value of the 'Altitude' attribute.
    
    See Also:
    
    isSetAltitude(), unsetAltitude(), getAltitude()
  - unsetAltitude
```
void unsetAltitude()
```
    Unsets the value of the 'Altitude' attribute.
    
    See Also:
    
    isSetAltitude(), getAltitude(), setAltitude(double)
  - isSetAltitude
```
boolean isSetAltitude()
```
    Returns whether the value of the 'Altitude' attribute is set.
    
    Returns:
    
    whether the value of the 'Altitude' attribute is set.
    
    See Also:
    
    unsetAltitude(), getAltitude(), setAltitude(double)
  - getRadius
```
double getRadius()
```
    Returns the value of the 'Radius' attribute. Radius (in meters) of the point of interest boundary if it is a circle.
    
    Returns:
    
    the value of the 'Radius' attribute.
    
    See Also:
    
    isSetRadius(), unsetRadius(), setRadius(double), LocationPackage.getPointOfInterestType_Radius()
  - setRadius
```
void setRadius(double value)
```
    Sets the value of the 'Radius' attribute.
    
    Parameters:
    
    value - the new value of the 'Radius' attribute.
    
    See Also:
    
    isSetRadius(), unsetRadius(), getRadius()
  - unsetRadius
```
void unsetRadius()
```
    Unsets the value of the 'Radius' attribute.
    
    See Also:
    
    isSetRadius(), getRadius(), setRadius(double)
  - isSetRadius
```
boolean isSetRadius()
```
    Returns whether the value of the 'Radius' attribute is set.
    
    Returns:
    
    whether the value of the 'Radius' attribute is set.
    
    See Also:
    
    unsetRadius(), getRadius(), setRadius(double)
  - getPrecedence
```
double getPrecedence()
```
    Returns the value of the 'Precedence' attribute. Precedence of the point of interest (used to break ties when converting a physical location to a point of interest).
    
    Returns:
    
    the value of the 'Precedence' attribute.
    
    See Also:
    
    isSetPrecedence(), unsetPrecedence(), setPrecedence(double), LocationPackage.getPointOfInterestType_Precedence()
  - setPrecedence
```
void setPrecedence(double value)
```
    Sets the value of the 'Precedence' attribute.
    
    Parameters:
    
    value - the new value of the 'Precedence' attribute.
    
    See Also:
    
    isSetPrecedence(), unsetPrecedence(), getPrecedence()
  - unsetPrecedence
```
void unsetPrecedence()
```
    Unsets the value of the 'Precedence' attribute.
    
    See Also:
    
    isSetPrecedence(), getPrecedence(), setPrecedence(double)
  - isSetPrecedence
```
boolean isSetPrecedence()
```
    Returns whether the value of the 'Precedence' attribute is set.
    
    Returns:
    
    whether the value of the 'Precedence' attribute is set.
    
    See Also:
    
    unsetPrecedence(), getPrecedence(), setPrecedence(double)
  - getUserData
```
UserDataType getUserData()
```
    Returns the value of the 'User Data' containment reference. The related point of interest customization information.
    
    Returns:
    
    the value of the 'User Data' containment reference.
    
    See Also:
    
    setUserData(UserDataType), LocationPackage.getPointOfInterestType_UserData()
  - setUserData
```
void setUserData(UserDataType value)
```
    Sets the value of the 'User Data' containment reference.
    
    Parameters:
    
    value - the new value of the 'User Data' containment reference.
    
    See Also:
    
    getUserData()

Interface PointOfInterestType

Method Summary

Method Detail

getPointOfInterestIdentifier

setPointOfInterestIdentifier

getStatus

setStatus

getPOIType

setPOIType

getRegionID

setRegionID

getZoneID

setZoneID

getCellID

setCellID

getPointID

setPointID

getDescription

getTags

setTags

getLatitude

setLatitude

unsetLatitude

isSetLatitude

getLongitude

setLongitude

unsetLongitude

isSetLongitude

getAltitude

setAltitude

unsetAltitude

isSetAltitude

getRadius

setRadius

unsetRadius

isSetRadius

getPrecedence

setPrecedence

unsetPrecedence

isSetPrecedence

getUserData

setUserData