Method Detail

• getClientLocationID

  java.lang.String getClientLocationID()
  

  Returns the value of the 'Client Location ID' attribute. Internal identifier of the client location record.

  Returns:

  the value of the 'Client Location ID' attribute.

  See Also:

  setClientLocationID(String), LocationPackage.getClientLocationType_ClientLocationID()

• setClientLocationID

  void setClientLocationID(java.lang.String value)
  

  Sets the value of the 'Client Location ID' attribute.

  Parameters:

  value - the new value of the 'Client Location ID' attribute.

  See Also:

  getClientLocationID()

• getProgramID

  java.lang.String getProgramID()
  

  Returns the value of the 'Program ID' attribute. Identifies the program using the Location component.

  Returns:

  the value of the 'Program ID' attribute.

  See Also:

  setProgramID(String), LocationPackage.getClientLocationType_ProgramID()

• setProgramID

  void setProgramID(java.lang.String value)
  

  Sets the value of the 'Program ID' attribute.

  Parameters:

  value - the new value of the 'Program ID' attribute.

  See Also:

  getProgramID()

• getStatus

  java.lang.String getStatus()
  

  Returns the value of the 'Status' attribute. Status of the EntityLocation 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.getClientLocationType_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()

• getClientType

  java.lang.String getClientType()
  

  Returns the value of the 'Client Type' attribute. The type of the entity to which this location corresponds. Used to figure out which database to look up the entity's record in. For example, EntityType could be the database table and EntityID could be the primary key. Or, EntityType could be the noun (e.g. "CustomerType") in a data service.

  Returns:

  the value of the 'Client Type' attribute.

  See Also:

  setClientType(String), LocationPackage.getClientLocationType_ClientType()

• setClientType

  void setClientType(java.lang.String value)
  

  Sets the value of the 'Client Type' attribute.

  Parameters:

  value - the new value of the 'Client Type' attribute.

  See Also:

  getClientType()

• getSourceType

  java.lang.String getSourceType()
  

  Returns the value of the 'Source Type' attribute. Type (classification) of the client location source. Specifically, the client location records reported by a mobile device's GPS will have the source type "GPS".

  Returns:

  the value of the 'Source Type' attribute.

  See Also:

  setSourceType(String), LocationPackage.getClientLocationType_SourceType()

• setSourceType

  void setSourceType(java.lang.String value)
  

  Sets the value of the 'Source Type' attribute.

  Parameters:

  value - the new value of the 'Source Type' attribute.

  See Also:

  getSourceType()

• getSourceID

  java.lang.String getSourceID()
  

  Returns the value of the 'Source ID' attribute. Identifies the location source.

  Returns:

  the value of the 'Source ID' attribute.

  See Also:

  setSourceID(String), LocationPackage.getClientLocationType_SourceID()

• setSourceID

  void setSourceID(java.lang.String value)
  

  Sets the value of the 'Source ID' attribute.

  Parameters:

  value - the new value of the 'Source ID' attribute.

  See Also:

  getSourceID()

• getDeviceID

  java.lang.String getDeviceID()
  

  Returns the value of the 'Device ID' attribute. Identifies the device associated with the location record.

  Returns:

  the value of the 'Device ID' attribute.

  See Also:

  setDeviceID(String), LocationPackage.getClientLocationType_DeviceID()

• setDeviceID

  void setDeviceID(java.lang.String value)
  

  Sets the value of the 'Device ID' attribute.

  Parameters:

  value - the new value of the 'Device ID' attribute.

  See Also:

  getDeviceID()

• getClientID

  java.lang.String getClientID()
  

  Returns the value of the 'Client ID' attribute. Identifies the entity associated with the location record. Specifically, the location records of a WebSphere Commerce mobile shopper will have an entity ID equal to the shopper's WebSphere Commerce user ID.

  Returns:

  the value of the 'Client ID' attribute.

  See Also:

  setClientID(String), LocationPackage.getClientLocationType_ClientID()

• setClientID

  void setClientID(java.lang.String value)
  

  Sets the value of the 'Client ID' attribute.

  Parameters:

  value - the new value of the 'Client ID' attribute.

  See Also:

  getClientID()

• getPersonalizationID

  java.lang.String getPersonalizationID()
  

  Returns the value of the 'Personalization ID' attribute. Additional identification of the client/user. Specifically, the user location records of a WebSphere Commerce mobile shopper will have a personalization ID equal to the shopper's WebSphere Commerce personalization ID.

  Returns:

  the value of the 'Personalization ID' attribute.

  See Also:

  setPersonalizationID(String), LocationPackage.getClientLocationType_PersonalizationID()

