PlaceholderService (Oracle Fusion Middleware Java API for Oracle WebLogic Portal)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.bea.p13n.placeholder
Interface PlaceholderService

All Superinterfaces: javax.ejb.EJBObject, Remote

public interface PlaceholderService

extends javax.ejb.EJBObject

This interface is intended to be implemented only by Oracle Weblogic Portal. Oracle Systems reserves the right to add abstract methods to this interface without notice. Implementations of this interface by other parties must not be expected to compile without change in future versions of Oracle Weblogic Portal.

Method Summary
`String`	`getContent(String name, String userId, String servletBase, Request request, int height, int width)` Return the content for the requested placeholder.
`Collection`	`getDeployedPlaceholderURIs()` Get the list of placeholder uris currently deployed in this service.
`String`	`getPreviewSlot(long previewId)` Deprecated No longer used.
`String`	`getPreviewSlotQuery(long previewId, String userId)` Deprecated No longer used.
`Collection`	`previewContent(long previewId, String userId, String servletBase, String phType)` Deprecated No longer used.
`Collection`	`previewContent(String query, String phType, boolean renderContent, Request request)` Return a collection of PreviewInfo structures which match all of the content for the query.
`Collection`	`previewContent(String query, String servletBase, String phType, boolean renderContent)` Deprecated
`void`	`removePreviewSlot(long previewId)` Deprecated No longer used.
`long`	`setPreviewSlot(String xmlQuery)` Deprecated No longer used.

Methods inherited from interface javax.ejb.EJBObject
`getEJBHome, getHandle, getPrimaryKey, isIdentical, remove`

Method Detail

getContent

String getContent(String name,
                  String userId,
                  String servletBase,
                  Request request,
                  int height,
                  int width)
                  throws RemoteException,
                         ContentException

Return the content for the requested placeholder.

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: ContentException - thrown when there is a failure to obtain the content; RemoteException

previewContent

Collection previewContent(String query,
                          String servletBase,
                          String phType,
                          boolean renderContent)
                          throws RemoteException,
                                 ContentException

Deprecated

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

Parameters: query - the content query to preview; servletBase - the base URI of the webapp to preview in; phType - the placeholder type (Ad, ContentSelector); renderContent - true to include the rendering content in the preview, false to not.
Throws: RemoteException; ContentException

previewContent

Collection previewContent(String query,
                          String phType,
                          boolean renderContent,
                          Request request)
                          throws RemoteException,
                                 ContentException

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

Parameters: query - the content query to preview; servletBase - the base URI of the webapp to preview in; phType - the placeholder type (Ad, ContentSelector); renderContent - true to include the rendering content in the; request - The http request preview, false to not.
Throws: RemoteException; ContentException