com.nexmo.client.numbers

Class SearchNumbersFilter

java.lang.Object

com.nexmo.client.numbers.SearchNumbersFilter

public class SearchNumbersFilter
extends java.lang.Object

This class encapsulates a request to search for available Nexmo Virtual Numbers.

Constructor Summary

Constructors

Constructor and Description
SearchNumbersFilter(java.lang.String country) Construct a request with the only required parameter, the country code.

Method Summary

Modifier and Type	Method and Description
void	addParams(org.apache.http.client.methods.RequestBuilder request)
java.lang.String	getCountry()
java.lang.String[]	getFeatures()
java.lang.Integer	getIndex()
java.lang.String	getPattern()
SearchPattern	getSearchPattern()
java.lang.Integer	getSize()
void	setFeatures(java.lang.String[] features)
void	setIndex(java.lang.Integer index)
void	setPattern(java.lang.String pattern)
void	setSearchPattern(SearchPattern searchPattern)
void	setSize(java.lang.Integer size) Set the maximum number of matching results to be returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchNumbersFilter

public SearchNumbersFilter(java.lang.String country)

Construct a request with the only required parameter, the country code.

Parameters:

country - A String containing a two-character country code.

Method Detail

getCountry

public java.lang.String getCountry()

getPattern

public java.lang.String getPattern()

setPattern

public void setPattern(java.lang.String pattern)

getFeatures

public java.lang.String[] getFeatures()

setFeatures

public void setFeatures(java.lang.String[] features)

getIndex

public java.lang.Integer getIndex()

setIndex

public void setIndex(java.lang.Integer index)

getSize

public java.lang.Integer getSize()

setSize

public void setSize(java.lang.Integer size)

Set the maximum number of matching results to be returned.

Parameters:

size - An Integer between 10 and 100 (inclusive) or null, to indicate that the default value should be used.

getSearchPattern

public SearchPattern getSearchPattern()

setSearchPattern

public void setSearchPattern(SearchPattern searchPattern)

Parameters:

searchPattern -

addParams

public void addParams(org.apache.http.client.methods.RequestBuilder request)