com.bea.campaign
Interface CampaignService

All Superinterfaces:

AdStatus, EJBObject, Remote

public interface CampaignService

extends EJBObject, AdStatus

EJB object interface for the CampaignService session EJB.

Method Summary

void	clearEndStates(String campaignId) Clear all of the user end states associated to a campaign.
Collection	getActiveCampaigns() Get back a list of the active Campaign objects.
AdBucketService	getAdBucketService() Get a reference to the AdBucketService being used.
AdService	getAdService() Get a reference to the AdService being used
Campaign	getCampaign(String id) Retrieve a deployed campaign.
Collection	getDeployedCampaigns() Get back a list of the deployed Campaign objects.
MailService	getMailService() Get a reference to the mail service being used.
ScenarioService	getScenarioService() Get a reference to the scenario service this uses.
void	handleEvent(Event event) Handle an event from the event service.
boolean	isActive(String campaignId) Tell if the specified campaign is currently active.
void	resetCampaign(String campaignId) Reset any cached state on the specified campaign.

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

clearEndStates

public void clearEndStates(String campaignId)
                    throws RemoteException,
                           EJBException

Clear all of the user end states associated to a campaign.

Throws:

EJBException - thrown on an error.

RemoteException - thrown on a communications error.

See Also:

ScenarioService.clearEndStates(com.bea.campaign.ScenarioContainer)

getActiveCampaigns

public Collection getActiveCampaigns()
                              throws RemoteException,
                                     EJBException

Get back a list of the active Campaign objects.

Throws:

RemoteException

EJBException

getAdBucketService

public AdBucketService getAdBucketService()
                                   throws RemoteException,
                                          EJBException

Get a reference to the AdBucketService being used.

Throws:

EJBException - thrown on an error.

RemoteException - thrown on a communications error.

getAdService

public AdService getAdService()
                       throws RemoteException,
                              EJBException

Get a reference to the AdService being used

Throws:

EJBException - thrown on an error.

RemoteException - thrown on a communications error.

getCampaign

public Campaign getCampaign(String id)
                     throws RemoteException,
                            EJBException

Retrieve a deployed campaign.

Throws:

RemoteException

EJBException

getDeployedCampaigns

public Collection getDeployedCampaigns()
                                throws RemoteException,
                                       EJBException

Get back a list of the deployed Campaign objects.

Throws:

RemoteException

EJBException

getMailService

public MailService getMailService()
                           throws RemoteException,
                                  EJBException

Get a reference to the mail service being used.

Throws:

EJBException - thrown on an error.

RemoteException - thrown on a communications error.

getScenarioService

public ScenarioService getScenarioService()
                                   throws RemoteException,
                                          EJBException

Get a reference to the scenario service this uses.

Throws:

EJBException - thrown on an error.

RemoteException - thrown on a communications error.

handleEvent

public void handleEvent(Event event)
                 throws RemoteException,
                        EJBException

Handle an event from the event service.

Parameters:

event - the event.

Throws:

EJBException - thrown on an error.

RemoteException - thrown on a communications error.

isActive

public boolean isActive(String campaignId)
                 throws RemoteException,
                        EJBException

Tell if the specified campaign is currently active.

Specified by:

isActive in interface AdStatus

Parameters:

campaignId - the campaign's unique id.

Returns:

true if the container is active, false otherwise

Throws:

EJBException - thrown on an error.

RemoteException - thrown on a communications error.

resetCampaign

public void resetCampaign(String campaignId)
                   throws RemoteException,
                          EJBException

Reset any cached state on the specified campaign.

This will cause the Campaign to redetermine it's state the next time it's accessed.

This includes: reseting the goal achieved state.

Throws:

RemoteException

EJBException