@Path(value="store/{storeId}/storelocator") public class StoreLocatorHandler extends AbstractResourceHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACCESS_PROFILE_DETAILS_INFORMATION
The Constant ACCESS_PROFILE_DETAILS_INFORMATION.
|
static java.lang.String |
COPYRIGHT
IBM Copyright notice field.
|
static java.lang.String |
FORMAT_GROUP_NAME
The constant FORMAT_GROUP_NAME
|
static java.lang.String |
PARAMETER_BEAUTY_CENTER
beauty center
|
static java.lang.String |
PARAMETER_BEAUTY_CENTER_DESCRIPTION
beauty center description
|
static java.lang.String |
PARAMETER_CITY
city
|
static java.lang.String |
PARAMETER_CITY_DESCRIPTION
city description
|
static java.lang.String |
PARAMETER_COUNTRY
country
|
static java.lang.String |
PARAMETER_COUNTRY_DESCRIPTION
country description
|
static java.lang.String |
PARAMETER_GEO_ID
geo ID
|
static java.lang.String |
PARAMETER_GEO_ID_DESCRIPTION
geo ID description
|
static java.lang.String |
PARAMETER_LATITUDE
latitude
|
static java.lang.String |
PARAMETER_LATITUDE_DESCRIPTION
latitude description
|
static java.lang.String |
PARAMETER_LONGITUDE
longitude
|
static java.lang.String |
PARAMETER_LONGITUDE_DESCRIPTION
longitude description
|
static java.lang.String |
PARAMETER_MAX_ITEMS
maximum items
|
static java.lang.String |
PARAMETER_MAX_ITEMS_DESCRIPTION
maximum item description
|
static java.lang.String |
PARAMETER_PHYSICAL_STORE_IDS
physical store ID list
|
static java.lang.String |
PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION
physical store ID list description
|
static java.lang.String |
PARAMETER_PROV
province
|
static java.lang.String |
PARAMETER_PROV_DESCRIPTION
province description
|
static java.lang.String |
PARAMETER_RADIUS
radius
|
static java.lang.String |
PARAMETER_RADIUS_DESCRIPTION
radius description
|
static java.lang.String |
PARAMETER_RADIUSUOM
radius UOM
|
static java.lang.String |
PARAMETER_RADIUSUOM_DESCRIPTION
radius UOM description
|
static java.lang.String |
PARAMETER_SITE_LEVEL_STORE_SEARCH
site level store search flag
|
static java.lang.String |
PARAMETER_SITE_LEVEL_STORE_SEARCH_DESCRIPTION
site level store search flag description
|
static java.lang.String |
PARAMETER_STATE
state
|
static java.lang.String |
PARAMETER_STATE_DESCRIPTION
state description
|
static java.lang.String |
PARAMETER_TYPE
type
|
static java.lang.String |
PARAMETER_TYPE_DESCRIPTION
type description
|
static java.lang.String |
PARAMETER_UNIQUE_ID
unique ID
|
static java.lang.String |
PARAMETER_UNIQUE_ID_DESCRIPTION
unique ID description
|
static java.lang.String |
RESOURCE_MAPPING_KEY
The Constant RESOURCE_MAPPING_KEY.
|
static java.lang.String |
RESOURCE_NAME
The Constant RESOURCE_NAME.
|
static java.lang.String |
RESPONSE_STORE_LOCATOR_404_DESCRIPTION
store locator 404 return code description
|
APPLICATION_ATOM_XML, APPLICATION_JSON, APPLICATION_XHTML_XML, APPLICATION_XML, CHANGE_VERB, PARAMETER_ACTION, PARAMETER_ACTION_DESCRIPTION, PARAMETER_CATALOG_ID, PARAMETER_CATALOG_ID_DESCRIPTION, PARAMETER_CURRENCY, PARAMETER_CURRENCY_DESCRIPTION, PARAMETER_FOR_USER, PARAMETER_FOR_USER_DESCRIPTION, PARAMETER_FOR_USER_ID, PARAMETER_FOR_USER_ID_DESCRIPTION, PARAMETER_LANG_ID, PARAMETER_LANG_ID_DESCRIPTION, PARAMETER_LOCALE, PARAMETER_LOCALE_DESCRIPTION, PARAMETER_MODE, PARAMETER_MODE_DESCRIPTION, PARAMETER_PAGE_NUMBER, PARAMETER_PAGE_NUMBER_DESCRIPTION, PARAMETER_PAGE_SIZE, PARAMETER_PAGE_SIZE_DESCRIPTION, PARAMETER_PROFILE_NAME, PARAMETER_PROFILE_NAME_DESCRIPTION, PARAMETER_QUERY, PARAMETER_QUERY_DESCRIPTION, PARAMETER_RESET_PASSWORD_DESCRIPTION, PARAMETER_RESPONSE_FORMAT, PARAMETER_RESPONSE_FORMAT_DESCRIPTION, PARAMETER_STORE_ID, PARAMETER_STORE_ID_DESCRIPTION, PARAMETER_WORKSPACE_IDENTIFIER, PARAMETER_WORKSPACE_IDENTIFIER_DESCRIPTION, PARAMETER_WORKSPACE_NAME, PARAMETER_WORKSPACE_NAME_DESCRIPTION, PARAMETER_WORKSPACE_TASK, PARAMETER_WORKSPACE_TASK_DESCRIPTION, PARAMETER_WORKSPACE_TASKGROUP, PARAMETER_WORKSPACE_TASKGROUP_DESCRIPTION, PROCESS_VERB, RESPONSE_200_DESCRIPTION, RESPONSE_201_DESCRIPTION, RESPONSE_204_DESCRIPTION, RESPONSE_400_DESCRIPTION, RESPONSE_401_DESCRIPTION, RESPONSE_403_DESCRIPTION, RESPONSE_404_DESCRIPTION, RESPONSE_500_DESCRIPTION
Constructor and Description |
---|
StoreLocatorHandler() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
findByStoreUniqueId(java.lang.String storeId,
java.lang.String uniqueId,
java.lang.String responseFormat,
int pageNumber,
int pageSize)
This method returns the physical store information by a store unique ID.
|
javax.ws.rs.core.Response |
findByStoreUniqueIds(java.lang.String storeId,
java.util.List<java.lang.String> physicalStoreId,
java.lang.String responseFormat,
int pageNumber,
int pageSize)
This method returns the physical store information by store unique IDs.
|
javax.ws.rs.core.Response |
findGeoNodeByGeoId(java.lang.String storeId,
java.lang.String geoId,
int pageNumber,
int pageSize,
java.lang.String beautyCenter,
java.lang.String type,
java.lang.String responseFormat,
java.lang.String siteLevelStoreSearch)
This method return the physical stores information for specified geo node
unique ID.
|
javax.ws.rs.core.Response |
findGeoNodeByGeoLocation(java.lang.String storeId,
java.lang.String responseFormat,
java.lang.String city,
java.lang.String state,
java.lang.String prov,
java.lang.String country,
java.lang.String radiusUOM,
java.lang.String beautyCenter,
java.lang.String typeval,
java.lang.String radius,
int pageNumber,
int pageSize,
java.lang.String siteLevelStoreSearch)
This method return the physical stores information for specified location
information.
|
javax.ws.rs.core.Response |
findStores(java.lang.String storeId,
java.lang.String latitude,
java.lang.String longitude,
java.lang.String responseFormat,
java.lang.String maxNumOfStores,
java.lang.String radiusUOM,
java.lang.String beautyCenter,
java.lang.String type,
java.lang.String radius,
java.lang.String siteLevelStoreSearch)
This method return the physical stores information for specified
coordinates.
|
java.lang.String |
getFormattingGroupName()
Returns the formatting group name for resolving the struts action of the
formatting JSP.
|
StoreLocatorHelper |
getHelper()
Return the BOD helper associated with the physical store resource.
|
java.lang.String |
getResourceName()
This method returns the name of the resource used primarily to determine
the representation of the resource.
|
createMapForProvider, createMapForProvider, generateResponseForEntireDataObject, getMapFromRequest, getStoreId, getUserId, isRequestInPreviewMode, mergeMapsForProvider, prepareAndValidate
addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, getExternalResourceName, getFormattedMessage, getFormattedMessageWithLocale, getInstrumentor, getIntegerParameterValue, getIntegerParameterValues, getLongParameterValue, getLongParameterValues, getParameterValue, getParameterValue, getParameterValues, getQueryRegistry, getRequest, getResponse, getUriInfo, handleException, initializeActionRegistry, initializeQueryRegistry, performAction, postProcess, preProcess, registerOperationWithMethodSignature, runQuery, staticConvertStreamToString, throwInvalidQueryNameException, throwInvalidQueryNameException, throwRestException, throwRestExceptionIfErrorsAreDetected, validatePageNumberPageSize
public static final java.lang.String COPYRIGHT
public static final java.lang.String ACCESS_PROFILE_DETAILS_INFORMATION
public static final java.lang.String RESOURCE_NAME
public static final java.lang.String RESOURCE_MAPPING_KEY
public static final java.lang.String PARAMETER_CITY
public static final java.lang.String PARAMETER_CITY_DESCRIPTION
public static final java.lang.String PARAMETER_STATE
public static final java.lang.String PARAMETER_STATE_DESCRIPTION
public static final java.lang.String PARAMETER_PROV
public static final java.lang.String PARAMETER_PROV_DESCRIPTION
public static final java.lang.String PARAMETER_COUNTRY
public static final java.lang.String PARAMETER_COUNTRY_DESCRIPTION
public static final java.lang.String PARAMETER_RADIUSUOM
public static final java.lang.String PARAMETER_RADIUSUOM_DESCRIPTION
public static final java.lang.String PARAMETER_BEAUTY_CENTER
public static final java.lang.String PARAMETER_BEAUTY_CENTER_DESCRIPTION
public static final java.lang.String PARAMETER_TYPE
public static final java.lang.String PARAMETER_TYPE_DESCRIPTION
public static final java.lang.String PARAMETER_RADIUS
public static final java.lang.String PARAMETER_RADIUS_DESCRIPTION
public static final java.lang.String PARAMETER_SITE_LEVEL_STORE_SEARCH
public static final java.lang.String PARAMETER_SITE_LEVEL_STORE_SEARCH_DESCRIPTION
public static final java.lang.String PARAMETER_GEO_ID
public static final java.lang.String PARAMETER_GEO_ID_DESCRIPTION
public static final java.lang.String PARAMETER_UNIQUE_ID
public static final java.lang.String PARAMETER_UNIQUE_ID_DESCRIPTION
public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS
public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION
public static final java.lang.String PARAMETER_LATITUDE
public static final java.lang.String PARAMETER_LATITUDE_DESCRIPTION
public static final java.lang.String PARAMETER_LONGITUDE
public static final java.lang.String PARAMETER_LONGITUDE_DESCRIPTION
public static final java.lang.String PARAMETER_MAX_ITEMS
public static final java.lang.String PARAMETER_MAX_ITEMS_DESCRIPTION
public static final java.lang.String FORMAT_GROUP_NAME
public static final java.lang.String RESPONSE_STORE_LOCATOR_404_DESCRIPTION
public java.lang.String getResourceName()
IResourceHandler
public java.lang.String getFormattingGroupName()
AbstractBaseResourceHandler
getFormattingGroupName
in interface IResourceHandler
getFormattingGroupName
in class AbstractBaseResourceHandler
public StoreLocatorHelper getHelper()
@GET @Path(value="byLocation") @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"}) public javax.ws.rs.core.Response findGeoNodeByGeoLocation(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="responseFormat") java.lang.String responseFormat, @QueryParam(value="city") java.lang.String city, @QueryParam(value="state") java.lang.String state, @QueryParam(value="prov") java.lang.String prov, @QueryParam(value="country") java.lang.String country, @QueryParam(value="radiusUOM") java.lang.String radiusUOM, @QueryParam(value="BeautyCenter") java.lang.String beautyCenter, @QueryParam(value="Type") java.lang.String typeval, @QueryParam(value="radius") java.lang.String radius, @QueryParam(value="pageNumber") int pageNumber, @QueryParam(value="pageSize") int pageSize, @QueryParam(value="siteLevelStoreSearch") java.lang.String siteLevelStoreSearch)
storeId
- the store idresponseFormat
- the response formatcity
- the citystate
- the stateprov
- the provincecountry
- the countryradiusUOM
- the radius unit of measurebeautyCenter
- the beauty centertypeval
- the typeradius
- the radiuspageNumber
- the page numberpageSize
- the page sizesiteLevelStoreSearch
- If it is "true", a site level physical search will be performed.
Otherwise, the physical store search will be performed at the web store level. By default, it is "true".@GET @Path(value="byGeoNode/{geoId}") @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"}) public javax.ws.rs.core.Response findGeoNodeByGeoId(@PathParam(value="storeId") java.lang.String storeId, @PathParam(value="geoId") java.lang.String geoId, @QueryParam(value="pageNumber") int pageNumber, @QueryParam(value="pageSize") int pageSize, @QueryParam(value="BeautyCenter") java.lang.String beautyCenter, @QueryParam(value="Type") java.lang.String type, @QueryParam(value="responseFormat") java.lang.String responseFormat, @QueryParam(value="siteLevelStoreSearch") java.lang.String siteLevelStoreSearch)
storeId
- the store idgeoId
- the geo idpageNumber
- the page numberpageSize
- the page sizebeautyCenter
- the beauty centertype
- the typeresponseFormat
- the response formatsiteLevelStoreSearch
- If it is "true", a site level physical search will be performed.
Otherwise, the physical store search will be performed at the web store level. By default, it is "true".@GET @Path(value="byStoreId/{uniqueId}") @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"}) public javax.ws.rs.core.Response findByStoreUniqueId(@PathParam(value="storeId") java.lang.String storeId, @PathParam(value="uniqueId") java.lang.String uniqueId, @QueryParam(value="responseFormat") java.lang.String responseFormat, @QueryParam(value="pageNumber") int pageNumber, @QueryParam(value="pageSize") int pageSize)
storeId
- the store iduniqueId
- the physical store unique idresponseFormat
- the response formatpageNumber
- the page numberpageSize
- the page size@GET @Path(value="byStoreIds") @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"}) public javax.ws.rs.core.Response findByStoreUniqueIds(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="physicalStoreId") java.util.List<java.lang.String> physicalStoreId, @QueryParam(value="responseFormat") java.lang.String responseFormat, @QueryParam(value="pageNumber") int pageNumber, @QueryParam(value="pageSize") int pageSize)
storeId
- the store idphysicalStoreId
- a list of physical store identifiersresponseFormat
- the response formatpageNumber
- the page numberpageSize
- the page size@GET @Path(value="latitude/{latitude}/longitude/{longitude}") @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"}) public javax.ws.rs.core.Response findStores(@PathParam(value="storeId") java.lang.String storeId, @PathParam(value="latitude") java.lang.String latitude, @PathParam(value="longitude") java.lang.String longitude, @QueryParam(value="responseFormat") java.lang.String responseFormat, @QueryParam(value="maxItems") java.lang.String maxNumOfStores, @QueryParam(value="radiusUOM") java.lang.String radiusUOM, @QueryParam(value="BeautyCenter") java.lang.String beautyCenter, @QueryParam(value="Type") java.lang.String type, @QueryParam(value="radius") java.lang.String radius, @QueryParam(value="siteLevelStoreSearch") java.lang.String siteLevelStoreSearch)
storeId
- the store idlatitude
- the latitudelongitude
- the longituderesponseFormat
- the response formatmaxNumOfStores
- the max number of storesradiusUOM
- the radius unit of measurebeautyCenter
- the beauty centertype
- the typeradius
- the radiussiteLevelStoreSearch
- If it is "true", a site level physical search will be performed.
Otherwise, the physical store search will be performed at the web store level. By default, it is "true".