uk.co.visalia.brightpearl.apiclient.request

Annotation Type ReferenceField

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface ReferenceField

An annotation for search result domain object fields where the field is populated from a reference data map included in the search result. The value of the annotation is the name of the reference data map, and the field in the domain object that provides keys to the map must be annotated with @ReferenceKey for this annotation to work.

For example, the Goods Out Note search reference data looks like this: { warehouseNames: { 2: "Bristol", 3: "Boston" } } so the warehouseId field in the domain object used to represent search results would be annotated with @ReferenceKey("warehouseNames") indicating that the value of the warehouseId column provides a key to the warehouseNames map (in this case, 2 or 3).

The field of the domain object that should receive the value from the reference data map should be annotated with (in this example) @ReferenceField("warehouseNames").

See Also:

http://www.brightpearl.com/developer/latest/tutorial/working-with-resource-search.html

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Element Detail

value

public abstract String value