Class RefDataQuery

public class RefDataQuery
extends java.lang.Object

Provides a Reference Data Query class. Examples

Query Example

This Groovy example shows how to get the value of a reference data set.

 import com.avoka.tm.svc.RefDataQuery
 String value = new RefDataQuery()
     .setName("Addresses")
     .setLocale("en_US")
     .getValue() 

Since:

17.10.0

Constructor Summary

Constructors

Constructor	Description
RefDataQuery()

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
java.lang.String	getValue()	Return the value for the reference data set if found, or null otherwise.
RefDataQuery	setClientCode​(java.lang.String clientCode)	Set the reference data set organization client code.
RefDataQuery	setLocale​(java.lang.String locale)	Set the locale of the reference data set.
RefDataQuery	setName​(java.lang.String name)	Set the name of the reference data set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RefDataQuery

public RefDataQuery()

Method Detail

setClientCode

public RefDataQuery setClientCode​(java.lang.String clientCode) Set the reference data set organization client code. Generally this is not required as the service executes in a client organization security context.

Parameters:

clientCode - reference data organization client code

Returns:

the query object

setName

public RefDataQuery setName​(java.lang.String name) Set the name of the reference data set.

Parameters:

name - the name of the reference data

Returns:

the query object

setLocale

public RefDataQuery setLocale​(java.lang.String locale) Set the locale of the reference data set.

Parameters:

locale - the locale of the reference data

Returns:

the query object

getValue

public java.lang.String getValue() Return the value for the reference data set if found, or null otherwise.

Returns:

the value for the reference data set if found, or null otherwise