Skip navigation links

com.oracle.sft.api.context
Interface HistoryElement

public interface HistoryElement

This class represents an element of call diversion history. It gives all the information about the previous call diversions. SFT runtime will insert an instance of this interface, each time the call is diverted.

Method Summary

ReasonData	getAlternateReasonData() A History element can have an alternate reason, which is embedded in the message.
int[]	getIndexAsArray() An index of the History is of the ABNF format 1*DIGIT *(DOT 1*DIGIT).
String	getIndexString() Get the index of this call diversion history element.
Set<Map.Entry<String,String>>	getParameters() Method that retrieve all the parameters as a Set of name-value pairs.
ReasonData	getReasonData() The reason associated with this call diversion history element.
String	getTargetHost() The host involved in the call diversion.
String	getTargetUser() The specific user involved in the call diversion.

Method Detail

getTargetUser

String getTargetUser()

The specific user involved in the call diversion.

Returns:

User involved in this call diversion element.

getTargetHost

String getTargetHost()

The host involved in the call diversion.

Returns:

Host involved in this call diversion element.

getReasonData

ReasonData getReasonData()

The reason associated with this call diversion history element.

Returns:

An instance of ReasonData. This may be null.

See Also:

ReasonData

getAlternateReasonData

ReasonData getAlternateReasonData()

A History element can have an alternate reason, which is embedded in the message.

Returns:

An instance of ReasonData. This may be null.

See Also:

ReasonData

getIndexString

String getIndexString()

Get the index of this call diversion history element.

Returns:

a String in ABNF format 1*DIGIT *(DOT 1*DIGIT)

getIndexAsArray

int[] getIndexAsArray()

An index of the History is of the ABNF format 1*DIGIT *(DOT 1*DIGIT). This method is a utility method that retrieves the index numbers as an array. For example, if the index string is 2.3.6.1.2, then, this would return, an array int[] {2,3,6,1,2}.

Returns:

An int array of the index numbers.

getParameters

Set<Map.Entry<String,String>> getParameters()

Method that retrieve all the parameters as a Set of name-value pairs.

Returns:

A Set of the parameters in the history element.

Skip navigation links