com.bea.commerce.platform.placeholder
Class PlaceholderBean

java.lang.Object
  |
  +--com.bea.commerce.platform.placeholder.PlaceholderBean

All Implemented Interfaces:

PlaceholderConstants

public class PlaceholderBean

extends java.lang.Object

implements PlaceholderConstants

The placeholder bean is an object that allows convenient access to the PlaceholderService from JSP pages.

Fields inherited from interface com.bea.commerce.platform.placeholder.PlaceholderConstants

ADBUCKET_ENV_NAME, PLACEHOLDER_DB_NAME, PLACEHOLDER_NAME, PLACEHOLDER_PREVIEW_DB_NAME

Constructor Summary

PlaceholderBean()

Method Summary

boolean	defineNewPlaceholder(java.lang.String placeholder) Define a new placeholder within the system.
void	deletePlaceholder(java.lang.String placeholder) delete a placeholder by name
java.lang.String	getPlaceholder(java.lang.String name) Return the placeholders as an XML string.
java.lang.String	getPlaceholders() return the XML string defining the placeholder

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceholderBean

public PlaceholderBean()

Method Detail

defineNewPlaceholder

public boolean defineNewPlaceholder(java.lang.String placeholder)
                             throws javax.ejb.CreateException,
                                    ContentException

Define a new placeholder within the system.

Parameters:

placeholder - the XML defining the placeholder

Returns:

true is returned if this succeeds, false otherwise

Throws:

Create - when we are unable to create the PlaceholderService

Content - when there is a failure with the content

deletePlaceholder

public void deletePlaceholder(java.lang.String placeholder)
                       throws javax.ejb.CreateException,
                              ContentException

delete a placeholder by name

Parameters:

placeholder - the name of the placeholder

getPlaceholders

public java.lang.String getPlaceholders()
                                 throws ContentException,
                                        javax.ejb.CreateException

return the XML string defining the placeholder

getPlaceholder

public java.lang.String getPlaceholder(java.lang.String name)
                                throws ContentException,
                                       javax.ejb.CreateException

Return the placeholders as an XML string.

Parameters:

name - the name of the placeholder

Returns:

a string containing the XML defining the placeholder

Throws:

Create - when we are unable to create the PlaceholderService

Content - when there is a failure with the content