com.genesyslab.ail
Interface InteractionVoiceOutbound

All Superinterfaces:
AbstractInteraction, IdObject, Interaction, InteractionVoice, Possible, Savable

Deprecated. You should use the OutboundChain interface.

public interface InteractionVoiceOutbound
extends InteractionVoice

A voice interaction dedicated to process outbound contacts.


Nested Class Summary
static class InteractionVoiceOutbound.Action
          Deprecated. You should use the OutboundChain interface.
static class InteractionVoiceOutbound.OutboundStatus
          Deprecated. You should use the OutboundChain interface.
static class InteractionVoiceOutbound.TreatmentType
          Deprecated. You should use the OutboundChain interface.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.InteractionVoice
InteractionVoice.CallType, InteractionVoice.MakeCallType, InteractionVoice.NetworkStatus
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.Interaction
Interaction.Status, Interaction.Type
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.AbstractInteraction
AbstractInteraction.AbstractCallType
 
Method Summary
 void addOutboundListener(InteractionOutboundListener listener)
          Deprecated. Adds a listener on the outbound events of this interaction.
 void addRecordToChain(OutboundRecord newRecord)
          Deprecated. Adds a new record at the end of the chained records currently handled by this interaction.
 void cancel()
          Deprecated. Cancels this outbound record.
 void doNotCall(java.lang.String message)
          Deprecated. Prevents the current record (and all its chained records) from being dialed by any campaign (for instance because of contact request).
 OutboundRecord getActiveRecord()
          Deprecated. Returns the record that is marked as the active one within the list.
 InteractionVoiceOutbound.OutboundStatus getOutboundStatus()
          Deprecated. Returns the outbound record handling status, which shows whether this interaction is still able to handle outbound related functions.
 OutboundRecord getRecord(java.lang.String recordId)
          Deprecated. Returns the record handled by this interaction that is identified by this record ID.
 java.util.List getRecords()
          Deprecated. Returns the outbound records attached to this interaction.
 InteractionVoiceOutbound.TreatmentType getTreatment()
          Deprecated. Returns the treatment data currently associated to this interaction.
 boolean isScheduled()
          Deprecated. Returns true if this interaction was created when executing a callback.
 void markProcessed()
          Deprecated. Marks this interaction as processed in the Outbound Server.
 void reject()
          Deprecated. Rejects this outbound record.
 void removeOutboundListener(InteractionOutboundListener listener)
          Deprecated. Removes a listener from the outbound events of this interaction.
 void requestChainedRecords()
          Deprecated. Retrieves alternative data to connect to a customer.
 void setActiveRecord(java.lang.String recordId)
          Deprecated. Marks one of the records of this interaction as the active one.
 void setTreatment(InteractionVoiceOutbound.TreatmentType treatment)
          Deprecated. Sets the treatment data that will be associated with this interaction when it is marked done.
 
Methods inherited from interface com.genesyslab.ail.InteractionVoice
acceptPreview, alternateCall, alternateCall, alternateCall, answerCall, completeConference, completeConference, completeConference, completeTransfer, completeTransfer, completeTransfer, deleteFromConference, deleteFromConference, getANI, getCallType, getConferenceOwner, getConsultationInteractions, getDn, getDNIS, getDuration, getHomeLocation, getInitialInteraction, getNetworkLocation, getNetworkParty, getNetworkStatus, getParties, getPhoneNumber, getPhysicalDnId, getTCallId, getTrunk, holdCall, holdCall, initiateConference, initiateConference, initiateConference, initiateConference, initiateTransfer, initiateTransfer, initiateTransfer, initiateTransfer, isBridged, isConferenceOwner, isDualStepPossible, isIncoming, isNetworkControllingParty, isSingleStepPossible, leaveConference, leaveConference, listenDisconnect, listenReconnect, makeCall, makeCall, muteOff, muteOn, muteTransfer, muteTransfer, muteTransfer, networkAlternate, networkConference, networkConsult, networkReconnect, networkSingleStepTransfer, networkTransfer, reconnectCall, reconnectCall, reconnectCall, redirectCall, redirectCall, rejectPreview, releaseCall, retrieveCall, retrieveCall, sendDTMF, sendDTMF, setAttachedData, singleStepConference, singleStepConference, singleStepConference, singleStepTransfer, singleStepTransfer, singleStepTransfer
 
Methods inherited from interface com.genesyslab.ail.Interaction
answerCall, countOtherPendingInteractions, getContactId, getContentBinary, getContentBinaryMimeType, getContentBinarySize, getDateCreated, getEndDate, getMedia, getNotepad, getParentInteraction, getPlace, getQueue, getStatus, getStructTextMimeType, getStructuredText, getSubject, getText, getType, getUserName, isDone, markDone, merge, releaseCall, save, setContactId, setContentBinary, setContentBinaryMimeType, setContentBinarySize, setNotepad, setStructTextMimeType, setStructuredText, setSubject, setText
 
Methods inherited from interface com.genesyslab.ail.AbstractInteraction
addInteractionListener, getAttachedData, getAttachedData, getAttachedDataEx, getTConnectionId, queryStatus, removeAttachedData, removeInteractionListener, saveAttachedData, setAttachedData
 
Methods inherited from interface com.genesyslab.ail.Possible
arePossible, isPossible
 
