@Path(value="store/{storeId}/spot") @Encoded public class SpotHandler extends AbstractResourceHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice.
|
static java.lang.String |
FORMAT_GROUP_NAME
The constant FORMAT_GROUP_NAME.
|
static java.lang.String |
QUERY_FIND_BY_TYPE
The query name to search for all spots of a given type.
|
static java.lang.String |
QUERY_FIND_BY_TYPE_AND_NAME
The query name to search for the spot with the given type and name.
|
static java.lang.String |
RESOURCE_MAPPING_KEY
The Constant RESOURCE_MAPPING_KEY.
|
static java.lang.String |
RESOURCE_NAME
The Constant RESOURCE_NAME.
|
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 |
---|
SpotHandler()
Constructor for this.
|
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
findSpotByID(java.lang.String storeId,
int spotId,
java.lang.String responseFormat,
int pageNumber,
int pageSize)
This method returns the spot details for the specified store.
|
javax.ws.rs.core.Response |
findSpotsByQuery(java.lang.String storeId,
java.lang.String query,
java.lang.String responseFormat)
This method returns the spot details for the specified store.
|
java.lang.String |
getFormattingGroupName()
Returns the spot formatting group name.
|
SpotHelper |
getHelper()
This method returns the BOD helper associated with the spot resource.
|
java.lang.String |
getResourceName()
Returns the spot resource name.
|
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 RESOURCE_NAME
public static final java.lang.String RESOURCE_MAPPING_KEY
public static final java.lang.String FORMAT_GROUP_NAME
public static final java.lang.String QUERY_FIND_BY_TYPE
public static final java.lang.String QUERY_FIND_BY_TYPE_AND_NAME
public java.lang.String getResourceName()
RESOURCE_NAME
.
This value will not be null or empty.IResourceHandler.getResourceName()
public java.lang.String getFormattingGroupName()
getFormattingGroupName
in interface IResourceHandler
getFormattingGroupName
in class AbstractBaseResourceHandler
FORMAT_GROUP_NAME
. This value will not be null or empty.IResourceHandler.getFormattingGroupName()
public SpotHelper getHelper()
SpotHelper
for
customization.@GET public javax.ws.rs.core.Response findSpotsByQuery(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="q") java.lang.String query, @QueryParam(value="responseFormat") java.lang.String responseFormat)
storeId
- The store identifier, this is a mandatory parameter and cannot
be null or empty.query
- The name of the search query to perform. Must be either
QUERY_FIND_BY_TYPE
or
QUERY_FIND_BY_TYPE_AND_NAME
. This value cannot be
null or empty.responseFormat
- The response format (xml
, json
, or
atom
). This value cannot be null or empty.@GET @Path(value="{spotId}") public javax.ws.rs.core.Response findSpotByID(@PathParam(value="storeId") java.lang.String storeId, @PathParam(value="spotId") int spotId, @QueryParam(value="responseFormat") java.lang.String responseFormat, @QueryParam(value="pageNumber") int pageNumber, @QueryParam(value="pageSize") int pageSize)
storeId
- The store identifier, this is a mandatory parameter and cannot
be null or empty.spotId
- The spot identifier, this is a mandatory parameter.responseFormat
- The response format (xml
, json
, or
atom
). This value cannot be null or empty.pageNumber
- The 0-based index of the page of results to retrieve. This
value must be > = 0.pageSize
- The number of results to return per page. This value must be
> = 1.