org.cyclos.impl.utils.sms

Class SmsParameterProcessor

java.lang.Object

org.cyclos.impl.utils.sms.SmsParameterProcessor

public class SmsParameterProcessor
extends java.lang.Object

Utility class used to consume inbound SMS parameters

Author:

luis

Constructor Summary

Constructors

Constructor and Description
SmsParameterProcessor(UserLocatorHandler userLocatorHandler, SmsOperationConfiguration operationConfiguration, java.util.List<java.lang.String> params)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Returns whether there is another parameter
java.math.BigDecimal	nextAmount(java.lang.Object paramIdentifier, int precision)
java.math.BigDecimal	nextDecimal(java.lang.Object paramIdentifier) Returns the next parameter as a decimal number
int	nextInt(java.lang.Object paramIdentifier) Returns the next parameter as int
java.lang.String	nextString(java.lang.Object paramIdentifier) Returns the next parameter as string
User	nextUser(java.lang.Object paramIdentifier) Returns the next parameter as user.
User	nextUserForPayment(java.lang.Object paramIdentifier) Returns the next parameter as User, forcing the payment principal types in the sms channel configuration
java.lang.String	remaining(java.lang.Object paramIdentifier, java.lang.String separator) Returns all remaining parameters, joined with a given separator

Methods inherited from class java.lang.Object

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

Constructor Detail

SmsParameterProcessor

public SmsParameterProcessor(UserLocatorHandler userLocatorHandler,
                             SmsOperationConfiguration operationConfiguration,
                             java.util.List<java.lang.String> params)

Method Detail

hasNext

public boolean hasNext()

Returns whether there is another parameter

nextAmount

public java.math.BigDecimal nextAmount(java.lang.Object paramIdentifier,
                                       int precision)
                                throws org.cyclos.impl.utils.sms.InboundSmsParameterException

Throws:

org.cyclos.impl.utils.sms.InboundSmsParameterException

nextDecimal

public java.math.BigDecimal nextDecimal(java.lang.Object paramIdentifier)
                                 throws org.cyclos.impl.utils.sms.InboundSmsParameterException

Returns the next parameter as a decimal number

Throws:

org.cyclos.impl.utils.sms.InboundSmsParameterException

nextInt

public int nextInt(java.lang.Object paramIdentifier)
            throws org.cyclos.impl.utils.sms.InboundSmsParameterException

Returns the next parameter as int

Throws:

org.cyclos.impl.utils.sms.InboundSmsParameterException

nextString

public java.lang.String nextString(java.lang.Object paramIdentifier)
                            throws org.cyclos.impl.utils.sms.InboundSmsParameterException

Returns the next parameter as string

Throws:

org.cyclos.impl.utils.sms.InboundSmsParameterException

nextUser

public User nextUser(java.lang.Object paramIdentifier)
              throws org.cyclos.impl.utils.sms.InboundSmsParameterException

Returns the next parameter as user. Should normally not be used if the user is either the source or destination of a payment. In such cases, use nextUserForPayment(Object) instead, as the principal type defined in the channel configuration is enforced.

Throws:

org.cyclos.impl.utils.sms.InboundSmsParameterException

See Also:

UserLocatorHandler#locateUser(UserLocatorVO)

nextUserForPayment

public User nextUserForPayment(java.lang.Object paramIdentifier)
                        throws org.cyclos.impl.utils.sms.InboundSmsParameterException

Returns the next parameter as User, forcing the payment principal types in the sms channel configuration

Throws:

org.cyclos.impl.utils.sms.InboundSmsParameterException

See Also:

UserLocatorHandler#locateUser(org.cyclos.entities.system.Network, UserLocatorVO, java.util.Set, java.util.Collection)

remaining

public java.lang.String remaining(java.lang.Object paramIdentifier,
                                  java.lang.String separator)
                           throws org.cyclos.impl.utils.sms.InboundSmsParameterException

Returns all remaining parameters, joined with a given separator

Throws:

org.cyclos.impl.utils.sms.InboundSmsParameterException