Skip navigation links

oracle.stellent.wcm.server.request.logic.placeholder
Class PlaceholderLogic

java.lang.Object
oracle.stellent.wcm.server.request.logic.RequestLogic<T>
oracle.stellent.wcm.server.request.logic.page.PageLogic<PlaceholderRequest>
oracle.stellent.wcm.server.request.logic.placeholder.PlaceholderLogic

public class PlaceholderLogic

extends PageLogic<PlaceholderRequest>

Logic for working with Placeholder objects

Constructor Summary

PlaceholderLogic(ServerContext serverContext)

Method Summary

Placeholder	createPlaceholder(PlaceholderRequest placeholderRequest) Create a new placeholder object based on the active page template
protected PlaceholderDefinition	createPlaceholderDefinition(PlaceholderRequest placeholderRequest, Placeholder placeholder) Create and associate a new placeholder definition with this placeholder
void	determineDefinitionAndTemplate(PlaceholderRequest placeholderRequest, Placeholder placeholder, ProviderContent dataFile) Determine the definition and template by examining the current placeholder information.
protected void	determinePlaceholderDefinitionName(PlaceholderRequest placeholderRequest, Placeholder placeholder) Set the placeholder definition name and origin for the given placeholder.
protected PlaceholderDefinition	getPlaceholderDefinition(PlaceholderRequest placeholderRequest, Placeholder placeholder) Loads the placeholder definition and sets the template on the given placeholder object based on the current data file content.
ProviderContent	loadDataFile(PlaceholderRequest placeholderRequest, ContentID contentID) Load the data file
protected PlaceholderDefinition	loadPlaceholderDefinition(PlaceholderRequest placeholderRequest, Placeholder placeholder) Retrieve a placeholder definition for the current placeholder.
void	validateRequest(PlaceholderRequest request) Verify the request parameters

Methods inherited from class oracle.stellent.wcm.server.request.logic.page.PageLogic

getPageTemplate, getPageTemplate

Methods inherited from class oracle.stellent.wcm.server.request.logic.RequestLogic

checkSecurity, checkSecurity, getProject, getProject, getSection, getSection, getServerContext, getStructure, isSectionAvailable, setRequestSiteID

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceholderLogic

public PlaceholderLogic(ServerContext serverContext)

Method Detail

validateRequest

public void validateRequest(PlaceholderRequest request)
                     throws RequestException

Description copied from class: RequestLogic

Verify the request parameters

Overrides:

validateRequest in class RequestLogic<PlaceholderRequest>

Parameters:

request - the request

Throws:

RequestException - if the parameters are not valid

createPlaceholder

public Placeholder createPlaceholder(PlaceholderRequest placeholderRequest)
                              throws RequestException

Create a new placeholder object based on the active page template

Parameters:

placeholderRequest - the placeholder command

Returns:

a new placeholder object

Throws:

RequestException

loadDataFile

public ProviderContent loadDataFile(PlaceholderRequest placeholderRequest,
                                    ContentID contentID)
                             throws RequestException

Load the data file

Parameters:

placeholderRequest - the placeholder command

contentID - the content ID of the data file

Returns:

the data file

Throws:

RequestException

determineDefinitionAndTemplate

public void determineDefinitionAndTemplate(PlaceholderRequest placeholderRequest,
                                           Placeholder placeholder,
                                           ProviderContent dataFile)
                                    throws RequestException

Determine the definition and template by examining the current placeholder information.

Parameters:

placeholderRequest - the placeholder command

placeholder - the placeholder

dataFile - the data file content

Throws:

RequestException

getPlaceholderDefinition

protected PlaceholderDefinition getPlaceholderDefinition(PlaceholderRequest placeholderRequest,
                                                         Placeholder placeholder)
                                                  throws RequestException

Loads the placeholder definition and sets the template on the given placeholder object based on the current data file content.

Parameters:

placeholderRequest - the placeholder command

placeholder - the placeholder

Returns:

true if the read was successful

Throws:

RequestException

createPlaceholderDefinition

protected PlaceholderDefinition createPlaceholderDefinition(PlaceholderRequest placeholderRequest,
                                                            Placeholder placeholder)
                                                     throws RequestException

Create and associate a new placeholder definition with this placeholder

Parameters:

placeholderRequest - the command

placeholder - the placeholder

Returns:

the placeholder definition

Throws:

RequestException

determinePlaceholderDefinitionName

protected void determinePlaceholderDefinitionName(PlaceholderRequest placeholderRequest,
                                                  Placeholder placeholder)
                                           throws RequestException

Set the placeholder definition name and origin for the given placeholder. Will check your current section and the global placeholder definitions table.

Parameters:

placeholderRequest - the placeholder command

placeholder - the placeholder to populate

Throws:

RequestException

loadPlaceholderDefinition

protected PlaceholderDefinition loadPlaceholderDefinition(PlaceholderRequest placeholderRequest,
                                                          Placeholder placeholder)
                                                   throws RequestException

Retrieve a placeholder definition for the current placeholder. Will check your current section and the global placeholder definitions table.

Parameters:

placeholderRequest - the placeholder command

placeholder - the placeholder

Returns:

the placeholder config or null if not found

Throws:

RequestException

See Also:

Project.getPrimaryPlaceholderDefinitionName(String)

Skip navigation links