|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arunta.app.bom.Recording
public class Recording
Bean which contains meta data for recordings of calls created by a Total Recall system.
Constructor Summary | |
---|---|
Recording()
Creates an instance with all fields initialised with invalid values. |
|
Recording(Recording other)
Creates an instance that is a copy of another. |
|
Recording(short channelNumber)
Creates an instance which is initialised with the specified recorder channel number and the current date and time. |
|
Recording(short channelNumber,
java.util.Date date)
Creates an instance which is initialised with the specified recorder channel number and date and time. |
|
Recording(java.lang.String fileName,
short channelNumber,
java.util.Date date)
Creates an instance which is initialised with the specified recording file name, recorder channel number and call start date and time. |
Method Summary | |
---|---|
void |
addToCallLength(int milliseconds)
Adds the specified number of milliseconds to the current call length. |
void |
clearLocked()
Clears the locked (do-not-delete) flag. |
void |
clearTimedOut()
Clears the roll-over timeout as the reason for the end of the recording of this call. |
java.lang.String |
getAgentName()
|
short |
getAttributes()
Use one of isDamaged() , isTimedOut() or
isContinued() instead. |
short |
getAudioEncoding()
|
int |
getCallDirection()
|
long |
getCallLength()
|
short |
getChannelNumber()
|
int |
getChecksum()
|
long |
getDbKey()
|
java.lang.String |
getDisplayCallLength()
|
java.lang.String |
getDtmfDigits()
|
java.lang.String |
getEncodedFileName()
|
java.lang.String |
getEncodedNotes()
|
java.lang.String |
getFileName()
|
java.lang.String |
getFromExtension()
|
long |
getLabels()
Do not use. |
java.lang.String |
getMapFromCli()
|
java.lang.String |
getMapToCli()
|
java.lang.String |
getNotes()
|
java.lang.String |
getRawFromCli()
|
java.lang.String |
getRawToCli()
|
java.lang.String |
getRecorderID()
|
java.lang.String |
getStartDate()
|
java.lang.String |
getStartDateGMT()
|
java.util.Date |
getStartDateTime()
|
java.lang.String |
getStartTime()
|
java.lang.String |
getStartTimeGMT()
|
java.lang.String |
getStringHeader()
|
java.lang.String |
getToExtension()
|
java.lang.String |
getUniqueFileName()
|
boolean |
isArchived()
|
boolean |
isContinued()
|
boolean |
isCurrentCall()
|
boolean |
isDamaged()
|
boolean |
isIncoming()
|
boolean |
isInternal()
|
boolean |
isLocked()
|
boolean |
isMonitored()
|
boolean |
isOutgoing()
|
boolean |
isSameAs(Recording rec)
Quick comparator. |
boolean |
isTagged()
|
boolean |
isTimedOut()
|
void |
setAgentName(java.lang.String agentName)
Sets the name of the agent that processed the call. |
void |
setArchived(boolean archived)
Sets the archived flag. |
void |
setAttributes(short attributes)
Use one of setDamaged() , setTimedOut() or
setContinued() instead. |
void |
setAudioEncoding(short audioEncoding)
Sets the audio encoding format. |
void |
setCallDirection(int callDirection)
Sets the call direction. |
void |
setCallLength(long callLength)
Sets the length (duration) of the call in milliseconds. |
void |
setChannelNumber(short channelNumber)
Sets the recorder channel number used to recored the call. |
void |
setChecksum(int checksum)
Sets the checksum of the bytes stored in the recording file. |
void |
setContinued()
Mark this recording as continuation of others due to roll-over timeout. |
void |
setCurrentCall(boolean current)
Sets the current call flag. |
void |
setDamaged()
Mark the recording of the call as damaged. |
void |
setDbKey(long dbKey)
Sets the database record id. |
void |
setDtmfDigits(java.lang.String dtmfDigits)
Sets the DTMF digits that were detected during the call. |
void |
setFileName(java.lang.String fileName)
Sets the file name of the file which contains the recording of the call. |
void |
setFromExtension(java.lang.String fromExtension)
Sets the calling extension number. |
void |
setLabels(long labels)
Do not use. |
void |
setLocked()
Set the locked (do-not-delete) flag. |
void |
setMapFromCli(java.lang.String mapFromCli)
Sets the calling number after it has gone through the signalling map on the Total Recall VR system. |
void |
setMapToCli(java.lang.String mapToCli)
Sets the called number after it has gone through the signalling map on the Total Recall VR system. |
void |
setMonitored(boolean monitored)
Sets the monitored flag. |
void |
setNotes(java.lang.String notes)
Sets the notes for the call. |
void |
setRawFromCli(java.lang.String rawFromCli)
Sets the calling number as it appears in the signalling messages. |
void |
setRawToCli(java.lang.String rawToCli)
Sets the called number as it appears in the signalling messages. |
void |
setRecorderID(java.lang.String recorderID)
Sets the ID of the Total Recall VR system which created this recording. |
void |
setStartDateTime(java.util.Date startDateTime)
Sets the date and time when the call started. |
void |
setTagged(boolean tagged)
Sets the tagged flag. |
void |
setTimedOut()
Set the roll-over timeout as the reason for the end of the recording of this call. |
void |
setToExtension(java.lang.String toExtension)
Sets the called extension number. |
java.lang.String |
toSmdrString()
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Recording()
public Recording(java.lang.String fileName, short channelNumber, java.util.Date date)
In addition, it sets the call direction to unknown.
fileName
- Fully qualified file name of the file which will contain the
media of a call.channelNumber
- The number of the recorder channel which is used to capture the
call.date
- The start date and time of the call.public Recording(short channelNumber)
In addition, it sets the call direction to unknown.
channelNumber
- The number of the recorder channel which is used to capture the
call.public Recording(short channelNumber, java.util.Date date)
In addition, it sets the call direction to unknown.
channelNumber
- The number of the recorder channel which is used to capture the
call.date
- The start date and time of the call.public Recording(Recording other)
other
- The instance to copy.Method Detail |
---|
public java.lang.String getStringHeader()
public void setDbKey(long dbKey)
dbKey
- A database primary key.public long getDbKey()
public void setFileName(java.lang.String fileName)
fileName
- A fully qualified file name.public java.lang.String getFileName()
public java.lang.String getEncodedFileName()
DBCodec
.public void setChannelNumber(short channelNumber)
channelNumber
- A recorder channel number.public short getChannelNumber()
public void setCallDirection(int callDirection)
callDirection
- 0 for incoming call.
1 for outgoing call.
2 for internal call.
3 for unknown.public int getCallDirection()
public boolean isIncoming()
true
if this is a recording of an incoming call.
false
otherwise.public boolean isOutgoing()
true
if this is a recording of an outgoing call.
false
otherwise.public boolean isInternal()
true
if this is a recording of an internal call.
false
otherwise.public void setStartDateTime(java.util.Date startDateTime)
startDateTime
- A date and time in the current time zone of the Total Recall VR system.public java.util.Date getStartDateTime()
public java.lang.String getStartDate()
public java.lang.String getStartDateGMT()
public java.lang.String getStartTime()
public java.lang.String getStartTimeGMT()
public void setRawToCli(java.lang.String rawToCli)
rawToCli
- A phone number.public java.lang.String getRawToCli()
public void setRawFromCli(java.lang.String rawFromCli)
rawFromCli
- A phone number.public java.lang.String getRawFromCli()
public void setMapToCli(java.lang.String mapToCli)
Consult the Total Recall VR Administration and Installation documentation on how to configure signalling maps.
mapToCli
- A number, agent name, extension owner etc.public java.lang.String getMapToCli()
public void setMapFromCli(java.lang.String mapFromCli)
Consult the Total Recall VR Administration and Installation documentation on how to configure signalling maps.
mapFromCli
- A number, agent name, extension owner etc.public java.lang.String getMapFromCli()
public void setFromExtension(java.lang.String fromExtension)
Consult the Total Recall VR Administration and Installation documentation on how to configure the internal dial plan.
fromExtension
- A number, agent name, extension owner etc.public java.lang.String getFromExtension()
public void setToExtension(java.lang.String toExtension)
Consult the Total Recall VR Administration and Installation documentation on how to configure the internal dial plan.
toExtension
- A number, agent name, extension owner etc.public java.lang.String getToExtension()
public void setNotes(java.lang.String notes)
notes
- Any string with any content of up to 256 characters.public java.lang.String getNotes()
public java.lang.String getEncodedNotes()
public void setCallLength(long callLength)
callLength
- Duration in milliseconds.public long getCallLength()
public void addToCallLength(int milliseconds)
milliseconds
- Number of milliseconds to add to the call length.public java.lang.String getDisplayCallLength()
public void setCurrentCall(boolean current)
current
- Set it to true
if the call is still in progress. Set
it to false
otherwise.public boolean isCurrentCall()
true
if this instance represents a call which is in
progress. false
otherwise.public void setTagged(boolean tagged)
tagged
- Set it to true
if the record is tagged. Set
it to false
otherwise.public boolean isTagged()
true
if this instance represents a record which is
tagged. false
otherwise.public void setArchived(boolean archived)
archived
- Set it to true
if the record has been archived. Set
it to false
otherwise.public boolean isArchived()
true
if this instance represents an archived record.
false
otherwise.public void setMonitored(boolean monitored)
monitored
- Set it to true
if the call is still in progress and is
being monitored. Set it to false
otherwise.public boolean isMonitored()
true
if this instance represents a call which is in
progress and is being monitored. false
otherwise.public void setAttributes(short attributes)
setDamaged()
, setTimedOut()
or
setContinued()
instead.
attributes
- Combined attributes.public short getAttributes()
isDamaged()
, isTimedOut()
or
isContinued()
instead.
public void setDamaged()
public boolean isDamaged()
true
if the recording of the call is damaged.
false
otherwise.public void setTimedOut()
public boolean isTimedOut()
true
if the recording of the call ended due to a roll
over timeout.
false
otherwise.public void clearTimedOut()
public void setContinued()
public boolean isContinued()
true
if the recording of the call is a continuation
of other due to a roll over timeout.
false
otherwise.public void setLocked()
public boolean isLocked()
true
if the recording is locked.
false
otherwise.public void clearLocked()
public void setRecorderID(java.lang.String recorderID)
Consult the Total Recall VR Administration and Installation documentation on how to configure the ID of a Total Recall VR system.
recorderID
- A Total Recall VR system ID.public java.lang.String getRecorderID()
public void setAudioEncoding(short audioEncoding)
audioEncoding
- -1 for invalid format.
0 for unknown format.
1 for HQVQ format.
2 for PCM format.
3 for SPEEX format.
4 for G.711 A-law format.
5 for G.711 U-law format.
6 for G.722 format.
7 for G.723 format.
8 for G.729 format.public short getAudioEncoding()
public void setChecksum(int checksum)
checksum
- A valid checksum.public int getChecksum()
public void setAgentName(java.lang.String agentName)
Consult the Total Recall VR Administration and Installation documentation on how to configure agent names.
agentName
- Valid agent name.public java.lang.String getAgentName()
null
otherwise.public void setLabels(long labels)
labels
- public long getLabels()
public void setDtmfDigits(java.lang.String dtmfDigits)
dtmfDigits
- A set of valid DTMF digits: [0-9,A,B,C,D,*,#].public java.lang.String getDtmfDigits()
null
otherwise.public boolean isSameAs(Recording rec)
rec
- A recording to compare with this one.
false
otherwise.public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toSmdrString()
public java.lang.String getUniqueFileName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |