Field Detail

• CREATE_ACTION_CODE

  public static final java.lang.String CREATE_ACTION_CODE
  

  The create action code.

  See Also:

  Constant Field Values

• EXPRESSION_LANGUAGE

  protected static final java.lang.String EXPRESSION_LANGUAGE
  

  The expression language

  See Also:

  Constant Field Values

Constructor Detail

• LocationFacadeClientExtended

  public LocationFacadeClientExtended()
  

  Creates an instance of the client to communicate with the Location facade.

• LocationFacadeClientExtended

  public LocationFacadeClientExtended(BusinessContextType businessContext,
                              javax.security.auth.callback.CallbackHandler callbackHandler)
  

  Creates an instance of the client to communicate with the Location facade.

  Parameters:

  businessContext - The default business context to associate with the messages when making requests.

  callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.

Method Detail

• getPointsOfInterestByProximity

  public ShowPointOfInterestDataAreaType getPointsOfInterestByProximity(java.lang.String storeId,
                                                               java.lang.String poiType,
                                                               double latitude,
                                                               double longitude,
                                                               double radius,
                                                               java.lang.String dataLanguageIds,
                                                               java.lang.String accessProfile)
                                                                 throws PointOfInterestException
  

  This method returns a list of all PointOfInterestType data objects which are associated with a given store ID and have a give type ("poiType"), which are within a given radius of a given reference point, expressed as (latitude,longitude) pair. This form of the method returns a ShowPointOfInterestDataAreaType data object -- callers can retrieve the matching PointOfInterestType nouns by calling the getPointOfInterest() method to extract a list containing the matching PointOfInterestType data objects.

  Parameters:

  storeId - Identifier of the store across which all points of interest are searched.

  poiType - Type ("poiType") of the points of interest to be returned, e.g. "store" -- if this value is null, points of interest of any type are considered.

  latitude - The latitude of the reference point, expressed in degrees.

  longitude - The longitude of the reference point, expressed in degrees.

  radius - The radius within which PointOfInterestType nouns should be searched, expressed in meters (e.g. "within 5000 m") -- if this value is zero or less, the nearest point of interest is returned, regardless of its distance to the reference point.

  dataLanguageIds - Comma seperated list of language IDs indicating the language(s) for which the PointOfInterestDescriptionType children of the Description member of each returned PointOfInterestType data object are to be populated.

  accessProfile - The access profile (e.g. "IBM_All")

  Returns:

  A ShowPointOfInterestDataAreaType data object -- callers may invoke the getPointOfInterest() method to extract a list containing the matching PointOfInterestType data objects.

  Throws:

  PointOfInterestException - The PointOfInterestException is thrown if error information is found in the specified ShowPointOfInterestDataArea -- this will represent that there was a problem when performing the operation.

• getPointsOfInterestByProximity

  public java.util.List getPointsOfInterestByProximity(java.util.Map<java.lang.String,java.lang.String[]> parameters)
                                                throws PointOfInterestException
  

  Convenience method for retrieving PointOfInterest nouns given a parameter map.

  Parameters:

  parameters - Map of parameters. The following parameters are valid:

  • storeId (required)
  • poiType (required)
  • latitude (required)
  • longitude (required)
  • radius
  • dataLanguageIds
  • accessProfile

  Note that although all parameters are passed in as Strings, latitude, longitude, and radius will be converted to Doubles (or an exception will be thrown if they cannot be converted).

  Returns:

  A ShowPointOfInterestDataAreaType data object -- callers may invoke the getPointOfInterest() method to extract a list containing the matching PointOfInterestType data objects.

  Throws:

  PointOfInterestException - The PointOfInterestException is thrown if error information is found in the specified ShowPointOfInterestDataArea. This will represent that there was a problem when performing the operation.

• buildExpressionWithGeolocation

  protected ExpressionType buildExpressionWithGeolocation(java.lang.String dataLanguageIds,
                                              java.lang.String accessProfile,
                                              java.lang.String storeId,
                                              java.lang.String poiType,
                                              java.lang.String latitude,
                                              java.lang.String longitude,
                                              java.lang.String radius)
  

  This method creates a SelectionCriteriaHelper object with the provided XPath expression and access profile. This method can be overridden to add additional control parameters to the expression.

  Parameters:

  dataLanguageIds - The language IDs to be carried in the xpath. This parameter is prepended to the xpath query as _wcf.dataLanguageIds='-1'

  accessProfile - The access profile of the request (e.g. IBM_All, IBM_Details, etc.). This parameter is prepended to the xpath query as _wcf.ap=IBM_All.

  storeId - The store Id.

  poiType - The POI type (e.g. "Store")

  latitude - The latitude, in degrees

  longitude - The longitude, in degrees

  radius - The radius, in meters

  Returns:

  the ExpressionType with the provided XPath expression and access profile.