Methods inherited from interface com.genesyslab.ail.Savable
getContactServerId, isDirty
 

Method Detail

addOutboundListener

void addOutboundListener(InteractionOutboundListener listener)
Deprecated. 
Adds a listener on the outbound events of this interaction.


removeOutboundListener

void removeOutboundListener(InteractionOutboundListener listener)
Deprecated. 
Removes a listener from the outbound events of this interaction.


markProcessed

void markProcessed()
                   throws RequestFailedException
Deprecated. 
Marks this interaction as processed in the Outbound Server. Data of active record will also be updated in database. This action ends the record processing in this interaction.

Throws:
InvalidStatusException - if the record is not in the correct status.
OutboundServiceException - if an error occurred in the Outbound Server.
TelephonyServiceException - if an error occurred in the T-Server.
RequestFailedException - if the request fails for other reason.

reject

void reject()
            throws RequestFailedException
Deprecated. 
Rejects this outbound record. The current record (preview or callback) will not be dialed by this agent. It should then be resent to another agent by the system. This action ends record processing in this interaction.

Throws:
InvalidStatusException - if the record is not in the correct status.
OutboundServiceException - if an error occurred in the Outbound Server.
TelephonyServiceException - if an error occurred in the T-Server.
RequestFailedException - if the request fails for other reason.

cancel

void cancel()
            throws RequestFailedException
Deprecated. 
Cancels this outbound record. An agent may decide, because of history or record data, that this contact (and all its chained records) does not need any call. The record will no longer be handled by the current campaign. This action ends record processing in this interaction.

Throws:
InvalidStatusException - if the record is not in the correct status.
OutboundServiceException - if an error occurred in the Outbound Server.
TelephonyServiceException - if an error occurred in the T-Server.
RequestFailedException - if the request fails for other reason.

doNotCall

void doNotCall(java.lang.String message)
               throws RequestFailedException
Deprecated. 
Prevents the current record (and all its chained records) from being dialed by any campaign (for instance because of contact request). This action ends record processing in this interaction.

Parameters:
message - a message to be written in the "Do Not Call" dedicated log.
Throws:
InvalidStatusException - if the record is not in the correct status.
OutboundServiceException - if an error occurred in the Outbound Server.
TelephonyServiceException - if an error occurred in the T-Server.
RequestFailedException - if the request fails for other reason.

addRecordToChain

void addRecordToChain(OutboundRecord newRecord)
                      throws RequestFailedException
Deprecated. 
Adds a new record at the end of the chained records currently handled by this interaction. A new record can be created using OutboundRecord.clone(java.lang.String). Note that the new record won't be returned by getRecords(), it has only been added to the calling list. You can call requestChainedRecords() to retrieve it as a normal chained record.

Throws:
InvalidStatusException - if the record is not in the correct status.
OutboundServiceException - if an error occurred in the Outbound Server.
TelephonyServiceException - if an error occurred in the T-Server.
RequestFailedException - if the request fails for other reason.

requestChainedRecords

void requestChainedRecords()
                           throws RequestFailedException
Deprecated. 
Retrieves alternative data to connect to a customer. It can be used when first number could not be correctly used or to retrieve newly added records of this chain.

Throws:
InvalidStatusException - if the record is not in the correct status.
OutboundServiceException - if an error occurred in the Outbound Server.
TelephonyServiceException - if an error occurred in the T-Server.
RequestFailedException - if the request fails for other reason.

getRecords

java.util.List getRecords()
Deprecated. 
Returns the outbound records attached to this interaction. The number of records can change along the life cycle of the interaction, which has one record at the initialization ('initial record'), and at least one record after calling requestChainedRecords().

Returns:
a list of OutboundRecord.

isScheduled

boolean isScheduled()
Deprecated. 
Returns true if this interaction was created when executing a callback.


setTreatment

void setTreatment(InteractionVoiceOutbound.TreatmentType treatment)
Deprecated. 
Sets the treatment data that will be associated with this interaction when it is marked done.

Parameters:
treatment - the treatment type.

getTreatment

InteractionVoiceOutbound.TreatmentType getTreatment()
Deprecated. 
Returns the treatment data currently associated to this interaction.


getOutboundStatus

InteractionVoiceOutbound.OutboundStatus getOutboundStatus()
Deprecated. 
Returns the outbound record handling status, which shows whether this interaction is still able to handle outbound related functions.


setActiveRecord

void setActiveRecord(java.lang.String recordId)
                     throws RequestFailedException
Deprecated. 
Marks one of the records of this interaction as the active one. It can then be retrieved by getActiveRecord(). It will be useful when calling markProcessed().

Parameters:
recordId - ID of a record (can be retrieved by IdObject.getId())
Throws:
InvalidStatusException - if the record is not in the correct status.
OutboundServiceException - if an error occurred in the Outbound Server.
TelephonyServiceException - if an error occurred in the T-Server.
RequestFailedException - if the request fails for other reason.

getActiveRecord

OutboundRecord getActiveRecord()
Deprecated. 
Returns the record that is marked as the active one within the list.


getRecord

OutboundRecord getRecord(java.lang.String recordId)
Deprecated. 
Returns the record handled by this interaction that is identified by this record ID.

Parameters:
recordId - Unique ID of a record (can be retrieved by IdObject.getId())