• setPersonalizationID

  void setPersonalizationID(java.lang.String value)
  

  Sets the value of the 'Personalization ID' attribute.

  Parameters:

  value - the new value of the 'Personalization ID' attribute.

  See Also:

  getPersonalizationID()

• getLatitude

  double getLatitude()
  

  Returns the value of the 'Latitude' attribute. Latitude (in degrees) of the client's physical location.

  Returns:

  the value of the 'Latitude' attribute.

  See Also:

  isSetLatitude(), unsetLatitude(), setLatitude(double), LocationPackage.getClientLocationType_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 client's physical location.

  Returns:

  the value of the 'Longitude' attribute.

  See Also:

  isSetLongitude(), unsetLongitude(), setLongitude(double), LocationPackage.getClientLocationType_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 client's physical location.

  Returns:

  the value of the 'Altitude' attribute.

  See Also:

  isSetAltitude(), unsetAltitude(), setAltitude(double), LocationPackage.getClientLocationType_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)

• getAccuracy

  double getAccuracy()
  

  Returns the value of the 'Accuracy' attribute. Horizontal accuracy (in meters) of the client's physical location.

  Returns:

  the value of the 'Accuracy' attribute.

  See Also:

  isSetAccuracy(), unsetAccuracy(), setAccuracy(double), LocationPackage.getClientLocationType_Accuracy()

• setAccuracy

  void setAccuracy(double value)
  

  Sets the value of the 'Accuracy' attribute.

  Parameters:

  value - the new value of the 'Accuracy' attribute.

  See Also:

  isSetAccuracy(), unsetAccuracy(), getAccuracy()

• unsetAccuracy

  void unsetAccuracy()
  

  Unsets the value of the 'Accuracy' attribute.

  See Also:

  isSetAccuracy(), getAccuracy(), setAccuracy(double)

• isSetAccuracy

  boolean isSetAccuracy()
  

  Returns whether the value of the 'Accuracy' attribute is set.

  Returns:

  whether the value of the 'Accuracy' attribute is set.

  See Also:

  unsetAccuracy(), getAccuracy(), setAccuracy(double)

• getAltitudeAccuracy

  double getAltitudeAccuracy()
  

  Returns the value of the 'Altitude Accuracy' attribute. Vertical accuracy (in meters) of the client's physical location.

  Returns:

  the value of the 'Altitude Accuracy' attribute.

  See Also:

  isSetAltitudeAccuracy(), unsetAltitudeAccuracy(), setAltitudeAccuracy(double), LocationPackage.getClientLocationType_AltitudeAccuracy()

• setAltitudeAccuracy

  void setAltitudeAccuracy(double value)
  

  Sets the value of the 'Altitude Accuracy' attribute.

  Parameters:

  value - the new value of the 'Altitude Accuracy' attribute.

  See Also:

  isSetAltitudeAccuracy(), unsetAltitudeAccuracy(), getAltitudeAccuracy()

• unsetAltitudeAccuracy

  void unsetAltitudeAccuracy()
  

  Unsets the value of the 'Altitude Accuracy' attribute.

  See Also:

  isSetAltitudeAccuracy(), getAltitudeAccuracy(), setAltitudeAccuracy(double)

• isSetAltitudeAccuracy

  boolean isSetAltitudeAccuracy()
  

  Returns whether the value of the 'Altitude Accuracy' attribute is set.

  Returns:

  whether the value of the 'Altitude Accuracy' attribute is set.

  See Also:

  unsetAltitudeAccuracy(), getAltitudeAccuracy(), setAltitudeAccuracy(double)

• getHeading

  double getHeading()
  

  Returns the value of the 'Heading' attribute. Direction of travel (in degrees) of the client.

  Returns:

  the value of the 'Heading' attribute.

  See Also:

  isSetHeading(), unsetHeading(), setHeading(double), LocationPackage.getClientLocationType_Heading()

• setHeading

  void setHeading(double value)
  

  Sets the value of the 'Heading' attribute.

  Parameters:

  value - the new value of the 'Heading' attribute.

  See Also:

  isSetHeading(), unsetHeading(), getHeading()

• unsetHeading

  void unsetHeading()
  

  Unsets the value of the 'Heading' attribute.

  See Also:

  isSetHeading(), getHeading(), setHeading(double)

• isSetHeading

  boolean isSetHeading()
  

  Returns whether the value of the 'Heading' attribute is set.

  Returns:

  whether the value of the 'Heading' attribute is set.

  See Also:

  unsetHeading(), getHeading(), setHeading(double)

• getSpeed

  double getSpeed()
  

  Returns the value of the 'Speed' attribute. Ground speed (in meters per second) of the client.

  Returns:

  the value of the 'Speed' attribute.

  See Also:

  isSetSpeed(), unsetSpeed(), setSpeed(double), LocationPackage.getClientLocationType_Speed()

