com.microstrategy.usher

Class OrgConfigEntity.LocationConditionEntity

java.lang.Object

com.microstrategy.usher.OrgConfigEntity.LocationConditionEntity

Enclosing class:

OrgConfigEntity

public abstract static class OrgConfigEntity.LocationConditionEntity
extends java.lang.Object

The OrgConfigEntity.LocationConditionEntity abstract class includes various attributes about the badge enablement geo-fences associated with the badge. If a badge resides within a badge enablement geo-fence, then the user's badge will be disabled. This class includes various properties such as latitude, longitude, and radius of a badge enablement geo-fence.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNIT_FEET Feet.
static java.lang.String	UNIT_KILOMETER Kilometers.
static java.lang.String	UNIT_METER Meters.
static java.lang.String	UNIT_MILE Miles.

Method Summary

Modifier and Type	Method and Description
double	distanceInMeters(double lat1, double lon1) Returns a double of the distance in meters between the given latitude and longitude parameters and the ones associated with the OrgConfigEntity.LocationConditionEntity object.
abstract double	latitude() Returns a double of the latitudinal coordinate of the badge enablement geo-fence.
abstract int	length() Returns an int of the radius of the badge enablement geo-fence in the alternate unit.
abstract double	longitude() Returns a double of the longitudinal coordinate of the badge enablement geo-fence.
abstract java.lang.String	name() Returns a String of the name of the badge enablement geo-fence.
abstract float	radiusInMeter() Returns a float of the radius of the badge enablement geo-fence in meters.
abstract java.lang.String	unit() Returns a String of the alternate unit of the radius of the badge enablement geo-fence.
boolean	withInRange(double distanceInMeters) Returns a boolean that represents whether or not a distance is within the bounds of the radius.
boolean	withInRange(double lat1, double lon1) Returns a boolean that represents whether or not a specific latitudinal/longitudinal coordinate is within the range of a badge enablement geo-fence.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNIT_METER

public static final java.lang.String UNIT_METER

Meters. Value is "m".

See Also:

Constant Field Values

UNIT_KILOMETER

public static final java.lang.String UNIT_KILOMETER

Kilometers. Value is "km".

See Also:

Constant Field Values

UNIT_MILE

public static final java.lang.String UNIT_MILE

Miles. Value is "mi".

See Also:

Constant Field Values

UNIT_FEET

public static final java.lang.String UNIT_FEET

Feet. Value is "ft".

See Also:

Constant Field Values

Method Detail

withInRange

public boolean withInRange(double lat1,
                           double lon1)

Returns a boolean that represents whether or not a specific latitudinal/longitudinal coordinate is within the range of a badge enablement geo-fence.

Parameters:

lat1 - the latitudinal coordinate

lon1 - the longitudinal coordinate

Returns:

true if the latitudinal/longitudinal coordinate is within range of a badge enablement geo-fence; false otherwise.

withInRange

public boolean withInRange(double distanceInMeters)

Returns a boolean that represents whether or not a distance is within the bounds of the radius.

Parameters:

distanceInMeters - the distance in meters

Returns:

true if the distance in meters is less than the radius of the badge enablement geo-fence; false otherwise.

distanceInMeters

public double distanceInMeters(double lat1,
                               double lon1)

Returns a double of the distance in meters between the given latitude and longitude parameters and the ones associated with the OrgConfigEntity.LocationConditionEntity object.

Parameters:

lat1 - the given latitudinal coordinate

lon1 - the given longitudinal coordinate

Returns:

the distance in meters between the given longitude and longitude and the ones associated with the OrgConfigEntity.LocationConditionEntity object.

latitude

public abstract double latitude()

Returns a double of the latitudinal coordinate of the badge enablement geo-fence.

Returns:

the latitudinal coordinate of the badge enablement geo-fence.

name

public abstract java.lang.String name()

Returns a String of the name of the badge enablement geo-fence.

Returns:

the name of the badge enablement geo-fence.

radiusInMeter

public abstract float radiusInMeter()

Returns a float of the radius of the badge enablement geo-fence in meters.

Returns:

the radius of the badge enablement geo-fence in meters.

unit

public abstract java.lang.String unit()

Returns a String of the alternate unit of the radius of the badge enablement geo-fence.

Returns:

the alternate unit of the radius of the badge enablement geo-fence.

length

public abstract int length()

Returns an int of the radius of the badge enablement geo-fence in the alternate unit. See unit().

Returns:

the radius of the badge enablement geo-fence in the alternate unit.

longitude

public abstract double longitude()

Returns a double of the longitudinal coordinate of the badge enablement geo-fence.

Returns:

the longitudinal coordinate of the badge enablement geo-fence.