com.genesyslab.ail
Interface OutboundCampaignInfo

All Superinterfaces:
IdObject, Possible

public interface OutboundCampaignInfo
extends Possible

This class describes an outbound campaign that is active in an OutboundService.

Use this interface to detect the type of agent management for this campaign by calling the getCampaignMode() method. In preview and predictive dialing modes, depending on the options set in the OCS and Configuration Layer, your application may have to:

For each call to requestPreviewRecord, your application gets an InteractionEvent event for the previewed interaction. The interaction received is in Interaction.Status.NEW status.

In other modes, your application receives InteractionEvent for interactions in status Interaction.Status.NEW or Interaction.Status.RINGING.


Nested Class Summary
static class OutboundCampaignInfo.Action
          Actions that are possible on campaigns.
static class OutboundCampaignInfo.Mode
          Constants for the different modes of a campaign.
static class OutboundCampaignInfo.Status
          Constants for the different statuses of a campaign.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 void addRecord(OutboundRecord record)
          Adds a new record to this campaign.
 java.lang.String getCampaignDescription()
          Returns a description of this campaign.
 OutboundCampaignInfo.Mode getCampaignMode()
          Returns the current mode of this campaign.
 java.lang.String getCampaignName()
          Returns the name of this campaign.
 OutboundCampaignInfo.Status getCampaignState()
          Returns the current state of this campaign.
 OutboundRecord getPreviewRecord()
          Requests a new interaction to be sent and gets the associated OutboundRecord.
 boolean isLogoutAcknowledged()
          Returns true when requestLogout() has been acknowledged by the Outbound Server.
 int requestLogout()
          Requests to log out the agent from this campaign.
 boolean requestPreviewRecord()
          Requests a new interaction to be sent.
 void startPreviewMode()
          Starts the preview mode of this campaign.
 void stopPreviewMode()
          Stops the preview mode of this campaign.
 
Methods inherited from interface com.genesyslab.ail.Possible
arePossible, isPossible
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

getCampaignName

java.lang.String getCampaignName()
Returns the name of this campaign.


getCampaignDescription

java.lang.String getCampaignDescription()
Returns a description of this campaign.


getCampaignState

OutboundCampaignInfo.Status getCampaignState()
Returns the current state of this campaign.


getCampaignMode

OutboundCampaignInfo.Mode getCampaignMode()
Returns the current mode of this campaign.


isLogoutAcknowledged

boolean isLogoutAcknowledged()
Returns true when requestLogout() has been acknowledged by the Outbound Server.


requestPreviewRecord

boolean requestPreviewRecord()
                             throws RequestFailedException
Requests a new interaction to be sent. A new Interaction will arrive on the agent's DN if there is a record available in this campaign.

Returns:
true if a preview record has been found, false if there is no more record.
Throws:
OutboundServiceException - if an error is reported by the Outbound Server
InvalidStatusException - if the campaign is not in PREVIEW mode and in RUNNING status.
RequestFailedException

getPreviewRecord

OutboundRecord getPreviewRecord()
                                throws RequestFailedException
Requests a new interaction to be sent and gets the associated OutboundRecord. This method performs the same action as the requestPreviewRecord() method but instead of receiving a boolean, you receive an OutboundRecord.
A new Interaction is created as well, if a record is available in this campaign.

Returns:
the requested record if one has been found. null if there are no more records.
Throws:
OutboundServiceException - if an error is reported by the Outbound Server.
InvalidStatusException - if the campaign is not in PREVIEW mode and in RUNNING status.
RequestFailedException
Since:
6.5.402.01

startPreviewMode

void startPreviewMode()
                      throws RequestFailedException
Starts the preview mode of this campaign.

Throws:
InvalidStatusException - if the campaign is not in PREVIEW mode and in RUNNING status.
RequestFailedException

stopPreviewMode

void stopPreviewMode()
                     throws RequestFailedException
Stops the preview mode of this campaign.

Throws:
InvalidStatusException - if the campaign is not in PREVIEW mode and in RUNNING status.
RequestFailedException

addRecord

void addRecord(OutboundRecord record)
               throws RequestFailedException
Adds a new record to this campaign. This new record will be the beginning of a new chain.

Parameters:
record - the record to add to this campaign.
Throws:
OutboundServiceException - if an error is reported by the Outbound Server.
RequestFailedException

requestLogout

int requestLogout()
                  throws RequestFailedException
Requests to log out the agent from this campaign. An CampaignEvent of type LOGOUT_ACKNOWLEDGE will be sent when the logout is taken into account.

Returns:
the estimated time before the agent is removed from this campaign.
Throws:
OutboundServiceException - if an error is reported by the Outbound Server.
RequestFailedException