de.hybris.platform.mobileservices.text.lists

Interface PhoneListService

All Known Implementing Classes:

DefaultPhoneListService

public interface PhoneListService

Encapsulated filtering of numbers by phone lists.

Method Summary

Modifier and Type	Method and Description
boolean	addToList(PhoneNumberListModel list, PhoneNumberModel phoneNumber)
boolean	addToList(PhoneNumberListModel list, String countryIcoCode, String phoneNumber)
Set<PhoneNumberModel>	findInList(PhoneNumberListModel list, String normalizedPhoneNumber) Fetches phone number items assigned to the specified list which matches the normalized phone number also specified.
Set<PhoneNumberModel>	findInList(PhoneNumberListModel list, String countryIsoCode, String phoneNumber) Fetches phone number items assigned to the specified list which matches the phone number also specified.
boolean	isAllowedByList(String normalizedPhone, Collection<PhoneNumberListModel> blocklists, Collection<PhoneNumberListModel> whitelists)
boolean	isAllowedByList(String countryIsoCode, String phone, Collection<PhoneNumberListModel> blocklists, Collection<PhoneNumberListModel> whitelists)
boolean	isInList(PhoneNumberListModel list, String countryIsoCode, String phoneNumber)
boolean	removeAllFromList(PhoneNumberListModel list, Collection<PhoneNumberModel> phoneNumbers)
boolean	removeFromList(PhoneNumberListModel list, PhoneNumberModel phoneNumber)

Method Detail

isAllowedByList

boolean isAllowedByList(String countryIsoCode,
                        String phone,
                        Collection<PhoneNumberListModel> blocklists,
                        Collection<PhoneNumberListModel> whitelists)

isAllowedByList

boolean isAllowedByList(String normalizedPhone,
                        Collection<PhoneNumberListModel> blocklists,
                        Collection<PhoneNumberListModel> whitelists)

isInList

boolean isInList(PhoneNumberListModel list,
                 String countryIsoCode,
                 String phoneNumber)

findInList

Set<PhoneNumberModel> findInList(PhoneNumberListModel list,
                                 String countryIsoCode,
                                 String phoneNumber)

Fetches phone number items assigned to the specified list which matches the phone number also specified. The number may be either international (in that case the country iso code can be omitted) or in local format, which requires to specify a country iso code.

Returns:

the phone number, or null if no such a number doesn't exist of is not assigned to that list

findInList

Set<PhoneNumberModel> findInList(PhoneNumberListModel list,
                                 String normalizedPhoneNumber)

Fetches phone number items assigned to the specified list which matches the normalized phone number also specified.

Please make sure the normalized phone number is using the correct format. Otherwise the number item cannot be matched. The number must be in international format without leading + or 00 without any spaces or formatting characters.

Returns:

the phone number, or null if no such a number doesn't exist of is not assigned to that list

addToList

boolean addToList(PhoneNumberListModel list,
                  PhoneNumberModel phoneNumber)

addToList

boolean addToList(PhoneNumberListModel list,
                  String countryIcoCode,
                  String phoneNumber)

removeFromList

boolean removeFromList(PhoneNumberListModel list,
                       PhoneNumberModel phoneNumber)

removeAllFromList

boolean removeAllFromList(PhoneNumberListModel list,
                          Collection<PhoneNumberModel> phoneNumbers)