com.arsdigita.cms.dispatcher
Interface CategoryItemResolver

All Superinterfaces:

ItemResolver

All Known Implementing Classes:

CategoryItemResolverImpl

public interface CategoryItemResolver

extends ItemResolver

CategoryItemResolver extends the ItemResolver interface to provide alternate methods for generating item URLs which take a Category as input, allowing for a URL generation scheme which produces different URLs for an item in different categories

Version:

$Revision: #5 $ $DateTime: 2004/04/07 16:07:11 $

Author:

Scott Seago (sseago@redhat.com)

Field Summary

Fields inherited from interface com.arsdigita.cms.dispatcher.ItemResolver

versionId

Method Summary

String	generateItemURL(com.arsdigita.bebop.PageState state, BigDecimal itemId, String name, ContentSection section, String context, com.arsdigita.categorization.Category category) Generates a URL for a content item.
String	generateItemURL(com.arsdigita.bebop.PageState state, BigDecimal itemId, String name, ContentSection section, String context, String templateContext, com.arsdigita.categorization.Category category) Generates a URL for a content item.
String	generateItemURL(com.arsdigita.bebop.PageState state, ContentItem item, ContentSection section, String context, com.arsdigita.categorization.Category category) Generates a URL for a content item.
String	generateItemURL(com.arsdigita.bebop.PageState state, ContentItem item, ContentSection section, String context, String templateContext, com.arsdigita.categorization.Category category) Generates a URL for a content item.
com.arsdigita.categorization.Category	getCategory(javax.servlet.http.HttpServletRequest request) Gets the category for the current request (if set by getItem(section, url, context)
com.arsdigita.categorization.Category[]	getCategoryPath(javax.servlet.http.HttpServletRequest request) Gets the category path for the current request (if set by getItem(section, url, context)
boolean	isIndexRequest(javax.servlet.http.HttpServletRequest request) Whether the current request is an index item request (i.e.

Methods inherited from interface com.arsdigita.cms.dispatcher.ItemResolver

generateItemURL, generateItemURL, generateItemURL, generateItemURL, getCurrentContext, getItem, getMasterPage, getTemplateFromURL, stripTemplateFromURL

Method Detail

getCategory

public com.arsdigita.categorization.Category getCategory(javax.servlet.http.HttpServletRequest request)

Gets the category for the current request (if set by getItem(section, url, context)

Parameters:

request - The current request

Returns:

the Category for the current request

getCategoryPath

public com.arsdigita.categorization.Category[] getCategoryPath(javax.servlet.http.HttpServletRequest request)

Gets the category path for the current request (if set by getItem(section, url, context)

Parameters:

request - The current request

Returns:

the Category path for the current request

isIndexRequest

public boolean isIndexRequest(javax.servlet.http.HttpServletRequest request)

Whether the current request is an index item request (i.e. the item name is not specified in the URL)

Parameters:

request - The current request

Returns:

Whether the current request is an index item request

generateItemURL

public String generateItemURL(com.arsdigita.bebop.PageState state,
                              BigDecimal itemId,
                              String name,
                              ContentSection section,
                              String context,
                              com.arsdigita.categorization.Category category)

Generates a URL for a content item.

Parameters:

itemId - The item ID

name - The name of the content page

state - The page state

section - the content section to which the item belongs

context - the context of the URL, such as "live" or "admin"

category - the Category to use as the context for generating the URL

Returns:

The URL of the item

See Also:

ItemResolver.getCurrentContext(com.arsdigita.bebop.PageState)

generateItemURL

public String generateItemURL(com.arsdigita.bebop.PageState state,
                              BigDecimal itemId,
                              String name,
                              ContentSection section,
                              String context,
                              String templateContext,
                              com.arsdigita.categorization.Category category)

Generates a URL for a content item.

Parameters:

itemId - The item ID

name - The name of the content page

state - The page state

section - the content section to which the item belongs

context - the context of the URL, such as "live" or "admin"

templateContext - the context for the URL, such as "public"

category - the Category to use as the context for

Returns:

The URL of the item

See Also:

ItemResolver.getCurrentContext(com.arsdigita.bebop.PageState)

generateItemURL

public String generateItemURL(com.arsdigita.bebop.PageState state,
                              ContentItem item,
                              ContentSection section,
                              String context,
                              com.arsdigita.categorization.Category category)

Generates a URL for a content item.

Parameters:

item - The item

state - The page state

section - the content section to which the item belongs

context - the context of the URL, such as "live" or "admin"

category - the Category to use as the context for

Returns:

The URL of the item

See Also:

ItemResolver.getCurrentContext(com.arsdigita.bebop.PageState)

generateItemURL

public String generateItemURL(com.arsdigita.bebop.PageState state,
                              ContentItem item,
                              ContentSection section,
                              String context,
                              String templateContext,
                              com.arsdigita.categorization.Category category)

Generates a URL for a content item.

Parameters:

item - The item

state - The page state

section - the content section to which the item belongs

context - the context of the URL, such as "live" or "admin"

templateContext - the context for the URL, such as "public"

category - the Category to use as the context for

Returns:

The URL of the item

See Also:

ItemResolver.getCurrentContext(com.arsdigita.bebop.PageState)