uk.co.visalia.brightpearl.apiclient.request

Annotation Type ReferenceKey

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

An annotation for search result domain object fields where the field is a key to one or more reference data maps that provide values for other fields on the same domain object. Requires an array of reference map names.

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