Skip navigation links

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

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

public class PlaceholderLogic

extends PageLogic<PlaceholderRequest>

Logic for working with Placeholder objects

Constructor Summary

PlaceholderLogic(ClientApplication clientApplication)

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, LazyLoadingContent 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.
LazyLoadingContent	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	validateSiteRequest(PlaceholderRequest request) Verify the request parameters

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

getPageTemplate, getPageTemplate

Methods inherited from class oracle.stellent.wcm.server.request.SiteRequestLogic

checkSecurity, checkSecurity, getClientApplication, getProject, getProject, getSection, getSection, 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(ClientApplication clientApplication)

Method Detail

validateSiteRequest

public void validateSiteRequest(PlaceholderRequest request)
                         throws SiteRequestException

Description copied from class: SiteRequestLogic

Verify the request parameters

Overrides:

validateSiteRequest in class SiteRequestLogic<PlaceholderRequest>

Parameters:

request - the request

Throws:

SiteRequestException - if the parameters are not valid

createPlaceholder

public Placeholder createPlaceholder(PlaceholderRequest placeholderRequest)
                              throws SiteRequestException

Create a new placeholder object based on the active page template

Parameters:

placeholderRequest - the placeholder command

Returns:

a new placeholder object

Throws:

SiteRequestException

loadDataFile

public LazyLoadingContent loadDataFile(PlaceholderRequest placeholderRequest,
                                       ContentID contentID)
                                throws SiteRequestException

Load the data file

Parameters:

placeholderRequest - the placeholder command

contentID - the content ID of the data file

Returns:

the data file

Throws:

SiteRequestException

determineDefinitionAndTemplate

public void determineDefinitionAndTemplate(PlaceholderRequest placeholderRequest,
                                           Placeholder placeholder,
                                           LazyLoadingContent dataFile)
                                    throws SiteRequestException

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:

SiteRequestException

getPlaceholderDefinition

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

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:

SiteRequestException

createPlaceholderDefinition

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

Create and associate a new placeholder definition with this placeholder

Parameters:

placeholderRequest - the command

placeholder - the placeholder

Returns:

the placeholder definition

Throws:

SiteRequestException

determinePlaceholderDefinitionName

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

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:

SiteRequestException

loadPlaceholderDefinition

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

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:

SiteRequestException

See Also:

ProjectFile.getPrimaryPlaceholderDefinitionName(String)

Skip navigation links