com.cassinidivision.oce.urlhandling
Interface URLHandler

All Known Implementing Classes:
OCE_Feature

public interface URLHandler

Classes implement the URLHandler interface in order to relate rendering and other contextual information (of a general nature) to publishing policy-specific details.

Such details include the WOComponents required for publishing requests, and the URI locations of published content for given navigation policies.


Method Summary
 WOComponent componentForContext(WOContext aContext, RenderingContext renderingContext, EOEditingContext anEditingContext)
          Retrieve the required component for rendering, based upon information provided by the rendering context.
 String handlerURIWithContext(RenderingContext renderingContext)
          Should return a relative URI to uniquely identify published content according to the contextual information provided.
 

Method Detail

componentForContext

public WOComponent componentForContext(WOContext aContext,
                                       RenderingContext renderingContext,
                                       EOEditingContext anEditingContext)
Retrieve the required component for rendering, based upon information provided by the rendering context.

If necessary, the handler may include new information or update existing information in the rendering context prior to returning the component.

Parameters:
aContext - The current WebObjects context (that the returned wocomponent will be registered with).
renderingContext - Rendering context for reading existing information/writing new information.
anEditingContext - An optional editing context (if required).
Returns:
The new WOComponent rendering instance.

handlerURIWithContext

public String handlerURIWithContext(RenderingContext renderingContext)
Should return a relative URI to uniquely identify published content according to the contextual information provided.

Parameters:
renderingContext - The rendering context from which to derive the URI.
Returns:
String representing a unique relative URI.