Package org.cyclos.impl.utils.sms

Class CustomSmsOperation

java.lang.Object

org.cyclos.impl.utils.sms.BaseSmsOperation

org.cyclos.impl.utils.sms.CustomSmsOperation

All Implemented Interfaces:

SmsOperation

public class CustomSmsOperation
extends BaseSmsOperation

SMS operation which delagates to a script

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.impl.utils.sms.BaseSmsOperation

BaseSmsOperation.BaseError

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_CONFIGURATION	Script attribute: the SmsOperationConfiguration
static String	ATTR_PARAMETER_PROCESSOR	Script attribute: the SMS data for the current inbound SMS
static String	ATTR_PHONE	Script attribute: the resolved phone in Cyclos which received the operation
static String	ATTR_SMS	Script attribute: the SMS data for the current inbound SMS
static String	FUNCTION_NAME	The function name called on scripts

Fields inherited from class org.cyclos.impl.utils.sms.BaseSmsOperation

accountHandler, agreementLogService, configurationHandler, conversionHandler, dataTranslationHandler, entityManagerHandler, invokerHandler, outboundSmsHandler, passwordHandler, profileFieldHandler, translationHandler, userLocatorHandler

Constructor Summary

Constructors

Constructor	Description
CustomSmsOperation()

Method Summary

Modifier and Type	Method	Description
protected void	checkParametersCount(SmsOperationConfiguration operationConfiguration, List<String> parameters)	This method must be implemented to check the minimum and maximum expected parameters
protected void	doExecute(SmsOperationConfiguration operationConfiguration, MobilePhone phone, InboundSmsData sms, SmsParameterProcessor processor)
protected List<String>	getHelpComponents(SmsOperationConfiguration operationConfiguration)
SmsOperationExecution	getOperationExecution(SmsOperationConfiguration operationConfiguration)	Returns who can execute this operation

Methods inherited from class org.cyclos.impl.utils.sms.BaseSmsOperation

execute, formatShort, getFormatter, getHelp, getLongestAlias, getSessionData, handleError, message, sendEvenIfDisabled, sendResponse, sendToUnregistered

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FUNCTION_NAME

public static final String FUNCTION_NAME

The function name called on scripts

See Also:

Constant Field Values

ATTR_CONFIGURATION

public static final String ATTR_CONFIGURATION

Script attribute: the SmsOperationConfiguration

See Also:

Constant Field Values

ATTR_PHONE

public static final String ATTR_PHONE

Script attribute: the resolved phone in Cyclos which received the operation

See Also:

Constant Field Values

ATTR_SMS

public static final String ATTR_SMS

Script attribute: the SMS data for the current inbound SMS

See Also:

Constant Field Values

ATTR_PARAMETER_PROCESSOR

public static final String ATTR_PARAMETER_PROCESSOR

Script attribute: the SMS data for the current inbound SMS

See Also:

Constant Field Values

Constructor Detail

CustomSmsOperation

public CustomSmsOperation()

Method Detail

getOperationExecution

public SmsOperationExecution getOperationExecution(SmsOperationConfiguration operationConfiguration)

Description copied from interface: SmsOperation

Returns who can execute this operation

Specified by:

getOperationExecution in interface SmsOperation

Overrides:

getOperationExecution in class BaseSmsOperation

checkParametersCount

protected void checkParametersCount(SmsOperationConfiguration operationConfiguration,
                                    List<String> parameters)
                             throws SmsOperationException

Description copied from class: BaseSmsOperation

This method must be implemented to check the minimum and maximum expected parameters

Specified by:

checkParametersCount in class BaseSmsOperation

Throws:

SmsOperationException

doExecute

protected void doExecute(SmsOperationConfiguration operationConfiguration,
                         MobilePhone phone,
                         InboundSmsData sms,
                         SmsParameterProcessor processor)
                  throws SmsOperationException

Specified by:

doExecute in class BaseSmsOperation

Throws:

SmsOperationException

getHelpComponents

protected List<String> getHelpComponents(SmsOperationConfiguration operationConfiguration)

Specified by:

getHelpComponents in class BaseSmsOperation