NppesRequestBuilder

io.zhkv.api.nppesnpi.NppesRequestBuilder

```
public class NppesRequestBuilder
```
This class is used as an adapter for class NppesRequest and make it easier to build request in Java env.

See Also:

class NppesRequest

Constructor Summary

Constructors
Constructor and Description

NppesRequestBuilder()
This class is used as an adapter for class NppesRequest and make it easier to build request in Java env.

Constructors
Constructor and Description
`NppesRequestBuilder()` This class is used as an adapter for `class NppesRequest` and make it easier to build request in Java env.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NppesRequest`	`build()` Builds the `class NppesRequest` based on givven data.
`AddressPurpose`	`getAddressPurpose()` Refers to whether the address information entered pertains to the provider's Mailing Address or the provider's Practice Location Address. When not specified, the results will contain the providers where either the Mailing Address or the Practice Location Addresses match the entered address information
`java.lang.String`	`getCity()` The City associated with the provider's address identified in Address Purpose.
`java.lang.String`	`getCountryCode()` The Country associated with the provider's address identified in Address Purpose. This field can be used as the only input criterion as long as the value selected is not US (United States).
`EnumerationType`	`getEnumerationType()` The Read API can be refined to retrieve only Individual Providers or Organizational Providers. When using the Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be entered as well.
`int`	`getLimit()` Limit the results returned. The default value is 10. The value can be set to any value from 1 to 200.
`java.lang.String`	`getNumber()` The unique, 10-digit National Provider Identifier (NPI) assigned to the provider.
`java.lang.String`	`getOrganizationName()` This field only applies to Organizational Providers. Trailing wildcard entries are permitted requiring at least two characters to be entered.
`java.lang.String`	`getPostalCode()` The Postal Code associated with the provider's address identified in Address Purpose. There is an implied trailing wildcard. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codes in the data.
`int`	`getSkip()` The first N (value entered) results meeting the entered criteria will be bypassed and will not be included in the output.
`java.lang.String`	`getState()` The State abbreviation associated with the provider's address identified in Address Purpose.
`java.lang.String`	`getTaxonomyDescription()` Search for providers by their taxonomy by entering the taxonomy description.
`void`	`setAddressPurpose(AddressPurpose p)` Refers to whether the address information entered pertains to the provider's Mailing Address or the provider's Practice Location Address. When not specified, the results will contain the providers where either the Mailing Address or the Practice Location Addresses match the entered address information
`void`	`setCity(java.lang.String p)` The City associated with the provider's address identified in Address Purpose.
`void`	`setCountryCode(java.lang.String p)` The Country associated with the provider's address identified in Address Purpose. This field can be used as the only input criterion as long as the value selected is not US (United States).
`void`	`setEnumerationType(EnumerationType p)` The Read API can be refined to retrieve only Individual Providers or Organizational Providers. When using the Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be entered as well.
`void`	`setLimit(int p)` Limit the results returned. The default value is 10. The value can be set to any value from 1 to 200.
`void`	`setNumber(java.lang.String p)` The unique, 10-digit National Provider Identifier (NPI) assigned to the provider.
`void`	`setOrganizationName(java.lang.String p)` This field only applies to Organizational Providers. Trailing wildcard entries are permitted requiring at least two characters to be entered.
`void`	`setPostalCode(java.lang.String p)` The Postal Code associated with the provider's address identified in Address Purpose. There is an implied trailing wildcard. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codes in the data.
`void`	`setSkip(int p)` The first N (value entered) results meeting the entered criteria will be bypassed and will not be included in the output.
`void`	`setState(java.lang.String p)` The State abbreviation associated with the provider's address identified in Address Purpose.
`void`	`setTaxonomyDescription(java.lang.String p)` Search for providers by their taxonomy by entering the taxonomy description.
`NppesRequestBuilder`	`withAddressPurpose(AddressPurpose purpose)` Sets the addressPurpose value.
`NppesRequestBuilder`	`withCity(java.lang.String city)` Sets the city value.
`NppesRequestBuilder`	`withCountrylCode(java.lang.String countryCode)` Sets the countryCode value.
`NppesRequestBuilder`	`withEnumerationType(EnumerationType type)` Sets the enumerationType value.
`NppesRequestBuilder`	`withLimit(int limit)` Sets the limit value.
`NppesRequestBuilder`	`withNumber(java.lang.String number)` Sets the number value.
`NppesRequestBuilder`	`withOrganizationName(java.lang.String orgName)` Sets the organizationName value.
`NppesRequestBuilder`	`withPostalCode(java.lang.String postalCode)` Sets the postalCode value.
`NppesRequestBuilder`	`withSkip(int skip)` Sets the skip value.
`NppesRequestBuilder`	`withState(java.lang.String state)` Sets the state value.
`NppesRequestBuilder`	`withTaxonomyDescription(java.lang.String desc)` Sets the taxonomyDescription value.

- Constructor Detail
  - NppesRequestBuilder
```
public NppesRequestBuilder()
```
    This class is used as an adapter for class NppesRequest and make it easier to build request in Java env.
    
    See Also:
    
    class NppesRequest
- Method Detail
  - getNumber
```
public java.lang.String getNumber()
```
    The unique, 10-digit National Provider Identifier (NPI) assigned to the provider.
  - setNumber
```
public void setNumber(java.lang.String p)
```
    The unique, 10-digit National Provider Identifier (NPI) assigned to the provider.
  - getEnumerationType
```
public EnumerationType getEnumerationType()
```
    The Read API can be refined to retrieve only Individual Providers or Organizational Providers. When using the Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be entered as well.
  - setEnumerationType
```
public void setEnumerationType(EnumerationType p)
```
    The Read API can be refined to retrieve only Individual Providers or Organizational Providers. When using the Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be entered as well.
  - getTaxonomyDescription
```
public java.lang.String getTaxonomyDescription()
```
    Search for providers by their taxonomy by entering the taxonomy description.
  - setTaxonomyDescription
```
public void setTaxonomyDescription(java.lang.String p)
```
    Search for providers by their taxonomy by entering the taxonomy description.
  - getOrganizationName
```
public java.lang.String getOrganizationName()
```
    This field only applies to Organizational Providers. Trailing wildcard entries are permitted requiring at least two characters to be entered.
  - setOrganizationName
```
public void setOrganizationName(java.lang.String p)
```
    This field only applies to Organizational Providers. Trailing wildcard entries are permitted requiring at least two characters to be entered.
  - getAddressPurpose
```
public AddressPurpose getAddressPurpose()
```
    Refers to whether the address information entered pertains to the provider's Mailing Address or the provider's Practice Location Address. When not specified, the results will contain the providers where either the Mailing Address or the Practice Location Addresses match the entered address information
  - setAddressPurpose
```
public void setAddressPurpose(AddressPurpose p)
```
    Refers to whether the address information entered pertains to the provider's Mailing Address or the provider's Practice Location Address. When not specified, the results will contain the providers where either the Mailing Address or the Practice Location Addresses match the entered address information
  - getCity
```
public java.lang.String getCity()
```
    The City associated with the provider's address identified in Address Purpose.
  - setCity
```
public void setCity(java.lang.String p)
```
    The City associated with the provider's address identified in Address Purpose.
  - getState
```
public java.lang.String getState()
```
    The State abbreviation associated with the provider's address identified in Address Purpose.
  - setState
```
public void setState(java.lang.String p)
```
    The State abbreviation associated with the provider's address identified in Address Purpose.
  - getPostalCode
```
public java.lang.String getPostalCode()
```
    The Postal Code associated with the provider's address identified in Address Purpose. There is an implied trailing wildcard. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codes in the data.
  - setPostalCode
```
public void setPostalCode(java.lang.String p)
```
    The Postal Code associated with the provider's address identified in Address Purpose. There is an implied trailing wildcard. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codes in the data.
  - getCountryCode
```
public java.lang.String getCountryCode()
```
    The Country associated with the provider's address identified in Address Purpose. This field can be used as the only input criterion as long as the value selected is not US (United States).
  - setCountryCode
```
public void setCountryCode(java.lang.String p)
```
    The Country associated with the provider's address identified in Address Purpose. This field can be used as the only input criterion as long as the value selected is not US (United States).
  - getLimit
```
public int getLimit()
```
    Limit the results returned. The default value is 10. The value can be set to any value from 1 to 200.
  - setLimit
```
public void setLimit(int p)
```
    Limit the results returned. The default value is 10. The value can be set to any value from 1 to 200.
  - getSkip
```
public int getSkip()
```
    The first N (value entered) results meeting the entered criteria will be bypassed and will not be included in the output.
  - setSkip
```
public void setSkip(int p)
```
    The first N (value entered) results meeting the entered criteria will be bypassed and will not be included in the output.
  - withNumber
```
public NppesRequestBuilder withNumber(java.lang.String number)
```
    Sets the number value.
    
    Parameters:
    
    number - to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - withEnumerationType
```
public NppesRequestBuilder withEnumerationType(EnumerationType type)
```
    Sets the enumerationType value.
    
    Parameters:
    
    type - to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - withTaxonomyDescription
```
public NppesRequestBuilder withTaxonomyDescription(java.lang.String desc)
```
    Sets the taxonomyDescription value.
    
    Parameters:
    
    desc - description to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - withOrganizationName
```
public NppesRequestBuilder withOrganizationName(java.lang.String orgName)
```
    Sets the organizationName value.
    
    Parameters:
    
    orgName - organization name to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - withAddressPurpose
```
public NppesRequestBuilder withAddressPurpose(AddressPurpose purpose)
```
    Sets the addressPurpose value.
    
    Parameters:
    
    purpose - address purpose to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - withCity
```
public NppesRequestBuilder withCity(java.lang.String city)
```
    Sets the city value.
    
    Parameters:
    
    city - to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - withState
```
public NppesRequestBuilder withState(java.lang.String state)
```
    Sets the state value.
    
    Parameters:
    
    state - to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - withPostalCode
```
public NppesRequestBuilder withPostalCode(java.lang.String postalCode)
```
    Sets the postalCode value.
    
    Parameters:
    
    postalCode - to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - withCountrylCode
```
public NppesRequestBuilder withCountrylCode(java.lang.String countryCode)
```
    Sets the countryCode value.
    
    Parameters:
    
    countryCode - to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - withLimit
```
public NppesRequestBuilder withLimit(int limit)
```
    Sets the limit value.
    
    Returns:
    
    this class NppesRequestBuilder
  - withSkip
```
public NppesRequestBuilder withSkip(int skip)
```
    Sets the skip value.
    
    Parameters:
    
    skip - to be set
    
    Returns:
    
    this class NppesRequestBuilder
  - build
```
public NppesRequest build()
```
    Builds the class NppesRequest based on givven data.
    
    Returns:
    
    instance of class NppesRequest
    
    See Also:
    
    class NppesRequest

Class NppesRequestBuilder

Constructor Summary

Method Summary

Constructor Detail

NppesRequestBuilder

Method Detail

getNumber

setNumber

getEnumerationType

setEnumerationType

getTaxonomyDescription

setTaxonomyDescription

getOrganizationName

setOrganizationName

getAddressPurpose

setAddressPurpose

getCity

setCity

getState

setState

getPostalCode

setPostalCode

getCountryCode

setCountryCode

getLimit

setLimit

getSkip

setSkip

withNumber

withEnumerationType

withTaxonomyDescription

withOrganizationName

withAddressPurpose

withCity

withState

withPostalCode

withCountrylCode

withLimit

withSkip

build