org.cyclos.services.users

Interface PhoneService

All Superinterfaces:

CRUDService<PhoneDTO,PhoneData,PhoneDataParams>, CRUDWithConfirmationPasswordService<PhoneDTO,PhoneData,PhoneDataParams>, Service

All Known Subinterfaces:

PhoneServiceLocal

All Known Implementing Classes:

PhoneServiceSecurity

public interface PhoneService
extends CRUDWithConfirmationPasswordService<PhoneDTO,PhoneData,PhoneDataParams>

Service interface used to handle user phones

Method Summary

Modifier and Type	Method and Description
void	disableForSms(java.lang.Long id, java.lang.String confirmationPassword) Disables the given mobile phone to operate via SMS
void	enableForSms(java.lang.Long id) Enables the given mobile phone to operate via SMS
PasswordInputDTO	getConfirmationPasswordInputForDisableSms(java.lang.Long id) Returns data for the confirmation password needed to disable a phone by sms
PhoneListData	getPhoneListData(UserLocatorVO locator) Returns data containing all phones belonging to the given user
PhoneVO	loadByNumber(java.lang.String number) Returns a mobile phone by number, making sure it is visible
java.lang.String	sendVerificationCode(java.lang.Long id) Sends a verification code to a mobile phone via SMS.
CodeVerificationStatus	verify(java.lang.Long id, java.lang.String verificationCode) Verifies a mobile phone with a code received via SMS.

Methods inherited from interface org.cyclos.services.CRUDWithConfirmationPasswordService

getConfirmationPasswordInputForRemove, removeAllWithConfirmationPassword, removeWithConfirmationPassword, saveWithConfirmationPassword

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

disableForSms

void disableForSms(java.lang.Long id,
                   java.lang.String confirmationPassword)
            throws FrameworkException

Disables the given mobile phone to operate via SMS

Throws:

FrameworkException

enableForSms

void enableForSms(java.lang.Long id)
           throws FrameworkException

Enables the given mobile phone to operate via SMS

Throws:

FrameworkException

getConfirmationPasswordInputForDisableSms

PasswordInputDTO getConfirmationPasswordInputForDisableSms(java.lang.Long id)
                                                    throws FrameworkException

Returns data for the confirmation password needed to disable a phone by sms

Throws:

FrameworkException

getPhoneListData

PhoneListData getPhoneListData(UserLocatorVO locator)
                        throws FrameworkException

Returns data containing all phones belonging to the given user

Throws:

FrameworkException

loadByNumber

PhoneVO loadByNumber(java.lang.String number)
              throws FrameworkException

Returns a mobile phone by number, making sure it is visible

Throws:

FrameworkException

sendVerificationCode

java.lang.String sendVerificationCode(java.lang.Long id)
                               throws FrameworkException,
                                      SmsSendingException

Sends a verification code to a mobile phone via SMS. The phone number is returned.

Throws:

SmsSendingException - If the SMS message couldn't be send

IllegalActionException - If the mobile phone is already verified

FrameworkException

verify

CodeVerificationStatus verify(java.lang.Long id,
                              java.lang.String verificationCode)
                       throws FrameworkException

Verifies a mobile phone with a code received via SMS.

Throws:

FrameworkException