public interface DataI
DataI
object represents attached data on a contact in the Contact Center associated with an InteractionI
object.
The data stored in this object can be one of three DataFormat
values;
DataFormat.BIN
: binary data stored in a byte arrayDataFormat.STR
: textual data stored in a stringDataFormat.KVP
: key value pair data stored in a map
The client application can use the static factory methods on this object to create a DataI
object with content in one
of the three formats specified above. Creating a DataI
object would be a precursor to invoking
InteractionI.setData(com.avaya.ccs.api.DataI)
.
Modifier and Type | Method and Description |
---|---|
static DataI |
create(byte[] binData)
A factory method to create a
DataI object containing binary data represented by a byte array. |
static DataI |
create(java.util.Map<java.lang.String,java.lang.String> kvpData)
A factory method to create a
DataI object containing key value pair data represented in a map. |
static DataI |
create(java.lang.String strData)
A factory method to create a
DataI object containing string data. |
byte[] |
getBinaryData()
If
getFormat() returns DataFormat.BIN , this DataI object will contain binary data which can be
retrieved by this method. |
DataFormat |
getFormat() |
java.util.Map<java.lang.String,java.lang.String> |
getKvpData()
If
getFormat() returns DataFormat.KVP , this DataI object will contain key value pair data which
can be retrieved by this method. |
java.lang.String |
getStringData()
If
getFormat() returns DataFormat.STR , this DataI object will contain string data which can be
retrieved by this method. |
DataFormat getFormat()
DataFormat
of the data stored in this objectbyte[] getBinaryData()
getFormat()
returns DataFormat.BIN
, this DataI
object will contain binary data which can be
retrieved by this method.java.util.Map<java.lang.String,java.lang.String> getKvpData()
getFormat()
returns DataFormat.KVP
, this DataI
object will contain key value pair data which
can be retrieved by this method.java.lang.String getStringData()
getFormat()
returns DataFormat.STR
, this DataI
object will contain string data which can be
retrieved by this method.null
if string data is not stored in this objectstatic DataI create(java.util.Map<java.lang.String,java.lang.String> kvpData) throws InvalidArgumentException
DataI
object containing key value pair data represented in a map.kvpData
- a map of key value pair data to be stored in this objectDataI
object representing the supplied kvp dataInvalidArgumentException
- if the map argument is null
or emptystatic DataI create(java.lang.String strData) throws InvalidArgumentException
DataI
object containing string data.strData
- a string containing textual data to be stored in this objectDataI
object representing the supplied string dataInvalidArgumentException
- if the string argument is null
or emptystatic DataI create(byte[] binData) throws InvalidArgumentException
DataI
object containing binary data represented by a byte array.binData
- a byte array containing binary data to be stored in this objectDataI
object representing the supplied binary dataInvalidArgumentException
- if the byte array argument is null
or empty