com.ibm.commerce.rest.marketing.handler

Class SegmentHandler

java.lang.Object

com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

com.ibm.commerce.rest.marketing.handler.SegmentHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/segment")
 @Encoded
public class SegmentHandler
extends AbstractResourceHandler

This class provides RESTful services to retrieve the customer segment information

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	RESOURCE_MAPPING_KEY The Constant RESOURCE_MAPPING_KEY.
static java.lang.String	RESOURCE_NAME Resource name for checkout profile.

Fields inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

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 Summary

Constructors

Constructor and Description
SegmentHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	checkIsInSegmentByUserId(java.lang.String storeId, java.lang.String segmentId, java.lang.Long userId, java.lang.String personalizationId, java.lang.String responseFormat) Check whether the given customer(identified by userId or personalizationId) is part of given customer segment store/{storeId}/segment/{segmentId}/isMember
javax.ws.rs.core.Response	getCustomerSegment(java.lang.String storeId, java.lang.String q, java.lang.Long userId, java.lang.String personalizationId, java.lang.String name, int pageNumber, int pageSize, java.lang.String responseFormat) Get Customer segment for store, if q is supplied then it will get customer segment by userId or personalizationId.
javax.ws.rs.core.Response	getCustomerSegmentById(java.lang.String storeId, java.lang.String segmentId, java.lang.String responseFormat) Get customer segment by ID store/{storeId}/segment/{segmentId}
java.lang.String	getResourceName() Get the resource name

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

createMapForProvider, createMapForProvider, generateResponseForEntireDataObject, getMapFromRequest, getStoreId, getUserId, isRequestInPreviewMode, mergeMapsForProvider, prepareAndValidate

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, getExternalResourceName, getFormattedMessage, getFormattedMessageWithLocale, getFormattingGroupName, 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

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

RESOURCE_MAPPING_KEY

public static final java.lang.String RESOURCE_MAPPING_KEY

The Constant RESOURCE_MAPPING_KEY.

See Also:

Constant Field Values

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

Resource name for checkout profile.

See Also:

Constant Field Values

Constructor Detail

SegmentHandler

public SegmentHandler()

Method Detail

getResourceName

public java.lang.String getResourceName()

Get the resource name

Returns:

String

checkIsInSegmentByUserId

@GET
 @Path(value="{segmentId}/isMember")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response checkIsInSegmentByUserId(@PathParam(value="storeId")
                                                                                                                                                                                                            java.lang.String storeId,
                                                                                                                                                                                                            @PathParam(value="segmentId")
                                                                                                                                                                                                            java.lang.String segmentId,
                                                                                                                                                                                                            @QueryParam(value="userId")
                                                                                                                                                                                                            java.lang.Long userId,
                                                                                                                                                                                                            @QueryParam(value="personalizationId")
                                                                                                                                                                                                            java.lang.String personalizationId,
                                                                                                                                                                                                            @QueryParam(value="responseFormat")
                                                                                                                                                                                                            java.lang.String responseFormat)

Check whether the given customer(identified by userId or personalizationId) is part of given customer segment store/{storeId}/segment/{segmentId}/isMember

Parameters:

storeId - the store ID.

segmentId - the segment ID.

userId - the user ID.

personalizationId - the personalization ID.

responseFormat - the response format.

Returns:

Response

getCustomerSegment

@GET
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response getCustomerSegment(@PathParam(value="storeId")
                                                                                                                                                                 java.lang.String storeId,
                                                                                                                                                                 @QueryParam(value="q")
                                                                                                                                                                 java.lang.String q,
                                                                                                                                                                 @QueryParam(value="qUserId")
                                                                                                                                                                 java.lang.Long userId,
                                                                                                                                                                 @QueryParam(value="qPersonalizationId")
                                                                                                                                                                 java.lang.String personalizationId,
                                                                                                                                                                 @QueryParam(value="qName")
                                                                                                                                                                 java.lang.String name,
                                                                                                                                                                 @QueryParam(value="pageNumber")
                                                                                                                                                                 int pageNumber,
                                                                                                                                                                 @QueryParam(value="pageSize")
                                                                                                                                                                 int pageSize,
                                                                                                                                                                 @QueryParam(value="responseFormat")
                                                                                                                                                                 java.lang.String responseFormat)

Get Customer segment for store, if q is supplied then it will get customer segment by userId or personalizationId. store/{storeId}/segment

Parameters:

storeId - the store ID.

q - the query name.

userId - the user ID.

personalizationId - the personalization ID.

name - the name.

pageNumber - the page number.

pageSize - the page size.

responseFormat - the response format.

Returns:

Response

getCustomerSegmentById

@GET
 @Path(value="{segmentId}")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response getCustomerSegmentById(@PathParam(value="storeId")
                                                                                                                                                                                                 java.lang.String storeId,
                                                                                                                                                                                                 @PathParam(value="segmentId")
                                                                                                                                                                                                 java.lang.String segmentId,
                                                                                                                                                                                                 @QueryParam(value="responseFormat")
                                                                                                                                                                                                 java.lang.String responseFormat)

Get customer segment by ID store/{storeId}/segment/{segmentId}

Parameters:

storeId - The store ID.

segmentId - The segment ID.

responseFormat - The response format.

Returns:

Response