NaturalLanguageUsageBoService (Rice 2.5.1 API)

All Known Implementing Classes:

NaturalLanguageUsageBoServiceImpl
```
public interface NaturalLanguageUsageBoService
```
This is the interface for accessing repository NaturalLanguageUsageBo related business objects.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods
Modifier and Type	Method and Description
`NaturalLanguageUsage`	`createNaturalLanguageUsage(NaturalLanguageUsage naturalLanguageUsage)` This will create a `NaturalLanguageUsage` exactly like the parameter passed in.
`void`	`deleteNaturalLanguageUsage(String naturalLanguageUsageId)` Delete the `NaturalLanguageUsage` with the given id.
`List<NaturalLanguageUsage>`	`findNaturalLanguageUsagesByDescription(String description)`
`List<NaturalLanguageUsage>`	`findNaturalLanguageUsagesByName(String name)`
`List<NaturalLanguageUsage>`	`findNaturalLanguageUsagesByNamespace(String namespace)`
`NaturalLanguageUsageBo`	`from(NaturalLanguageUsage naturalLanguageUsage)` Converts a immutable `NaturalLanguageUsage` to its mutable `NaturalLanguageUsageBo` counterpart.
`NaturalLanguageUsage`	`getNaturalLanguageUsage(String naturalLanguageUsageId)` Retrieves a NaturalLanguageUsage from the repository based on the given id.
`NaturalLanguageUsage`	`getNaturalLanguageUsageByName(String namespace, String name)` Retrieves a NaturalLanguageUsage from the repository based on the given namespace and name.
`NaturalLanguageUsage`	`to(NaturalLanguageUsageBo naturalLanguageUsageBo)` Converts a mutable `NaturalLanguageUsageBo` to its immutable counterpart, `NaturalLanguageUsage`.
`NaturalLanguageUsage`	`updateNaturalLanguageUsage(NaturalLanguageUsage naturalLanguageUsage)` This will update an existing `NaturalLanguageUsage`.

- Method Detail
  - createNaturalLanguageUsage
```
NaturalLanguageUsage createNaturalLanguageUsage(NaturalLanguageUsage naturalLanguageUsage)
```
    This will create a NaturalLanguageUsage exactly like the parameter passed in.
    
    Parameters:
    naturalLanguageUsage - The NaturalLanguageUsage to create.
    
    Returns:
    a NaturalLanguageUsage exactly like the parameter passed in.
    
    Throws:
    
    IllegalArgumentException - if the NaturalLanguageUsage is null.
    
    IllegalStateException - if the NaturalLanguageUsage already exists in the system.
  - getNaturalLanguageUsage
```
NaturalLanguageUsage getNaturalLanguageUsage(String naturalLanguageUsageId)
```
    Retrieves a NaturalLanguageUsage from the repository based on the given id.
    
    Parameters:
    naturalLanguageUsageId - to retrieve.
    
    Returns:
    a NaturalLanguageUsage identified by the given id. A null reference is returned if an invalid or non-existent id is supplied.
  - getNaturalLanguageUsageByName
```
NaturalLanguageUsage getNaturalLanguageUsageByName(String namespace,
                                                 String name)
```
    Retrieves a NaturalLanguageUsage from the repository based on the given namespace and name.
    
    Parameters:
    namespace - of the NaturalLanguageUsage to retrieve.
    name - of the NaturalLanguageUsage to retrieve.
    
    Returns:
    a NaturalLanguageUsage identified by the given namespace and name. A null reference is returned if the repository does not contain a NaturalLanguageUsage with the given namespace and name.
  - updateNaturalLanguageUsage
```
NaturalLanguageUsage updateNaturalLanguageUsage(NaturalLanguageUsage naturalLanguageUsage)
```
    This will update an existing NaturalLanguageUsage.
    
    Parameters:
    naturalLanguageUsage - The NaturalLanguageUsage to update.
    
    Throws:
    
    IllegalArgumentException - if the NaturalLanguageUsage is null.
    
    IllegalStateException - if the NaturalLanguageUsage does not exists in the system.
  - deleteNaturalLanguageUsage
```
void deleteNaturalLanguageUsage(String naturalLanguageUsageId)
```
    Delete the NaturalLanguageUsage with the given id.
    
    Parameters:
    naturalLanguageUsageId - to delete.
    
    Throws:
    
    IllegalArgumentException - if the NaturalLanguageUsage is null.
    
    IllegalStateException - if the NaturalLanguageUsage does not exists in the system
  - findNaturalLanguageUsagesByName
```
List<NaturalLanguageUsage> findNaturalLanguageUsagesByName(String name)
```
  - findNaturalLanguageUsagesByDescription
```
List<NaturalLanguageUsage> findNaturalLanguageUsagesByDescription(String description)
```
  - findNaturalLanguageUsagesByNamespace
```
List<NaturalLanguageUsage> findNaturalLanguageUsagesByNamespace(String namespace)
```
  - to
```
NaturalLanguageUsage to(NaturalLanguageUsageBo naturalLanguageUsageBo)
```
    Converts a mutable NaturalLanguageUsageBo to its immutable counterpart, NaturalLanguageUsage.
    
    Parameters:
    naturalLanguageUsageBo - the mutable business object.
    
    Returns:
    a NaturalLanguageUsage the immutable object.
  - from
```
NaturalLanguageUsageBo from(NaturalLanguageUsage naturalLanguageUsage)
```
    Converts a immutable NaturalLanguageUsage to its mutable NaturalLanguageUsageBo counterpart.
    
    Parameters:
    naturalLanguageUsage - the immutable object.
    
    Returns:
    a NaturalLanguageUsageBo the mutable NaturalLanguageUsageBo.

Interface NaturalLanguageUsageBoService

Method Summary

Method Detail

createNaturalLanguageUsage

getNaturalLanguageUsage

getNaturalLanguageUsageByName

updateNaturalLanguageUsage

deleteNaturalLanguageUsage

findNaturalLanguageUsagesByName

findNaturalLanguageUsagesByDescription

findNaturalLanguageUsagesByNamespace

to

from