|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AdBucketService
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.bea.p13n.placeholder.ContentBucket |
---|
ContentBucket.PreviewInfo |
Method Summary | |
---|---|
void |
cleanupAdBucket(String containerUID)
Remove the information about a container from both the user and global ad buckets. |
AdInfo |
getAdEventInfo(long adBucketId)
Get the AdInfo required to post an event for the specified bucket id. |
String |
getContent(String placeholderName,
boolean mixGlobals,
String userId,
String servletBase,
Request request,
int height,
int width)
Return the content for the requested ad |
Collection |
getGlobalQueries(String placeholderName)
Get the list of AdInfos that represent the global queries for the specified placeholder. |
Collection |
previewContent(Request request,
String query,
boolean renderContent)
Return a collection of PreviewInfo
structures which match all of the content for the query. |
Collection |
previewContent(String servletBase,
String query,
boolean renderContent)
Deprecated |
Collection |
previewContent(String userId,
String servletBase,
String query)
Deprecated Use previewContent(String, String, boolean) instead. |
void |
removeGlobalQueries(String placeholderName,
boolean removeAll)
Remove queries from the add bucket. |
void |
setGlobalQuery(String placeholderName,
String query,
int weight)
Set a global query for the placeholder. |
boolean |
userAddAd(AdInfo adInfo,
boolean remove)
Add the adInfo to the user's AdBucket |
int |
userClearAds(String userId,
String placeholderName,
String containerUID,
String containerType)
Clear user ads in a bucket. |
Methods inherited from interface javax.ejb.EJBObject |
---|
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
Method Detail |
---|
String getContent(String placeholderName, boolean mixGlobals, String userId, String servletBase, Request request, int height, int width) throws RemoteException, ContentException
getContent
in interface ContentBucket
placeholderName
- The name of the placeholdermixGlobals
- Mix globals with bucket ads?userId
- The user idservletBase
- The Web App base for the click thru servletrequest
- The HTTP requestheight
- The desired heightwidth
- The desired width
ContentException
- thrown when there was a failure to get the
content
RemoteException
Collection previewContent(String servletBase, String query, boolean renderContent) throws RemoteException, ContentException
PreviewInfo
structures which match all of the content for the query.
previewContent
in interface ContentBucket
servletBase
- The Web App base for the click thru servletquery
- The content query to be previewedrenderContent
- true to include the rendering content in the
preview, false to not.
PreviewInfo
structures that would be matched by the content query.
RemoteException
ContentException
Collection previewContent(Request request, String query, boolean renderContent) throws RemoteException, ContentException
PreviewInfo
structures which match all of the content for the query.
previewContent
in interface RenderableContentBucket
request
- - P13N requestquery
- The content query to be previewedrenderContent
- true to include the rendering content in the
preview, false to not.
PreviewInfo
structures that would be matched by the content query.
RemoteException
ContentException
Collection previewContent(String userId, String servletBase, String query) throws RemoteException, ContentException
PreviewInfo
structures which match all of the content for the query
(with rendered content).
userId
- the user name.servletBase
- The Web App base for the click thru servletquery
- The content query to be previewed
PreviewInfo
structures that would be matched by the content query.
RemoteException
ContentException
void setGlobalQuery(String placeholderName, String query, int weight) throws RemoteException, ContentException
setGlobalQuery
in interface ContentBucket
placeholderName
- the name of the placeholder setting the global
queryquery
- The query expression of the query.weight
- The weight associated with the query
RemoteException
ContentException
void removeGlobalQueries(String placeholderName, boolean removeAll) throws RemoteException, ContentException
removeGlobalQueries
in interface ContentBucket
placeholderName
- the name of the placeholderremoveAll
- if true remove all entries for the placeholder,
otherwise simply remove the global entries.
RemoteException
ContentException
Collection getGlobalQueries(String placeholderName) throws RemoteException, ContentException
RemoteException
ContentException
boolean userAddAd(AdInfo adInfo, boolean remove) throws RemoteException, ContentException
adInfo
- the ad related informationremove
- if the AdInfo already exists, true to remove it, false to
update it.
Content
- when the content cannot be created
RemoteException
ContentException
int userClearAds(String userId, String placeholderName, String containerUID, String containerType) throws RemoteException, ContentException
userId
- the userId (null for current, only admin users can clear
other user's buckets).placeholderName
- the name of the placeholder to clear (null for
all placeholders).containerUID
- the uid of the container to clear (null for all
containers).containerType
- the type of the container to clear (null for all
container types).
ContentException
- thrown on an error.
RemoteException
AdInfo getAdEventInfo(long adBucketId) throws RemoteException, ContentException
The AdInfo returned will only have a bucketId, placeholderName, containerUID, and contextUID.
RemoteException
ContentException
void cleanupAdBucket(String containerUID) throws RemoteException, ContentException
containerUID
- The name of the container
that we are cleaning up
RemoteException
ContentException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |