AdService Interface

com.bea.p13n.ad
AdService Interface

public interface AdService

    extends EJBObject

The remote bean interface for the AdService.

This will return the actual content for ads. All ad query strings and expression should be full-realized and contain only literal values (no property references).


All Superinterfaces
EJBObject, Remote

Nested Class Summary

public static classAdService.AdCounts
           Class that is generated by getAdCounts.

Method Summary

public void
cleanupAdService(String containerUID)
Cleanup the AdService removing all records specified by the passed in ContainerUID.
public String
getAdContent(Expression expr, long identifier, String containerUID, String contextUID, String placeholder, String userId, String servletBase, Request request, int height, int width)
Get the XHTML ad content for a content object and record an impression.
public String
getAdContent(String query, long identifier, String containerUID, String contextUID, String placeholder, String userId, String servletBase, Request request, int height, int width)
Get the XHTML ad content for a content object and record an impression.
public Collection
getAdCounts(Collection contentPaths, String containerUID)
return of collection of ad counts
public Node[]
getContent(String adQuery)
Return an array of content which match the ad query string.
public Node[]
getContent(Expression expr)
Return an array of content which match the ad query expression.
public Node[]
getContent(Expression expr, Request request)
Return an array of content which match the ad query expression
public Collection
getContentIds(String adQuery)
Return a collection of content paths which match the ad query string.
public Collection
getContentIds(Expression expr)
Return a collection of content paths which match the ad query expression.
public Collection
getContentPaths(Expression expr)
Return a collection of content paths which match the ad query expression.
public Collection
getContentPaths(Expression expr, Request request)
Return a collection of content paths which match the ad query expression.
public void
recordClickThru(String contentPath, String containerUID, String contextUID, String placeholder, String userId, Request request)
Update the click thru count for an ad
public void
recordDisplay(Node c, String containerUID, String contextUID, String placeholder, String userId, Request request)
Update the display count for an ad.
public String
renderContent(Node c, long identifier, String servletBase, int height, int width, int options)
Return the rendered XHTML for the content object.
 
Methods from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
   

Method Detail

cleanupAdService(String) Method

public void cleanupAdService(String containerUID)
throws RemoteException, ContentException
Cleanup the AdService removing all records specified by the passed in ContainerUID.

Parameters

containerUID
containerUID identifying the records to be removed

Exceptions

RemoteException
ContentException

getAdContent(Expression, long, String, String, String, String, String, Request, int, int) Method

public String getAdContent(Expression expr, 
                           long identifier, 
                           String containerUID, 
                           String contextUID, 
                           String placeholder, 
                           String userId, 
                           String servletBase, 
                           Request request, 
                           int height, 
                           int width)
throws AdContentException, RemoteException
Get the XHTML ad content for a content object and record an impression.

Parameters

expr
the content management query expression
identifier
a indentifier for the content bucket the query is from
containerUID
the UID of the container
contextUID
the UID of the context
placeholder
the name of the placeholder
userId
the user Id
servletBase
the Web App root for the click thru servlet
request
the HTTP request
height
the suggested content height
width
the suggested content width

Returns

an XHMLT content descrption for the ad

Exceptions

AdContentException
RemoteException

getAdContent(String, long, String, String, String, String, String, Request, int, int) Method

DEPRECATED Use getAdContenxt(Expression, ...) instead

public String getAdContent(String query, 
                           long identifier, 
                           String containerUID, 
                           String contextUID, 
                           String placeholder, 
                           String userId, 
                           String servletBase, 
                           Request request, 
                           int height, 
                           int width)
throws AdContentException, RemoteException
Get the XHTML ad content for a content object and record an impression.

Parameters

query
the content management query
identifier
a indentifier for the content bucket the query is from
containerUID
the UID of the container
contextUID
the UID of the context
placeholder
the name of the placeholder
userId
the user Id
servletBase
the Web App root for the click thru servlet
request
the HTTP request
height
the suggested content height
width
the suggested content width

Returns

an XHMLT content descrption for the ad

Exceptions

AdContentException
RemoteException

Related Topics

AdService.getAdContent(Expression, long, String, String, String, String, String, Request, int, int)


getAdCounts(Collection, String) Method

public Collection getAdCounts(Collection contentPaths, 
                              String containerUID)