• buildExpressionWithGeolocation

  public ExpressionType buildExpressionWithGeolocation(java.util.Map parameters)
  

  This method creates a SelectionCriteriaHelper object with the provided XPath expression and access profile. This method can be overridden to add additional control parameters to the expression.

  Parameters:

  parameters - A map contains the parameter to build the expression. The following sample code demonstrates how to use the API:

              Map parameters = new HashMap();
              parameters.put("storeId", new String[] { "10101" });
              parameters.put("poiType", new String[] { "Store" });
              parameters.put("latitude", new String[] { "43.67300"});
        parameters.put("longitude", new String[] { "-79.55400"});
        parameters.put("radius", new String[] { "8000"});
   
  

  Returns:

  the ExpressionType with the provided XPath expression and access profile.

• createClientLocation

  public java.util.Map createClientLocation(java.util.Map parameters)
                                     throws ClientLocationException
  

  Creates a client location based on the input parameters

  Parameters:

  parameters - The map of String [] corresponding to the input parameters. By default there are no input parameters.

  Returns:

  A map of String [] that contains the following response parameters: clientLocationId
  The following sample code demonstrates how to use the API:

                  Map parameters = new HashMap();
                  parameters.put("programId", new String[] { "test" });
                  parameters.put("status", new String[] { "shopping");
                  parameters.put("clientType", new String[] { "user" });
                  parameters.put("clientId", new String[] { "10001" });
        parameters.put("personalizationId", new String[] { "1234567890-1" });
                  parameters.put("sourceType", new String[] { "RFID_sensor");
                  parameters.put("regionId", new String[] { "Canada" });
                  parameters.put("zoneId", new String[] { "Safeway.1951" });
                  parameters.put("latitude", new String[] { "43.67300"});
        parameters.put("longitude", new String[] { "-79.55400"});
   
              Map response = client.createClientLocation(parameters);
                  String[] clientLocationId = (String[]) response.get("clientLocationId");
   
  

  Throws:

  ClientLocationException

• populateClientLocationResponse

  protected void populateClientLocationResponse(java.util.Map response,
                                    ClientLocationType clientLocation)
  

  Puts the following information in the response Map if they are available in the input ClientLocationType:

  • clientLocationId: /ClientLocation/clientLocationID

  Parameters:

  response - the Map of String[] to hold the response name value pairs.

  clientLocation - the ClientLocationType object which contains the input data.

• buildClientLocation

  protected ClientLocationType buildClientLocation(java.util.Map inpurtParameters)
                                            throws ClientLocationException
  

  Builds the ClientLocationType object based on the information found in the specified parameters.

  Parameters:

  inpurtParameters - The parameters to be used to construct the appropriate client location object.

  Returns:

  The client location that is represented by the specified parameters.

  Throws:

  ClientLocationException - if an error occurs

• buildClientLocationUserData

  protected ClientLocationType buildClientLocationUserData(ClientLocationType clientLocation,
                                               java.util.Map parameters)
                                                    throws ClientLocationException
  

  Builds the UserData of ClientLocationType object based on the information found in the specified parameters.

  Parameters:

  clientLocation - The ClientLocationType object.

  parameters - The parameters contains the UserData information. The key of parameters map for UserData should match the name of the logicalPropertyName of userDataProperty in

  wc-business-object-mediator.xml

  for ClientLocationType.

  Returns:

  The client location that is represented by the specified parameters.

  Throws:

  ClientLocationException - if an error occurs

• buildClientLocationBase

  protected ClientLocationType buildClientLocationBase(java.util.Map parameters)
                                                throws ClientLocationException
  

  Builds the ClientLocationType object based on the information found in the specified parameters. No UserData will be populated by this method. The key-value pair being processed will be removed from the map of the parameters.

  Parameters:

  parameters - The parameters to be used to construct the appropriate client location object.

  Returns:

  The client location that is represented by the specified parameters.

  Throws:

  ClientLocationException - if an error occurs

• processClientLocation

  protected ClientLocationType processClientLocation(java.lang.String actionCode,
                                         ClientLocationType clientLocation)
                                              throws ClientLocationException
  

  Processes a client location.

  Parameters:

  actionCode - The action being executed, for example "Create"

  clientLocation - Contains data related to the client location being processed

  Returns:

  The response ClientLocationType object.

  Throws:

  ClientLocationException

• resolveParameter

  protected java.lang.String[] resolveParameter(java.util.Map parameters,
                                    java.lang.String key)
                                         throws ClientLocationException
  

  This method resolves parameters from the input Map.

  Parameters:

  parameters - Map

  key - Parameter name

  Returns:

  String Array of the parameters.

  Throws:

  ClientLocationException