|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface OutboundRecord
Describes the contact of an outbound campaign.
| Nested Class Summary | |
|---|---|
static class |
OutboundRecord.Action
Actions that are possible on an outbound record. |
static class |
OutboundRecord.CallbackType
Constants for the different types of callback. |
static class |
OutboundRecord.CallResult
Enum for the possible results of the call handling. |
static class |
OutboundRecord.PhoneType
Constants for the phone types. |
static class |
OutboundRecord.Status
Constants describing the status of a record. |
| Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject |
|---|
IdObject.ObjectType |
| Method Summary | |
|---|---|
void |
cancel()
Determines that this record (and only this one) does not need any call. |
OutboundRecord |
clone(java.lang.String phoneNumber)
Returns a copy of this record. |
void |
doNotCall(java.lang.String reason)
Prevents this record (and only this one) from being dialed by any campaign. |
java.lang.String |
getCallingListName()
Returns the name of the current calling list. |
OutboundRecord.CallResult |
getCallResult()
Returns the result of this call. |
OutboundCampaignInfo |
getCampaignInfo()
Returns the campaign that handles this record. |
java.lang.String |
getContactMediaType()
Returns the contact's media type. |
java.lang.Object |
getCustomField(java.lang.String field_name)
Returns the object associated with this parameter. |
java.util.Map |
getCustomFields()
Returns the custom fields for this record. |
java.lang.Integer |
getDailyFrom()
Returns the beginning of the time frame when this contact can be called, in seconds from midnight. |
java.lang.Integer |
getDailyTill()
Returns the end of the time frame when this contact can be called, in seconds from midnight. |
OutboundChain |
getOutboundChain()
Returns the OutboundChain this record belongs to or null. |
java.lang.String |
getPhone()
Returns the phone number for this record. |
OutboundRecord.PhoneType |
getPhoneType()
Returns the phone type for this record or null if not available. |
int |
getRecordHandle()
Returns an integer used as an ID (handle) for this record. |
OutboundRecord.Status |
getStatus()
Returns the current status of this record. |
java.lang.String |
getTimeZone()
Returns the time zone ID, or null if not available. |
int |
getTimeZoneOffset()
Returns an integer value for the timezone offset from GMT, in hours. |
void |
reschedule(java.util.Calendar calendar,
OutboundRecord.CallbackType callbackType)
Reschedules a call for later. |
void |
setCallResult(OutboundRecord.CallResult result)
Sets the result of the current call for this current record. |
void |
setCustomField(java.lang.String field_name,
java.lang.Object value)
Sets a custom field in the record and updates it in the Outbound Contact Server. |
void |
setCustomField(java.lang.String field_name,
java.lang.Object value,
boolean update)
Sets a custom field in the record. |
void |
setDailyFrom(java.lang.Integer from)
Sets the beginning of the time frame when this contact can be called, in seconds from midnight. |
void |
setDailyTill(java.lang.Integer till)
Sets the end of the time frame when this contact can be called, in seconds from midnight. |
void |
setPhone(java.lang.String phone_number)
Sets the phone number of the customer in the phone field of the current record. |
void |
setPhoneType(OutboundRecord.PhoneType phoneType)
Sets the phone type. |
void |
setTimeZone(java.lang.String timeZoneID)
Sets the time zone ID, which have already been declared in the Configuration Layer. |
void |
setTimeZoneOffset(int offset)
Deprecated. Use setTimeZone(String) instead. |
void |
update()
Requests an update of this record with the values of the Outbound Contact Server database. |
| Methods inherited from interface com.genesyslab.ail.Possible |
|---|
arePossible, isPossible |
| Methods inherited from interface com.genesyslab.ail.IdObject |
|---|
getId, getObjectType |
| Method Detail |
|---|
OutboundRecord.Status getStatus()
void update()
throws RequestFailedException
OutboundServiceException - if an error is reported by the Outbound Server.
InvalidStatusException - if the record is not in OPEN status.
RequestFailedException
void reschedule(java.util.Calendar calendar,
OutboundRecord.CallbackType callbackType)
throws RequestFailedException
calendar - A calendar object where time is set to the required date of the callback and
time zone must be set to GMT. The time should be set in the customer's timezone.callbackType - the type of the callback.
OutboundServiceException - if an error is reported by the Outbound Server.
InvalidStatusException - if the record is not in OPEN status.
RequestFailedException
void cancel()
throws RequestFailedException
OutboundServiceException - if an error is reported by the Outbound Server.
RequestFailedException
void doNotCall(java.lang.String reason)
throws RequestFailedException
reason - a message to be written in the "Do Not Call" dedicated log.
OutboundServiceException - if an error is reported by the Outbound Server.
RequestFailedExceptionOutboundRecord clone(java.lang.String phoneNumber)
OutboundChain.addRecordToChain(com.genesyslab.ail.OutboundRecord).
phoneNumber - the phone number of the new record.OutboundCampaignInfo getCampaignInfo()
int getRecordHandle()
java.lang.String getCallingListName()
OutboundRecord.CallResult getCallResult()
java.lang.String getPhone()
OutboundRecord.PhoneType getPhoneType()
int getTimeZoneOffset()
java.lang.Object getCustomField(java.lang.String field_name)
java.util.Map getCustomFields()
Map (String, Object).java.lang.String getTimeZone()
java.lang.Integer getDailyFrom()
java.lang.Integer getDailyTill()
java.lang.String getContactMediaType()
void setCallResult(OutboundRecord.CallResult result)
void setPhone(java.lang.String phone_number)
phone_number - the phone number to setvoid setTimeZoneOffset(int offset)
setTimeZone(String) instead.
offset - the offset from Greenwich Meridian Time
void setCustomField(java.lang.String field_name,
java.lang.Object value)
throws RequestFailedException
field_name - the name of the record to update.value - the new value of this record.
InvalidParameterException - if the value is null, or does
not have the correct type or if the field_name does not already exists.
InvalidStatusException - if the record is not in OPEN status
OutboundServiceException - if an error is reported by the Outbound Server.
RequestFailedException
void setCustomField(java.lang.String field_name,
java.lang.Object value,
boolean update)
throws RequestFailedException
update=false, this method allows you to
set several fields with only one update in the OCS.
field_name - the name of the record to update.value - the new value of this record.update - Indicates whether this modification should be applied into the OCS. If
false, you must call update() in order to apply the modification in the
OCS.
InvalidParameterException - if the value is null, or does
not have the correct type or if the field_name does not already exists.
InvalidStatusException - when update=true if the record is not in OPEN status.
OutboundServiceException - if an error is reported by the Outbound Server.
RequestFailedExceptionvoid setTimeZone(java.lang.String timeZoneID)
void setPhoneType(OutboundRecord.PhoneType phoneType)
void setDailyFrom(java.lang.Integer from)
void setDailyTill(java.lang.Integer till)
OutboundChain getOutboundChain()
null.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||