ExternalEntityIdentifier (Silverpeas Core 6.4 API)

All Superinterfaces:

Comparable<EntityIdentifier>, EntityIdentifier, ResourceIdentifier, Serializable

All Known Subinterfaces:

CompositeEntityIdentifier

All Known Implementing Classes:

ExternalAccountIdentifier, ExternalIntegerIdentifier, ExternalStringIdentifier, PdcAxisValuePk
```
public interface ExternalEntityIdentifier
extends EntityIdentifier
```
When the primary identifier of an entity corresponds to an identifier of another entity, then the identifier must implement this interface. Indeed, if identifier implements this interface no identifier value will be automatically generated on persist operations.

Author:

Yohann Chastagnier

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default ExternalEntityIdentifier`	`generateNewId(String... parameters)`	No identifier value is generated and returning null explicitly in order to get an NullPointerException in case of wrong code development.

Methods inherited from interface org.silverpeas.core.persistence.datasource.model.EntityIdentifier
compareTo, fromString

Methods inherited from interface org.silverpeas.core.ResourceIdentifier
asString

- Method Detail
  - generateNewId
```
default ExternalEntityIdentifier generateNewId(String... parameters)
```
    No identifier value is generated and returning null explicitly in order to get an NullPointerException in case of wrong code development.
    
    Specified by:
    
    generateNewId in interface EntityIdentifier
    
    Parameters:
    
    parameters - the parameters required in the generation of the new identifier. Those depends on the kind of entity identifier and they must be documented in the concrete class.
    
    Returns:
    
    a new identifier.