com.attivio.sdk.server.udf

Interface UserDefinedFieldContext

public interface UserDefinedFieldContext

Provides per-query context information for the evaluation of user defined fields.

Method Summary

Modifier and Type	Method and Description
Locale	getLocale() Get the Locale for the query request.
long	getNow() Get the timestamp for the query request.
Object	getRequestParameter(String name) Get a request parameter by name.
Schema	getSchema() Get the Schema.
long	getSeed() Get a numeric seed value for the query request.
TimeZone	getTimeZone() Get the TimeZone for the query request.

Method Detail

getRequestParameter

Object getRequestParameter(String name)

Get a request parameter by name.

Request parameters are defined as properties on the QueryRequest.

getLocale

Locale getLocale()

Get the Locale for the query request.

May be null if query did not specify locale.

getTimeZone

TimeZone getTimeZone()

Get the TimeZone for the query request.

May be null if query did not specify time zone.

getNow

long getNow()

Get the timestamp for the query request.

This is a stable value that is used for the current time. Multiple calls to this method will always return the same value.

getSeed

long getSeed()

Get a numeric seed value for the query request.

This value should be used for seeding any random value generators used during evaluation.

getSchema

Schema getSchema()

Get the Schema.