Renameable (Test 0.0.6 API)

```
public interface Renameable
```
Interface for objects that are "Renameable", i.e. the can be referenced by the <Entity> tag in the xml files.

Author:

stamm

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Renameable.StandardField
Marker interface for StandardFields.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Renameable.StandardField` Marker interface for StandardFields.

Field Summary

Fields
Modifier and Type Field and Description

static String ENTITY_NAME

static String ENTITY_NAME_FIELD

static String ENTITY_NAME_PREFIX

Fields
Modifier and Type	Field and Description
`static String`	`ENTITY_NAME`
`static String`	`ENTITY_NAME_FIELD`
`static String`	`ENTITY_NAME_PREFIX`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getEntitySpecificDbLabelKey(String labelKey)`
`String`	`getLabel()`
`String`	`getLabelPlural()`
`String`	`getName()`
`Renameable.StandardField`	`getRenameableFieldForKey(String labelKey)`
`String`	`getStandardFieldLabel(HumanLanguage language, Renameable.StandardField field)`
`Noun`	`getStandardNoun(HumanLanguage language)`
`boolean`	`hasStandardLabel()`

- Field Detail
  - ENTITY_NAME
```
static final String ENTITY_NAME
```
    See Also:
    
    Constant Field Values
  - ENTITY_NAME_PREFIX
```
static final String ENTITY_NAME_PREFIX
```
    See Also:
    
    Constant Field Values
  - ENTITY_NAME_FIELD
```
static final String ENTITY_NAME_FIELD
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    the unique DB identifier of this object.
  - getLabel
```
String getLabel()
```
    Returns:
    
    the (localized) label of this object.
  - getLabelPlural
```
String getLabelPlural()
```
    Returns:
    
    the (localized) label of this object in plural. This is a little sleazy
  - hasStandardLabel
```
boolean hasStandardLabel()
```
    Returns:
    
    True if the object has a "standard" label (i.e. isn't custom)
  - getStandardFieldLabel
```
String getStandardFieldLabel(HumanLanguage language,
                             Renameable.StandardField field)
```
    Parameters:
    
    language - the language to return
    
    field - the key for the standard field on this renameable entity to return
    
    Returns:
    
    the label for the given standard field
  - getEntitySpecificDbLabelKey
```
String getEntitySpecificDbLabelKey(String labelKey)
```
    Parameters:
    
    labelKey - the label from the grammar files
    
    Returns:
    
    for the given labelKey, return the DB key that should be used to retreive it. I.e., if labelKey is "Entity" and this is "Account", it should return "Account".
  - getRenameableFieldForKey
```
Renameable.StandardField getRenameableFieldForKey(String labelKey)
```
    Parameters:
    
    labelKey - the DB-specific key that may or may not be a field
    
    Returns:
    
    the field for the labelKey if appropriate, or null if it does not exist.
  - getStandardNoun
```
Noun getStandardNoun(HumanLanguage language)
```
    Returns:
    
    the "standard" noun in the given language. If you want the renamed version, you should use RenamingProvider.get() or the equivalent

Interface Renameable

Nested Class Summary

Field Summary

Method Summary

Field Detail

ENTITY_NAME

ENTITY_NAME_PREFIX

ENTITY_NAME_FIELD

Method Detail

getName

getLabel

getLabelPlural

hasStandardLabel

getStandardFieldLabel

getEntitySpecificDbLabelKey

getRenameableFieldForKey

getStandardNoun