Skip navigation links

com.oracle.sft.api
Interface EndUserConfirmationData

public interface EndUserConfirmationData

Represents the Data Structure for End User Confirmation Request, End User Confirmation Response, End User Confirmation Acknowledgement in End User Confirmation exchange ,

See Also:

EndUserConfirmationData

Nested Class Summary

static class	EndUserConfirmationData.Behaviour to determine the behaviour the receiving handset in End User Confirmation Request
static class	EndUserConfirmationData.UserAction The action of the ender user in End User Confirmation Response
static class	EndUserConfirmationData.UserStatus The statue of the ender user in End User Confirmation Acknowledgement

Method Summary

EndUserConfirmationDisplay	createDisplayText(String subject, String text, String language) to create the subject/text sequence to display on end user client
EndUserConfirmationDisplay	getAcknowledgementText(String language) to get a language-matching acknowledgement to display In case that there is no language matching one, the first node of Subject and Text shall be returned*
String	getAction() to get user action from End User Confirmation Response
String	getBehaviour() to get behaviour type of End User Confirmation Request
EndUserConfirmationDisplay	getConditionText(String language) to get a language-matching condition to display In case that there is no language matching one, the first node of Subject and Text shall be returned
String	getId() to get End User Confirmation message id
String	getPin() to get PIN from End User Confirmation Response
String	getStatus() to get status from End User Confirmation Acknowledgement
boolean	isPinRequired() to get whether PIN is required
void	setAcknowledgement(EndUserConfirmationDisplay displayText) to add an acknowledgement description
void	setAcknowledgement(List<EndUserConfirmationDisplay> displayTexts) to set acknowledgement descriptions with multiple subject/text sequences
void	setAction(EndUserConfirmationData.UserAction action) to accept or decline in End User Confirmation Response
void	setBehaviour(EndUserConfirmationData.Behaviour behaviour) to set behaviour type of End User Confirmation Request
void	setCondition(EndUserConfirmationDisplay displayText) to add a request condition description
void	setCondition(List<EndUserConfirmationDisplay> displayTexts) to set request condition descriptions with the multiple subject/text sequences
void	setId(String id) to set End User Confirmation message id
void	setPin(String value) to set Pin in End User Confirmation Response
void	setPinRequired(boolean required) to set whether PIN is required
void	setStatus(EndUserConfirmationData.UserStatus status) to set Status to End User Confirmation Acknowledgement

Method Detail

setId

void setId(String id)

to set End User Confirmation message id

Parameters:

id -

getId

String getId()

to get End User Confirmation message id

Returns:

String

setBehaviour

void setBehaviour(EndUserConfirmationData.Behaviour behaviour)

to set behaviour type of End User Confirmation Request

Parameters:

behaviour - : Volatile or Persistent

getBehaviour

String getBehaviour()

to get behaviour type of End User Confirmation Request

Returns:

String

setPinRequired

void setPinRequired(boolean required)

to set whether PIN is required

Parameters:

required - : "true" or "false"

isPinRequired

boolean isPinRequired()

to get whether PIN is required

Returns:

two values : "true" or "false"

setAction

void setAction(EndUserConfirmationData.UserAction action)

to accept or decline in End User Confirmation Response

Parameters:

action - : Accept or Decline

getAction

String getAction()

to get user action from End User Confirmation Response

Returns:

String

setPin

void setPin(String value)

to set Pin in End User Confirmation Response

Parameters:

value - : String

getPin

String getPin()

to get PIN from End User Confirmation Response

Returns:

String

setStatus

void setStatus(EndUserConfirmationData.UserStatus status)

to set Status to End User Confirmation Acknowledgement

Parameters:

status - : UserStatus

getStatus

String getStatus()

to get status from End User Confirmation Acknowledgement

Returns:

String

createDisplayText

EndUserConfirmationDisplay createDisplayText(String subject,
                                             String text,
                                             String language)

to create the subject/text sequence to display on end user client

Parameters:

subject - : String

text - : String

language - :String of two letter language code according to the ISO 639-1, such as "en","zh"

Returns:

EndUserConfirmationDisplay

setCondition

void setCondition(List<EndUserConfirmationDisplay> displayTexts)

to set request condition descriptions with the multiple subject/text sequences

Parameters:

displayTexts - : the list of EndUserConfirmationDisplay

setAcknowledgement

void setAcknowledgement(List<EndUserConfirmationDisplay> displayTexts)

to set acknowledgement descriptions with multiple subject/text sequences

Parameters:

displayTexts -

setCondition

void setCondition(EndUserConfirmationDisplay displayText)

to add a request condition description

Parameters:

displayText - : EndUserConfirmationDisplay object

setAcknowledgement

void setAcknowledgement(EndUserConfirmationDisplay displayText)

to add an acknowledgement description

Parameters:

displayText - : EndUserConfirmationDisplay object

getConditionText

EndUserConfirmationDisplay getConditionText(String language)

to get a language-matching condition to display In case that there is no language matching one, the first node of Subject and Text shall be returned

Parameters:

language - :String of two letter language code according to the ISO 639-1, such as "en","zh"

Returns:

EndUserConfirmationDisplay: the language-matching EndUserConfirmationDisplay

getAcknowledgementText

EndUserConfirmationDisplay getAcknowledgementText(String language)

to get a language-matching acknowledgement to display In case that there is no language matching one, the first node of Subject and Text shall be returned*

Parameters:

language - : String of two letter language code according to the ISO 639-1, such as "en","zh"

Returns:

EndUserConfirmationDisplay: the language-matching EndUserConfirmationDisplay

Skip navigation links