• setSpeed

  void setSpeed(double value)
  

  Sets the value of the 'Speed' attribute.

  Parameters:

  value - the new value of the 'Speed' attribute.

  See Also:

  isSetSpeed(), unsetSpeed(), getSpeed()

• unsetSpeed

  void unsetSpeed()
  

  Unsets the value of the 'Speed' attribute.

  See Also:

  isSetSpeed(), getSpeed(), setSpeed(double)

• isSetSpeed

  boolean isSetSpeed()
  

  Returns whether the value of the 'Speed' attribute is set.

  Returns:

  whether the value of the 'Speed' attribute is set.

  See Also:

  unsetSpeed(), getSpeed(), setSpeed(double)

• getPOIType

  java.lang.String getPOIType()
  

  Returns the value of the 'POI Type' attribute. Type (classification) of the client's logical location.

  Returns:

  the value of the 'POI Type' attribute.

  See Also:

  setPOIType(String), LocationPackage.getClientLocationType_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()

• getPointOfInterestID

  java.lang.String getPointOfInterestID()
  

  Returns the value of the 'Point Of Interest ID' attribute. ID of the Location record.

  Returns:

  the value of the 'Point Of Interest ID' attribute.

  See Also:

  setPointOfInterestID(String), LocationPackage.getClientLocationType_PointOfInterestID()

• setPointOfInterestID

  void setPointOfInterestID(java.lang.String value)
  

  Sets the value of the 'Point Of Interest ID' attribute.

  Parameters:

  value - the new value of the 'Point Of Interest ID' attribute.

  See Also:

  getPointOfInterestID()

• getStoreID

  java.lang.String getStoreID()
  

  Returns the value of the 'Store ID' attribute.

  Returns:

  the value of the 'Store ID' attribute.

  See Also:

  setStoreID(String), LocationPackage.getClientLocationType_StoreID()

• setStoreID

  void setStoreID(java.lang.String value)
  

  Sets the value of the 'Store ID' attribute.

  Parameters:

  value - the new value of the 'Store ID' attribute.

  See Also:

  getStoreID()

• getRegionID

  java.lang.String getRegionID()
  

  Returns the value of the 'Region ID' attribute. Region ID of the logical location.

  Returns:

  the value of the 'Region ID' attribute.

  See Also:

  setRegionID(String), LocationPackage.getClientLocationType_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. Zone ID of the logical location.

  Returns:

  the value of the 'Zone ID' attribute.

  See Also:

  setZoneID(String), LocationPackage.getClientLocationType_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. Cell ID of the logical location.

  Returns:

  the value of the 'Cell ID' attribute.

  See Also:

  setCellID(String), LocationPackage.getClientLocationType_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. Point ID of the logical location.

  Returns:

  the value of the 'Point ID' attribute.

  See Also:

  setPointID(String), LocationPackage.getClientLocationType_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()

• getAction

  java.lang.String getAction()
  

  Returns the value of the 'Action' attribute. Intended action when the location record is created. For example, the shopper check-in to a store when this record is created.

  Returns:

  the value of the 'Action' attribute.

  See Also:

  setAction(String), LocationPackage.getClientLocationType_Action()

• setAction

  void setAction(java.lang.String value)
  

  Sets the value of the 'Action' attribute.

  Parameters:

  value - the new value of the 'Action' attribute.

  See Also:

  getAction()

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

• getCreationTime

  java.lang.Object getCreationTime()
  

  Returns the value of the 'Creation Time' attribute. Time at which the location record was created.

  Returns:

  the value of the 'Creation Time' attribute.

  See Also:

  setCreationTime(Object), LocationPackage.getClientLocationType_CreationTime()

• setCreationTime

  void setCreationTime(java.lang.Object value)
  

  Sets the value of the 'Creation Time' attribute.

  Parameters:

  value - the new value of the 'Creation Time' attribute.

  See Also:

  getCreationTime()

• getModificationTime

  java.lang.Object getModificationTime()
  

  Returns the value of the 'Modification Time' attribute. Time at which the location record was last modified.

  Returns:

  the value of the 'Modification Time' attribute.

  See Also:

  setModificationTime(Object), LocationPackage.getClientLocationType_ModificationTime()

• setModificationTime

  void setModificationTime(java.lang.Object value)
  

  Sets the value of the 'Modification Time' attribute.

  Parameters:

  value - the new value of the 'Modification Time' attribute.

  See Also:

  getModificationTime()

• getUserData

  UserDataType getUserData()
  

  Returns the value of the 'User Data' containment reference. The client location customization information.

  Returns:

  the value of the 'User Data' containment reference.

  See Also:

  setUserData(UserDataType), LocationPackage.getClientLocationType_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()