ParameterNameDAO (IBM FHIR Server)

All Known Implementing Classes:

DerbyParameterNamesDAO, ParameterNameDAOImpl, PostgreSqlParameterNamesDAO
```
public interface ParameterNameDAO
```
This Data Access Object interface defines APIs specific to parameter_names table.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Map<String,Integer>`	`readAllSearchParameterNames()`	Reads all rows in the Parameter_Names table and returns the data as a Map
`int`	`readOrAddParameterNameId(String parameterName)`	Reads the id associated with the name of the passed Parameter from the Parameter_Names table.
`Integer`	`readParameterNameId(String parameterName)`	Read the parameter_name_id for the given parameterName

- Method Detail
  - readAllSearchParameterNames
```
Map<String,Integer> readAllSearchParameterNames()
                                               throws FHIRPersistenceDataAccessException
```
    Reads all rows in the Parameter_Names table and returns the data as a Map
    
    Returns:
    
    A map containing key=parameter-name, value=parameter-name-id
    
    Throws:
    
    FHIRPersistenceDataAccessException
  - readOrAddParameterNameId
```
int readOrAddParameterNameId(String parameterName)
                      throws FHIRPersistenceDataAccessException
```
    Reads the id associated with the name of the passed Parameter from the Parameter_Names table. If the id for the passed name is not present in the database, an id is generated, persisted, and returned.
    
    Parameters:
    
    parameterName - A valid FHIR search parameter name.
    
    Returns:
    
    the id associated with the name of the passed Parameter.
    
    Throws:
    
    FHIRPersistenceDataAccessException
  - readParameterNameId
```
Integer readParameterNameId(String parameterName)
                     throws FHIRPersistenceDataAccessException
```
    Read the parameter_name_id for the given parameterName
    
    Parameters:
    
    parameterName - A valid FHIR search parameter name.
    
    Returns:
    
    the parameter_name_id for for parameter, or null if it doesn't exist
    
    Throws:
    
    FHIRPersistenceDataAccessException