org.cyclos.impl.users

Interface PhoneServiceLocal

All Superinterfaces:

CRUDService<PhoneDTO,PhoneData,PhoneDataParams>, CRUDServiceLocal<Phone,PhoneDTO,PhoneData,PhoneDataParams>, CRUDWithConfirmationPasswordService<PhoneDTO,PhoneData,PhoneDataParams>, PhoneService, Service

public interface PhoneServiceLocal
extends PhoneService, CRUDServiceLocal<Phone,PhoneDTO,PhoneData,PhoneDataParams>

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_EXTENSION_LENGTH Maximum land-line phone extension length

Method Summary

Modifier and Type	Method and Description
Phone	getDefaultPhone(BasicUser user) Returns the default phone for this user
Phone	getDefaultPhone(PhoneNature type, User user) Returns the default phone (landline or mobile) for the given user, or null if none found
java.lang.String	getExampleNumber(PhoneNature nature) Returns an example number for the given phone nature
PhoneListData	getPhoneListData(User user) Returns data containing all phones belonging to the given user
org.cyclos.impl.utils.validation.Validator	getValidator(PhoneDTO dto, Group group) Returns the validator for the given phone and user group
boolean	isVerificationCodeSentAndNotExpired(MobilePhone mobile) Returns whether there is a valid verification code sent for the given mobile phone
java.util.List<Phone>	listByUser(BasicUser user) Returns the visible phones of the given user.
java.util.List<MobilePhone>	listEnabledPhonesForSmsNotification(BasicUser user, boolean includeOperators) Returns all phones that should be used for SMS notifications.
Phone	loadByRawNumber(User user, java.lang.String rawNumber) Loads a given user's number by its raw number
java.lang.String	normalizeNumber(ConfigurationAccessor configuration, java.lang.String rawNumber) Normalizes a phone number for the given configuration, returning null when not a valid number
void	verifyAndEnableForSms(MobilePhone phone) Marks the given phone as verified and enabled for SMS

Methods inherited from interface org.cyclos.services.users.PhoneService

disableForSms, enableForSms, getConfirmationPasswordInputForDisableSms, getPhoneListData, loadByNumber, sendVerificationCode, verify

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

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, toDTO, toEntity, validate

Field Detail

MAX_EXTENSION_LENGTH

static final int MAX_EXTENSION_LENGTH

Maximum land-line phone extension length

See Also:

Constant Field Values

Method Detail

getDefaultPhone

Phone getDefaultPhone(BasicUser user)

Returns the default phone for this user

getDefaultPhone

Phone getDefaultPhone(PhoneNature type,
                      User user)

Returns the default phone (landline or mobile) for the given user, or null if none found

getExampleNumber

java.lang.String getExampleNumber(PhoneNature nature)

Returns an example number for the given phone nature

getPhoneListData

PhoneListData getPhoneListData(User user)

Returns data containing all phones belonging to the given user

getValidator

org.cyclos.impl.utils.validation.Validator getValidator(PhoneDTO dto,
                                                        Group group)

Returns the validator for the given phone and user group

isVerificationCodeSentAndNotExpired

boolean isVerificationCodeSentAndNotExpired(MobilePhone mobile)

Returns whether there is a valid verification code sent for the given mobile phone

listByUser

java.util.List<Phone> listByUser(BasicUser user)

Returns the visible phones of the given user. If the current user manages the given user, hidden phones are returned

listEnabledPhonesForSmsNotification

java.util.List<MobilePhone> listEnabledPhonesForSmsNotification(BasicUser user,
                                                                boolean includeOperators)

Returns all phones that should be used for SMS notifications. If the includeOperators flag is true, also includes any alias-operator phones which are enabled for SMS.

loadByRawNumber

Phone loadByRawNumber(User user,
                      java.lang.String rawNumber)

Loads a given user's number by its raw number

normalizeNumber

java.lang.String normalizeNumber(ConfigurationAccessor configuration,
                                 java.lang.String rawNumber)

Normalizes a phone number for the given configuration, returning null when not a valid number

verifyAndEnableForSms

void verifyAndEnableForSms(MobilePhone phone)

Marks the given phone as verified and enabled for SMS