LocalisedString (AristaFlow Business Process Platform API)

All Known Subinterfaces:

Activity, ATParameter, ChangeableInstance, ChangeableTemplate, DataElement, DecisionActivity, EmbeddedProcess, ExecutableBusinessProcess, ExecutableInstance, Instance, InstanceDeltaLayer, LightWeightProcess, Node, Parameter, ProcessModelParameter, ReferencedProcess, Template, VariableParallelismEBP

All Known Implementing Classes:

AbstractWrappingTemplate, IDWrappingTemplate, IOParameterRef, LocalisedStringCollection, NonLocalisedString, ParameterRef, SystemDataProducer
```
public interface LocalisedString
```
This interface allows implementors to provide a (string) representation which is localised. Model objects using Localised can be automatically localised using the provided localisation factory. The returned object will be provided used as argument to String.format(String, Object...) applied to the message from the corresponding resource bundle.
Do not use this for simple localisations like "input parameter" or "output parameter". These are part of the message body and therefore should be localised within the resource bundle. You recognise such simple localisations by the implementation of this interface providing simple constant strings based on the locale.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Object`	`toLocalisedString(LocalisationFactory locFac, Locale loc)`	Gets the localised representation of the implementing object.

- Method Detail
  - toLocalisedString
```
Object toLocalisedString(LocalisationFactory locFac,
                         Locale loc)
```
    Gets the localised representation of the implementing object. The localisation should be for the designated locale, model objects being Localised should use the designated localisation factory for automatic localisation.
    
    Parameters:
    
    locFac - The localisation factory to be used by Localised model objects. If this is null, do not localise the used Localised attributes.
    
    loc - The locale for which to get the localised string. If this is null, treat it like Locale.ROOT has been requested.
    
    Returns:
    
    The localised (string) representation of the implementing object for the designated locale using the designated localisation factory if appropriate.