com.bea.commerce.platform.placeholder
Interface PlaceholderService

public interface PlaceholderService

The remote bean interface for the PlaceholderService. A placeholder is a named location in some page and is represented by the PlaceholderTag. The primary function of the placeholder service is to return content to the PlaceholderTag when it is viewed. This content is based upon the type of the placeholder, and user information.

Additional features allow new placeholders to be created and list all of the placeholders currently defined.

Method Summary

boolean	definePlaceholder(java.lang.String placeholder) Define a new placeholder for the system.
java.lang.String	getContent(java.lang.String name, java.lang.String userId, java.lang.String servletBase, Request request, int height, int width) Return the content for the requested placeholder.
java.lang.String	getPlaceholder(java.lang.String name) Return a xml blob that contains the placeholder definition
java.lang.String	getPlaceholders() Return an XML blob of the placeholders defined on the system
java.util.Collection	previewContent(long previewId, java.lang.String userId, java.lang.String phType) Return a collection of PreviewInfo structures which match all of the content for the query.
void	removePlaceholder(java.lang.String placeholder) Remove a placeholder
void	removePreviewSlot(long previewId)
long	setPreviewSlot(java.lang.String xmlQuery) Set an xml string into

Method Detail

getContent

public java.lang.String getContent(java.lang.String name,
                                   java.lang.String userId,
                                   java.lang.String servletBase,
                                   Request request,
                                   int height,
                                   int width)
                            throws java.rmi.RemoteException,
                                   ContentException

Return the content for the requested placeholder. The content is returned as an XML String, which may be a fragment of a larger DTD.

Parameters:

name - The name of the placeholder

userId - The user id

servletBase - A URL base that is used to find the ClickThru and ShowDocServlet

request - The http request

height - The requested height of the content

width - The requested width of the content

Returns:

an XML String representing the content.

Throws:

Content - is thrown when there is a failure to obtain the content

previewContent

public java.util.Collection previewContent(long previewId,
                                           java.lang.String userId,
                                           java.lang.String phType)
                                    throws java.rmi.RemoteException,
                                           ContentException

Return a collection of PreviewInfo structures which match all of the content for the query.

setPreviewSlot

public long setPreviewSlot(java.lang.String xmlQuery)
                    throws java.rmi.RemoteException,
                           ContentException

Set an xml string into

removePreviewSlot

public void removePreviewSlot(long previewId)
                       throws java.rmi.RemoteException,
                              ContentException

getPlaceholders

public java.lang.String getPlaceholders()
                                 throws java.rmi.RemoteException,
                                        ContentException

Return an XML blob of the placeholders defined on the system

Returns:

a collection of placeholder infos

getPlaceholder

public java.lang.String getPlaceholder(java.lang.String name)
                                throws java.rmi.RemoteException,
                                       ContentException

Return a xml blob that contains the placeholder definition

Parameters:

name - the placeholder name

Returns:

an XML String describing all defined placeholders.

Throws:

Content - when we fail to get the content from the bucket

definePlaceholder

public boolean definePlaceholder(java.lang.String placeholder)
                          throws java.rmi.RemoteException,
                                 ContentException

Define a new placeholder for the system.

Parameters:

placeholder - the XML defining the placeholder

Returns:

true if the placeholder is added

Throws:

Content - when we fail to define a new placeholder

removePlaceholder

public void removePlaceholder(java.lang.String placeholder)
                       throws java.rmi.RemoteException,
                              ContentException

Remove a placeholder