org.mobicents.servlet.restcomm.provisioning.number.api

Class PhoneNumberSearchFilters

java.lang.Object

org.mobicents.servlet.restcomm.provisioning.number.api.PhoneNumberSearchFilters

public class PhoneNumberSearchFilters
extends Object

This POJO is holding the different filters that can be applied to Phone Number Search to filter the results

The following filters are available for phone numbers search:

Property	Description
AreaCode	The areacode for the phone number
FilterPattern	A pattern to match phone numbers on. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.
SmsEnabled	This indicates whether the phone numbers can receive text messages. Possible values are true or false..
MmsEnabled	This indicates whether the phone numbers can receive MMS messages. Possible values are true or false..
VoiceEnabled	This indicates whether the phone numbers can receive calls. Possible values are true or false..
FaxEnabled	This indicates whether the phone numbers can receive fax message. Possible values are true or false..
UssdEnabled	This indicates whether the phone numbers can receive USSD messages. Possible values are true or false..
NearNumber	Given a phone number, find a geographically close number within Distance miles. Distance defaults to 25 miles.
NearLatLong	Given a latitude/longitude pair lat,long find geographically close numbers within Distance miles.
Distance	Specifies the search radius for a Near- query in miles. If not specified this defaults to 25 miles. Maximum searchable distance is 500 miles.
InPostalCode	Limit results to a particular postal code. Given a phone number, search within the same postal code as that number.
InRegion	Limit results to a particular region (i.e. State/Province). Given a phone number, search within the same Region as that number.
InRateCenter	Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires InLata to be set as well.
InLata	Limit results to a specific Local access and transport area (LATA - http://en.wikipedia.org/wiki/Local_access_and_transport_area). Given a phone number, search within the same LATA as that number.

Author:

jean.deruelle@telestax.com

Constructor Summary

Constructors

Constructor and Description
PhoneNumberSearchFilters()
PhoneNumberSearchFilters(String areaCode, Pattern filterPattern, Boolean smsEnabled, Boolean mmsEnabled, Boolean voiceEnabled, Boolean faxEnabled, Boolean ussdEnabled, String nearNumber, String nearLatLong, String distance, String inPostalCode, String inRegion, String inRateCenter, String inLata, int rangeSize, int rangeIndex, PhoneNumberType phoneNumberType)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAreaCode()
String	getDistance()
Boolean	getFaxEnabled()
Pattern	getFilterPattern()
String	getInLata()
String	getInPostalCode()
String	getInRateCenter()
String	getInRegion()
Boolean	getMmsEnabled()
String	getNearLatLong()
String	getNearNumber()
PhoneNumberType	getPhoneNumberTypeSearch()
int	getRangeIndex()
int	getRangeSize()
Boolean	getSmsEnabled()
Boolean	getUssdEnabled()
Boolean	getVoiceEnabled()
void	setAreaCode(String areaCode)
void	setDistance(String distance)
void	setFaxEnabled(Boolean faxEnabled)
void	setFilterPattern(Pattern filterPattern)
void	setInLata(String inLata)
void	setInPostalCode(String inPostalCode)
void	setInRateCenter(String inRateCenter)
void	setInRegion(String inRegion)
void	setMmsEnabled(Boolean mmsEnabled)
void	setNearLatLong(String nearLatLong)
void	setNearNumber(String nearNumber)
void	setPhoneNumberTypeSearch(PhoneNumberType phoneNumberTypeSearch)
void	setRangeIndex(int rangeIndex)
void	setRangeSize(int rangeSize)
void	setSmsEnabled(Boolean smsEnabled)
void	setUssdEnabled(Boolean ussdEnabled)
void	setVoiceEnabled(Boolean voiceEnabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

PhoneNumberSearchFilters

public PhoneNumberSearchFilters()

PhoneNumberSearchFilters

public PhoneNumberSearchFilters(String areaCode,
                        Pattern filterPattern,
                        Boolean smsEnabled,
                        Boolean mmsEnabled,
                        Boolean voiceEnabled,
                        Boolean faxEnabled,
                        Boolean ussdEnabled,
                        String nearNumber,
                        String nearLatLong,
                        String distance,
                        String inPostalCode,
                        String inRegion,
                        String inRateCenter,
                        String inLata,
                        int rangeSize,
                        int rangeIndex,
                        PhoneNumberType phoneNumberType)

Method Detail

getAreaCode

public String getAreaCode()

Returns:

the areaCode

setAreaCode

public void setAreaCode(String areaCode)

Parameters:

areaCode - the areaCode to set

getFilterPattern

public Pattern getFilterPattern()

Returns:

the filterPattern

setFilterPattern

public void setFilterPattern(Pattern filterPattern)

Parameters:

filterPattern - the filterPattern to set

getSmsEnabled

public Boolean getSmsEnabled()

Returns:

the smsEnabled

setSmsEnabled

public void setSmsEnabled(Boolean smsEnabled)

Parameters:

smsEnabled - the smsEnabled to set

getMmsEnabled

public Boolean getMmsEnabled()

Returns:

the mmsEnabled

setMmsEnabled

public void setMmsEnabled(Boolean mmsEnabled)

Parameters:

mmsEnabled - the mmsEnabled to set

getVoiceEnabled

public Boolean getVoiceEnabled()

Returns:

the voiceEnabled

setVoiceEnabled

public void setVoiceEnabled(Boolean voiceEnabled)

Parameters:

voiceEnabled - the voiceEnabled to set

getFaxEnabled

public Boolean getFaxEnabled()

Returns:

the faxEnabled

setFaxEnabled

public void setFaxEnabled(Boolean faxEnabled)

Parameters:

faxEnabled - the faxEnabled to set

getUssdEnabled

public Boolean getUssdEnabled()

Returns:

the ussdEnabled

setUssdEnabled

public void setUssdEnabled(Boolean ussdEnabled)

Parameters:

ussdEnabled - the ussdEnabled to set

getNearNumber

public String getNearNumber()

Returns:

the nearNumber

setNearNumber

public void setNearNumber(String nearNumber)

Parameters:

nearNumber - the nearNumber to set

getNearLatLong

public String getNearLatLong()

Returns:

the nearLatLong

setNearLatLong

public void setNearLatLong(String nearLatLong)

Parameters:

nearLatLong - the nearLatLong to set

getDistance

public String getDistance()

Returns:

the distance

setDistance

public void setDistance(String distance)

Parameters:

distance - the distance to set

getInPostalCode

public String getInPostalCode()

Returns:

the inPostalCode

setInPostalCode

public void setInPostalCode(String inPostalCode)

Parameters:

inPostalCode - the inPostalCode to set

getInRegion

public String getInRegion()

Returns:

the inRegion

setInRegion

public void setInRegion(String inRegion)

Parameters:

inRegion - the inRegion to set

getInRateCenter

public String getInRateCenter()

Returns:

the inRateCenter

setInRateCenter

public void setInRateCenter(String inRateCenter)

Parameters:

inRateCenter - the inRateCenter to set

getInLata

public String getInLata()

Returns:

the inLata

setInLata

public void setInLata(String inLata)

Parameters:

inLata - the inLata to set

getRangeSize

public int getRangeSize()

Returns:

the rangeSize

setRangeSize

public void setRangeSize(int rangeSize)

Parameters:

rangeSize - the rangeSize to set

getRangeIndex

public int getRangeIndex()

Returns:

the rangeIndex

setRangeIndex

public void setRangeIndex(int rangeIndex)

Parameters:

rangeIndex - the rangeIndex to set

getPhoneNumberTypeSearch

public PhoneNumberType getPhoneNumberTypeSearch()

Returns:

the type of phone number to search for

setPhoneNumberTypeSearch

public void setPhoneNumberTypeSearch(PhoneNumberType phoneNumberTypeSearch)

Parameters:

phoneNumberTypeSearch - the type of phone number to search for