com.ibm.commerce.location.facade.datatypes

Interface 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 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()

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

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

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

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

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

      • 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()
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method