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

  public javax.ws.rs.core.Response findByPageId(java.lang.String storeId,
                                       java.lang.String pageId)
  

  Finds a page by its ID.

  Parameters:

  storeId - The store ID.

  pageId - The page ID.

  Returns:

  The response.

• findByName

  public javax.ws.rs.core.Response findByName(java.lang.String storeId,
                                     java.lang.String name)
  

  Finds a page by its name.

  Parameters:

  storeId - The store ID.

  name - The page name.

  Returns:

  The response.

• findByQuery

  public javax.ws.rs.core.Response findByQuery(java.lang.String storeId,
                                      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(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(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(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(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(java.lang.String storeId)
  

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

  Parameters:

  storeId - The store ID.

  Returns:

  The response.

• getPage

  protected javax.ws.rs.core.Response getPage(ExpressionType expression,
                                  java.lang.String storeId,
                                  java.lang.String profileName,
                                  boolean single)
  

  Calls the GetPage service.

  Parameters:

  expression - The expression.

  storeId - The store ID.

  profileName - The profile name.

  single - Whether the result list must contain exactly one entry.

  Returns:

  The response.

• getCatalogNavigationView

  protected javax.ws.rs.core.Response getCatalogNavigationView(ExpressionType expression,
                                                   java.lang.String storeId,
                                                   java.lang.String profileName,
                                                   boolean single)
  

  Calls the GetCatalogNavigationView service.

  Parameters:

  expression - The expression.

  storeId - The store ID.

  profileName - The profile name.

  single - Whether the result list must contain exactly one entry.

  Returns:

  The response.