SmappStatePlugin class

This class represents the main class to be inherited by state that needs to be displayed on the Application Composer and State Editor, and to be invoked by the "Processing Engine" at runtime of an application.

Syntax

public class SmappStatePlugin

Base class/Interfaces

Derived classes

Members

All public members of the SmappStatePlugin class, including all inherited members.

Name	Description
getCurrentCustomer method	Current customer Customer of this session.
getInputAttributes method	Return the input attributes specified by the state.
getInstanceName method	Get the instance name.
getOutputAttributes method	Return the output attributes specified by the state.
getRevisionString method
getStateName method	The state name is used for display on the state editor.
getStateNotes method	The detailed description about the state, and documentations on how to use the state including the follow-up transitions.
isSelectable method	To indicate whether the state can be used as the follow-up state.
loadStateAttributes method	Default implementation is empty.
processMessage method	This method is called by the processing engine when the state is activated from external source, for example, incoming SMS message.
processState method	This method is always called by the processing engine when the state is activated by the follow-up transition.
setAckMessage method	Set the SMPP acknowledgement request flag for the current session.
setInstanceName method	Set the instance name.
shutdown method	No default implementation.
startup method	No default implementation.
supportEncryption method	Indicate whether this state support encryption.
supportsDynTransition method	Indicates if the state supports dynamic (Dyn) transition.
supportsFailTransition method	Indicate if the state uses the Fail follow-up transition type.
supportsGoToApplication method	Indicate if the state supports transfer flow to another application.
supportsOkTransition method	Indicate if the state uses the OK follow-up transition type.
supportsSendSmsMessage method	Indicate if the state may send SMS message to the current consumer.

All package members of the SmappStatePlugin class, including all inherited members.

Name	Description
getStateId method	The state unique ID.

All protected members of the SmappStatePlugin class, including all inherited members.

Name	Description
continueDyn method	Helper method in state development.
continueFail method	Helper method in state development.
continueOk method	Helper method in state development.
determineFollowingSmappStateFromPattern method	Determine the follow-up transition that match the message in the state processing context.
determineFollowingSmappStateFromTransitionType method	Determine the follow-up transition that match the type provided in the input parameter.
getSessionAttributeForKey method	Get the value of session attribute (SessionAttribute) based on the specified key.
getSessionAttributes method	Get session attributes for the current state in the current session.
getSessionId method	Session ID that the application is running.
getSmsText18nReplaced method	Process the SMS message by replacing all the session variables with the actual session variable value.
getStateAttributes method	Returns all the attributes (input and output) specified in the state.
handleFatal method	Helper method in state development.
isCurrentStateEncrypted method	Indicate whether the current state is encrypted.
processMessageLogic method	Delegate method call by the processMessage(SmappStateProcessingContext).
processStateLogic method	Delegate method call by the processState(SmappStateProcessingContext, SmappStateProcessingAction).
saveOutputAttributes method	Saving attributes that has holdValue (see OutputAttribute#getHoldValue()) in bulk for better performance.
saveSessionAttribute method	Save the input parameters to the session attribute (SessionAttribute).
saveSessionAttributes method	Save the session attributes in the Map of the current state in the current session to database.
sendSmappSms method	Send SMS from the current session.
instanceName variable	Instance name.

Remarks

As such it should be regarded as the 'external' API. Any class that extends this class will be called State for the purpose of the API documentation.

There are a significant number of infrastructure functionalities performed by this base class that simplify the state development, including extra methods to allow processing of input and output attribute values and session variables.

Please refer to StatePlugin for more detailed description of the processing engine life cycle.

continueDyn method
continueFail method
continueOk method
determineFollowingSmappStateFromPattern method
determineFollowingSmappStateFromTransitionType method
getCurrentCustomer method
getInputAttributes method
getOutputAttributes method
getSessionAttributeForKey method
getSessionAttributes method
getSessionId method
getSmsText18nReplaced method
getStateAttributes method
getStateNotes method
handleFatal method
isCurrentStateEncrypted method
isSelectable method
loadStateAttributes method
processMessage method
processMessageLogic method
processState method
processStateLogic method
saveOutputAttributes method
saveSessionAttribute method
saveSessionAttributes method
sendSmappSms method
setAckMessage method
shutdown method
startup method
supportEncryption method
supportsDynTransition method
supportsFailTransition method
supportsGoToApplication method
supportsOkTransition method
supportsSendSmsMessage method

Discuss this page in DocCommentXchange.