throws RemoteException, SQLException
return of collection of ad counts

Parameters

contentPaths
the content path
containerUID
the UID of the container

Exceptions

RemoteException
SQLException

getContent(String) Method

DEPRECATED Use getContent(Expression, Request) instead.

public Node[] getContent(String adQuery)
throws RemoteException, AdContentException
Return an array of content which match the ad query string.

Parameters

adQuery
The content query string

Exceptions

RemoteException
AdContentException
when the ad content cannot be found.

Related Topics

AdService.getContent(Expression, Request)


getContent(Expression) Method

DEPRECATED Use getContent(Expression, Request) instead.

public Node[] getContent(Expression expr)
throws RemoteException, AdContentException
Return an array of content which match the ad query expression.

Parameters

expr
The content query expression

Exceptions

RemoteException
AdContentException
when the ad content cannot be found.

Related Topics

AdService.getContent(Expression, Request)


getContent(Expression, Request) Method

public Node[] getContent(Expression expr, 
                       Request request)
throws RemoteException, AdContentException
Return an array of content which match the ad query expression

Parameters

expr
The content query expression
request
the copy of the http request (null if not available).

Exceptions

RemoteException
AdContentException
when the ad content cannot be found.

getContentIds(String) Method

DEPRECATED Use getContentPaths(Expression, Request) instead.

public Collection getContentIds(String adQuery)
throws RemoteException, AdContentException
Return a collection of content paths which match the ad query string.

Parameters

adQuery
The content query string

Exceptions

RemoteException
AdContentException
when the ad content cannot be found.

Related Topics

AdService.getContentPaths(Expression, Request)


getContentIds(Expression) Method

DEPRECATED Use getContentPaths(Expression, Request) instead.

public Collection getContentIds(Expression expr)
throws RemoteException, AdContentException
Return a collection of content paths which match the ad query expression.

Parameters

expr
The content query expression

Exceptions

RemoteException
AdContentException
when the ad content cannot be found.

Related Topics

AdService.getContentPaths(Expression, Request)


getContentPaths(Expression) Method

DEPRECATED Use getContentPaths(Expression, Request) instead.

public Collection getContentPaths(Expression expr)
throws RemoteException, AdContentException
Return a collection of content paths which match the ad query expression.

Parameters

expr
The content query expression

Exceptions

RemoteException
AdContentException
when the ad content cannot be found.

Related Topics

AdService.getContentPaths(Expression, Request)


getContentPaths(Expression, Request) Method

public Collection getContentPaths(Expression expr, 
                                  Request request)
throws RemoteException, AdContentException
Return a collection of content paths which match the ad query expression.

Parameters

expr
The content query expression
request
the copy of the http request (null if not available).

Exceptions

RemoteException
AdContentException
when the ad content cannot be found.

recordClickThru(String, String, String, String, String, Request) Method

public void recordClickThru(String contentPath, 
                            String containerUID, 
                            String contextUID, 
                            String placeholder, 
                            String userId, 
                            Request request)
throws RemoteException, SQLException
Update the click thru count for an ad

Parameters

contentPath
The content object path
containerUID
the UID of the container
contextUID
the UID of the context
placeholder
the name of the placeholder
userId
the user Id
request
the HTTP request

Exceptions

RemoteException
SQLException

recordDisplay(Node, String, String, String, String, Request) Method

public void recordDisplay(Node c, 
                          String containerUID, 
                          String contextUID, 
                          String placeholder, 
                          String userId, 
                          Request request)
throws RemoteException, SQLException
Update the display count for an ad.

Parameters

c
The content object
containerUID
the UID of the container
contextUID
the UID of the context
placeholder
the name of the placeholder
userId
the user Id
request
the HTTP request

Exceptions

RemoteException
SQLException

renderContent(Node, long, String, int, int, int) Method

public String renderContent(Node c, 
                            long identifier, 
                            String servletBase, 
                            int height, 
                            int width, 
                            int options)
throws AdContentException, RemoteException
Return the rendered XHTML for the content object.

Parameters

c
The content element to render
identifier
A long that is used to access the database record
servletBase
The Web App root for the click thru servlet
height
The suggested height
width
The suggested width
options
The options for the rendering

Exceptions

AdContentException
RemoteException