• Platform
    • Manager
    • Maestro
    • Exchange
    • Workspaces
    • Analytics
    • Springboard
    • API
Journey SDK

Journey SDK

  • Getting Started
  • Developer Guide
  • References
  • Services Guide

›Classes

com.avoka.tm.func

  • com.avoka.tm.func
  • Classes

    • Class DeliveryFuncResult
    • Class DeliveryFuncResultBuilder
    • Class FormFuncResult
    • Class FuncParam

    Interface

    • Interface IFluentFunction

com.avoka.tm.http

  • com.avoka.tm.http
  • Classes

    • Class DeleteRequest
    • Class GetRequest
    • Class HttpRequest
    • Class HttpRequest.FileParam
    • Class HttpRequest.Param
    • Class HttpResponse
    • Class PatchRequest
    • Class PostRequest
    • Class PutRequest
    • Class RequestBuilder

com.avoka.tm.job

  • com.avoka.tm.job
  • Classes

    • Class ActionResult
    • Class ActionResultBuilder
    • Class Jobs

com.avoka.tm.query

  • com.avoka.tm.query
  • Classes

    • Class JobQuery
    • Class PropertyQuery
    • Class RefDataQuery
    • Class SpaceQuery
    • Class SvcConnQuery
    • Class SvcDefQuery
    • Class TxnHistoryQuery
    • Class TxnQuery
    • Class UserQuery

    Enum

    • Enum TxnHistoryQuery.Time
    • Enum TxnQuery.Time

com.avoka.tm.security

  • com.avoka.tm.security
  • Classes

    • Class Saml2Parser
    • Class Saml2ParserResult
    • Class SsoAuthToken

com.avoka.tm.svc

  • com.avoka.tm.svc
  • Classes

    • Class DeliveryTxnBuilder
    • Class Emailer
    • Class ErrorLogger
    • Class EventLogger
    • Class FluentFuncInvoker
    • Class GroovyServiceInvoker
    • Class JobUpdater
    • Class PropertyBuilder
    • Class ReceiptSvc
    • Class RefDataSvc
    • Class ServiceInvoker
    • Class SvcConnUpdater
    • Class TrackingCodeBuilder
    • Class TxnBuilder
    • Class TxnCheckpointSvc
    • Class TxnUpdater
    • Class UserBuilder

com.avoka.tm.test

  • com.avoka.tm.test
  • Classes

    • Class AbstractJUnitTest
    • Class JUnitTestRunner
    • Class JUnitTestRunner.TestWrapper
    • Class MockRegister
    • Class MockRequest
    • Class MockResponse
    • Class MockServletContext
    • Class MockVoBuilder

    Exception

    • junittestexception

com.avoka.tm.util

  • com.avoka.tm.util
  • Classes

    • Class Contract
    • Class DeliveryResult
    • Class DeliveryResultBuilder
    • Class Logger
    • Class MemCache
    • Class ObjectMapper
    • Class Path
    • Class Security
    • Class Threads
    • Class TxnUrlBuilder
    • Class VelTemplate
    • Class XmlDoc

    Enum

    • Enum ObjectMapper.MappingStrategy

    Exception

    • redirectexception

com.avoka.tm.vo

  • com.avoka.tm.vo
  • Classes

    • Class FileAttach
    • Class Form
    • Class Job
    • Class JobAction
    • Class JobStep
    • Class Space
    • Class SvcConn
    • Class SvcDef
    • Class Txn
    • Class TxnCheckpoint
    • Class TxnDeliveryFunc
    • Class User

Class PropertyQuery

public class PropertyQuery
extends java.lang.Object
Provides a property value query service. Property values are cached in memory for a period of 30 seconds to improve database performance. Examples Example scripts are provided below.

Form Property Example

The example below get the "Product Codes" form version property value for the form's current form version. The property value may be use in Form Prefill or Dynamic Data services.
 import com.avoka.tm.query.*
 String value = new PropertyQuery()
     .setName("Product Codes")
     .setFormCode("PDS-12")
     .getValue() 

Organization Property Example

The example below will get the "Loan Types" Organization property value.
 import com.avoka.tm.query.*
 String value = new PropertyQuery()
     .setName("Loan Types")
     .setClientCode("maguire")
     .getValue() 

Form Space Property Example

The example below will get the "Locale Messages" Form Space property value.
 import com.avoka.tm.query.*
 String value = new PropertyQuery()
     .setName("Locale Messages")
     .setSpaceName("Work Space")
     .getValue() 

Transaction Property Lookup Example

The example below will get the "Saved Email" via the specified Txn value object. This method will attempt to resolve the property value in the order: Form Version Property Value Client Property Value Portal Property Value Deployment Property Value
 import com.avoka.tm.query.*
 import com.avoka.tm.vo.*
 Txn txn = ...
 String value = new PropertyQuery()
     .setName("Saved Email")
     .setTxn(txn)
     .getValue() 

Cached Organization Reference Data Example

The example below will get the "maguire" organization's "Product Codes" reference data. This query data will be cache the value in memory for a period 60 minutes.
 import com.avoka.tm.query.*
 String refData = new PropertyQuery()
     .setName("Product Codes")
     .setClientCode("maguire")
     .setCacheTimeout(60)
     .getValue() 
Since:
5.0.0
See Also:
MemCache

Constructor Summary

Constructors
Constructor Description
PropertyQuery()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description
java.lang.String getValue() Return the property value for the query parameters.
PropertyQuery setCacheTimeout​(int timeoutMins) Set the property query cache timeout in minutes.
PropertyQuery setClientCode​(java.lang.String clientCode) Set the organization client code parameter.
PropertyQuery setFormCode​(java.lang.String formCode) Set the form code parameter.
PropertyQuery setName​(java.lang.String name) Set the property name parameter.
PropertyQuery setSpaceName​(java.lang.String spaceName) Set the property space name parameter.
PropertyQuery setTxn​(Txn txn) Set the transaction to resolve the property value against.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyQuery

public PropertyQuery()

Method Detail

setName

public PropertyQuery setName​(java.lang.String name) Set the property name parameter.
Parameters:
name - the property name
Returns:
the property query

setFormCode

public PropertyQuery setFormCode​(java.lang.String formCode) Set the form code parameter.
Parameters:
formCode - the property form code
Returns:
the property query

setClientCode

public PropertyQuery setClientCode​(java.lang.String clientCode) Set the organization client code parameter.
Parameters:
clientCode - the property client code
Returns:
the property query

setSpaceName

public PropertyQuery setSpaceName​(java.lang.String spaceName) Set the property space name parameter.
Parameters:
spaceName - the property space name
Returns:
the property query

setTxn

public PropertyQuery setTxn​(Txn txn) Set the transaction to resolve the property value against.
Parameters:
txn - the transaction to resolve the property against
Returns:
the property query

setCacheTimeout

public PropertyQuery setCacheTimeout​(int timeoutMins) Set the property query cache timeout in minutes.
Parameters:
timeoutMins - the query cache timeout in minutes, must be a positive value.
Returns:
the property query

getValue

public java.lang.String getValue() Return the property value for the query parameters.
Returns:
the property value for the query parameter
← Class JobQueryClass RefDataQuery →

Terms & Conditions

Privacy Policy

Cookie Policy

Copyright © 2003-2022 Temenos Headquarters SA