# com.bea.p13n.placeholder
ContentBucket Interface

public interface ContentBucket

A ContentBucket is an interface which the PlaceholderService uses to obtain content for the PlaceholderTag.

All Known Subinterfaces
  `AdBucketService`

## Nested Class Summary

`public static class` | `ContentBucket.PreviewInfo` Class that captures the information from the preview.

## Method Summary

`public `String`` | `getContent`(`String` placeholderName, boolean mixGlobals, `String` userId, `String` servletBase, `Request` request, int height, int width) Return the content for the specific placeholder and user.
`public `Collection`` | `previewContent`(`String` servletBase, `String` query, boolean renderContent) Return a collection of PreviewInfo structures which match all of the content for the query.
`public void` | `removeGlobalQueries`(`String` placeholderName, boolean allQueries) Remove queries from the add bucket.
`public void` | `setGlobalQuery`(`String` placeholderName, `String` query, int weight) Set a global query for the placeholder.

## Method Detail

### getContent(String, boolean, String, String, Request, int, int) Method

    public String getContent(String placeholderName,
                             boolean mixGlobals,
                             String userId,
                             String servletBase,
                             Request request,
                             int height,
                             int width)
         throws RemoteException, ContentException

Return the content for the specific placeholder and user.

#### Parameters

placeholderName
  The name of the specific placeholder requesting the content

mixGlobals
  Flag indicating if globals should be mixed

userId
  The user name

servletBase
  the Web App root for the Click thru servlet

request
  the HTTP request

height
  A requested height for the content

width
  A requested width for the content

#### Returns

an X/HTML string representing the content.

#### Exceptions

``RemoteException``
``ContentException``
  thrown when there was a failure to get the content

### previewContent(String, String, boolean) Method

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

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

#### Parameters

servletBase
  the Web App root for the Click thru servlet

query
  The content query to be previewed

renderContent
  true to include the rendering content in the preview, false to not.

#### Returns

a collection of all of the XHTML strings representing the content that would be matched by the content query.

#### Exceptions

``RemoteException``
``ContentException``

### removeGlobalQueries(String, boolean) Method

    public void removeGlobalQueries(String placeholderName,
                                    boolean allQueries)
         throws RemoteException, ContentException

Remove queries from the add bucket. This will remove all or only global queries depending on the removeAll parameter.

#### Parameters

placeholderName
  the name of the placeholder

allQueries
  if true remove all entries for the placeholder, otherwise simply remove the global entries.

#### Exceptions

``RemoteException``
``ContentException``

### setGlobalQuery(String, String, int) Method

    public void setGlobalQuery(String placeholderName,
                               String query,
                               int weight)
         throws RemoteException, ContentException

Set a global query for the placeholder. A placeholder may have more than one global query.

#### Parameters

placeholderName
  the name of the placeholder setting the global query

query
  The query expression of the query.

weight
  the weight associated with the content

#### Exceptions

``RemoteException``
``ContentException``