com.ibm.commerce.location.facade.server.commands

Interface ResolveClientLocationCmd

All Superinterfaces:

com.ibm.commerce.foundation.celadon.common.oagis.CeladonPipelineCmd, com.ibm.websphere.command.Command, java.io.Serializable

All Known Implementing Classes:

ResolveClientLocationCmdImpl

public interface ResolveClientLocationCmd
extends com.ibm.commerce.foundation.celadon.common.oagis.CeladonPipelineCmd

Interface for the ResolveClientLocationCmd command. The Resolve command has two functions.

Noun resolution. The Resolve command attempts to fill in missing information for incoming nouns by resolving them against existing nouns in the data service. For example, an incoming update may only include those fields that need to be updated. Resolve will find the existing noun in the data service (e.g. the one with the matching ClientLocationID) and fill in the non-changed fields so that the mediator layer has the complete noun with which to perform the update.

POI expansion. The Resolve command will match incoming nouns against PointsOfInterest and expand them in case multiple POI are found. For example, a single ClientLocation may match two or more POI; in this case, the Resolve command will return two ClientLocations, one for each of the POI that matched the incoming ClientLocation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static int	POINT_OF_INTEREST_MATCH_ALL_WITHIN_GEOMETRIC_AREA Business logic matching rule that indicates client location nouns match against any point of interest whose geometric area (as determined by its latitude, longitude and radius) intersect the geometric area of the client location (as determined by its latitude, longitude and accuracy)-- use of this matching rule means that the location of a client may be reported against multiple points of interest simultaneously.
static int	POINT_OF_INTEREST_MATCH_BY_HIGHEST_PRECEDENCE_WITHIN_GEOMETRIC_AREA Business logic matching rule that indicates client location nouns match against the single point of interest whose geometric area (as determined by its latitude, longitude and radius) intersects the geometric area of the client location (as determined by its latitude, longitude and accuracy) and which has the highest precedence among all other matching points of interest -- use of this matching rule means that the location of a client will be reported against only one point of interest at a time.
static int	POINT_OF_INTEREST_MATCH_NEAREST_WITHIN_GEOMETRIC_AREA Business logic matching rule that indicates client location nouns match against only the nearest point of interest whose geometric area (as determined by its latitude, longitude and radius) intersect the geometric area of the client location (as determined by its latitude, longitude and accuracy) -- use of this matching rule means that the location of a client will be reported against only one point of interest at a time.

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
boolean	clientLocationsMatch(ClientLocationType locationOne, ClientLocationType locationTwo) Returns true if both locations match (e.g.

Methods inherited from interface com.ibm.commerce.foundation.celadon.common.oagis.CeladonPipelineCmd

getNounsToBeCreated, getNounsToBeDeleted, getNounsToBeUpdated, setNounsToBeCreated, setNounsToBeDeleted, setNounsToBeUpdated

Methods inherited from interface com.ibm.websphere.command.Command

execute, isReadyToCallExecute, reset

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

POINT_OF_INTEREST_MATCH_NEAREST_WITHIN_GEOMETRIC_AREA

static final int POINT_OF_INTEREST_MATCH_NEAREST_WITHIN_GEOMETRIC_AREA

Business logic matching rule that indicates client location nouns match against only the nearest point of interest whose geometric area (as determined by its latitude, longitude and radius) intersect the geometric area of the client location (as determined by its latitude, longitude and accuracy) -- use of this matching rule means that the location of a client will be reported against only one point of interest at a time.

See Also:

Constant Field Values

POINT_OF_INTEREST_MATCH_ALL_WITHIN_GEOMETRIC_AREA

static final int POINT_OF_INTEREST_MATCH_ALL_WITHIN_GEOMETRIC_AREA

Business logic matching rule that indicates client location nouns match against any point of interest whose geometric area (as determined by its latitude, longitude and radius) intersect the geometric area of the client location (as determined by its latitude, longitude and accuracy)-- use of this matching rule means that the location of a client may be reported against multiple points of interest simultaneously.

See Also:

Constant Field Values

POINT_OF_INTEREST_MATCH_BY_HIGHEST_PRECEDENCE_WITHIN_GEOMETRIC_AREA

static final int POINT_OF_INTEREST_MATCH_BY_HIGHEST_PRECEDENCE_WITHIN_GEOMETRIC_AREA

Business logic matching rule that indicates client location nouns match against the single point of interest whose geometric area (as determined by its latitude, longitude and radius) intersects the geometric area of the client location (as determined by its latitude, longitude and accuracy) and which has the highest precedence among all other matching points of interest -- use of this matching rule means that the location of a client will be reported against only one point of interest at a time.

See Also:

Constant Field Values

Method Detail

clientLocationsMatch

boolean clientLocationsMatch(ClientLocationType locationOne,
                             ClientLocationType locationTwo)

Returns true if both locations match (e.g. they have the same ClientID, StoreID, SourceType)

Parameters:

locationOne - The first location

locationTwo - The second location

Returns:

True if the locations match, false otherwise