org.cyclos.services.users

Interface PhoneService

All Superinterfaces:

CRUDService<PhoneDTO,PhoneData,PhoneDataParams>, Service

All Known Subinterfaces:

PhoneServiceLocal

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

Service interface used to handle user phones

Method Summary

Methods

Modifier and Type	Method and Description
PhoneListData	getPhoneListData(UserLocatorVO locator) Returns data containing all phones belonging to the given user
void	markAsEnabledForSms(java.lang.Long id, boolean enabled) Enables / disables the given mobile phone to operate via SMS
void	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.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

getPhoneListData

PhoneListData getPhoneListData(UserLocatorVO locator)
                               throws FrameworkException

Returns data containing all phones belonging to the given user

Throws:

FrameworkException

markAsEnabledForSms

void markAsEnabledForSms(java.lang.Long id,
                       boolean enabled)
                         throws FrameworkException

Enables / disables the given mobile phone to operate via SMS

Throws:

FrameworkException

sendVerificationCode

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

Sends a verification code to a mobile phone via SMS.

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