Interface TransactionMessage
public interface TransactionMessage
This interface is used for transaction specific messages.
-
Method Summary
Modifier and TypeMethodDescriptionGet the message class defined in the back end.get the message number defined in the back end.Determine the message long text.getMessageLongText(Locale locale) Determine the message text for the given locale.Retrieves message long textgetMsgId()getMsgNo()getMsgV1()getMsgV2()getMsgV3()getMsgV4()intgetType()Retrieves message type (like error, warning)booleanisError()Checks if this message is an error.booleanvoidsetBeMessageClass(String beMessageClass) voidsetBeMessageNumber(String beMessageNumber) voidsetCheckoutStepElement(String checkoutStepElement) voidsetMsgHide(boolean msgHide) voidvoidvoidsetMsgType(String msgType) voidvoidvoidvoidvoidsetResourceKeyLongtext(String resourceKeyLongtext)
-
Method Details
-
getBEMessageClass
String getBEMessageClass()Get the message class defined in the back end.- Returns:
- the beMessageClass
-
getBEMessageNumber
String getBEMessageNumber()get the message number defined in the back end.- Returns:
- the beMessageNumber
-
getCheckoutStepElement
String getCheckoutStepElement()- Returns:
- the checkoutStepElement
-
getMessageLongText
String getMessageLongText()Determine the message long text.- Returns:
- message text
-
getMessageLongText
Determine the message text for the given locale.- Parameters:
locale- locale to get the correct translation.- Returns:
- message text
-
getMsgId
String getMsgId()- Returns:
- the msgId
-
getMsgNo
String getMsgNo()- Returns:
- the msgNo
-
getMsgType
String getMsgType()- Returns:
- the msgType
-
getMsgV1
String getMsgV1()- Returns:
- the msgV1
-
getMsgV2
String getMsgV2()- Returns:
- the msgV2
-
getMsgV3
String getMsgV3()- Returns:
- the msgV3
-
getMsgV4
String getMsgV4()- Returns:
- the msgV4
-
getResourceKeyLongtext
String getResourceKeyLongtext()- Returns:
- the resourceKeyLongtext
-
isError
boolean isError()Checks if this message is an error.- Returns:
- true if this message is an error
-
isMsgHide
boolean isMsgHide()- Returns:
- the msgHide
-
setBeMessageClass
- Parameters:
beMessageClass- the beMessageClass to set
-
setBeMessageNumber
- Parameters:
beMessageNumber- the beMessageNumber to set
-
setCheckoutStepElement
- Parameters:
checkoutStepElement- the checkoutStepElement to set
-
setMsgHide
void setMsgHide(boolean msgHide) - Parameters:
msgHide- the msgHide to set
-
setMsgId
- Parameters:
msgId- the msgId to set
-
setMsgNo
- Parameters:
msgNo- the msgNo to set
-
setMsgType
- Parameters:
msgType- the msgType to set
-
setMsgV1
- Parameters:
msgV1- the msgV1 to set
-
setMsgV2
- Parameters:
msgV2- the msgV2 to set
-
setMsgV3
- Parameters:
msgV3- the msgV3 to set
-
setMsgV4
- Parameters:
msgV4- the msgV4 to set
-
setResourceKeyLongtext
- Parameters:
resourceKeyLongtext- the resourceKeyLongtext to set
-
getType
int getType()Retrieves message type (like error, warning)- Returns:
- message type
-
getMessageText
String getMessageText()Retrieves message long text- Returns:
- message long text
-