com.ibm.commerce.rest.pagelayout.handler

Class PageHandler

java.lang.Object

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

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

com.ibm.commerce.rest.pagelayout.handler.PageHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/page")
public class PageHandler
extends AbstractResourceHandler

A store page. Contains information on the page such as SEO meta data.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

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
PageHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	byCatalogEntryIds(java.lang.String storeId) Finds pages by catalog entry IDs.
javax.ws.rs.core.Response	byCategoryIds(java.lang.String storeId) Finds pages by category IDs.
javax.ws.rs.core.Response	byNames(java.lang.String storeId) Finds pages by their names.
javax.ws.rs.core.Response	byPageIds(java.lang.String storeId) Finds pages by their IDs.
javax.ws.rs.core.Response	byUrlConfigurable(java.lang.String storeId) Finds content pages with or without configurable URLs.
javax.ws.rs.core.Response	findByName(java.lang.String storeId, java.lang.String name) Finds a page by its name.
javax.ws.rs.core.Response	findByPageId(java.lang.String storeId, java.lang.String pageId) Finds a page by its ID.
javax.ws.rs.core.Response	findByQuery(java.lang.String storeId, java.lang.String queryName) Finds pages by a query.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.
void	initializeQueryRegistry(OperationRegistry registry) Initialize the query registry.

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, 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

Constructor Detail

PageHandler

public PageHandler()

Method Detail

getResourceName

public java.lang.String getResourceName()

Description copied from interface: IResourceHandler

This method returns the name of the resource used primarily to determine the representation of the resource. This class can be overridden to change the name of the resource and therefore the representation, while keeping all the methods in this class.

Returns:

the resource name

initializeQueryRegistry

public void initializeQueryRegistry(OperationRegistry registry)

Description copied from class: AbstractBaseResourceHandler

Initialize the query registry. Override this method to register

Overrides:

initializeQueryRegistry in class AbstractBaseResourceHandler

Parameters:

registry - The query registry to initialize.

findByPageId

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

Finds a page by its ID.

Parameters:

storeId - The store ID.

pageId - The page ID.

Returns:

The response.

findByName

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

Finds a page by its name.

Parameters:

storeId - The store ID.

name - The page name.

Returns:

The response.

findByQuery

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

Finds pages by a query. See each query for details on input and output.

Parameters:

storeId - The store ID.

queryName - The query name.

Returns:

The response.

byPageIds

public javax.ws.rs.core.Response byPageIds(@PathParam(value="storeId")
                                           java.lang.String storeId)

Finds pages by their IDs. Invalid page IDs are ignored.

Parameters:

storeId - The store ID.

Returns:

The response.

byNames

public javax.ws.rs.core.Response byNames(@PathParam(value="storeId")
                                         java.lang.String storeId)

Finds pages by their names. Invalid page names are ignored.

Parameters:

storeId - The store ID.

Returns:

The response.

byUrlConfigurable

public javax.ws.rs.core.Response byUrlConfigurable(@PathParam(value="storeId")
                                                   java.lang.String storeId)

Finds content pages with or without configurable URLs.

Parameters:

storeId - The store ID.

Returns:

The response.

byCatalogEntryIds

public javax.ws.rs.core.Response byCatalogEntryIds(@PathParam(value="storeId")
                                                   java.lang.String storeId)

Finds pages by catalog entry IDs. Invalid catalog entry IDs are ignored.

Parameters:

storeId - The store ID.

Returns:

The response.

byCategoryIds

public javax.ws.rs.core.Response byCategoryIds(@PathParam(value="storeId")
                                               java.lang.String storeId)

Finds pages by category IDs. Invalid category IDs are ignored.

Parameters:

storeId - The store ID.

Returns:

The response.