Package de.pisa.psa.rst.obj

Class PsaRstApiQue

java.lang.Object

de.pisa.psa.rst.obj.PsaRstApiQue

public class PsaRstApiQue
extends java.lang.Object

REST API: query

Since:

05.07.2023

Author:

weiland

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PsaRstApiQue.SortEntry	sort entry

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	eureka	EUREKA query which will be executed first
int	maximum	maximum number of records
java.util.Map<java.lang.String,java.lang.String>	query	query
java.util.List<PsaRstApiQue.SortEntry>	sort	sorting

Constructor Summary

Constructors

Constructor	Description
PsaRstApiQue()

Method Summary

Modifier and Type	Method	Description
void	addQuery(java.lang.String field, java.lang.String string)	add a query
void	addSort(PsaRstApiQue.SortEntry entry)	add a sort entry
static PsaRstApiQue	get(PsaRstApiEvtHdlDat data)	get the query object from the event data
boolean	hasQuery()	is at least one query defined
boolean	hasSort()	is at least one sorting set
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

query

public java.util.Map<java.lang.String,java.lang.String> query

query

sort

public java.util.List<PsaRstApiQue.SortEntry> sort

sorting

maximum

public int maximum

maximum number of records

eureka

public java.lang.String eureka

EUREKA query which will be executed first

Constructor Detail

PsaRstApiQue

public PsaRstApiQue()

Method Detail

addQuery

public void addQuery(java.lang.String field,
                     java.lang.String string)

add a query

Parameters:

field - field

string - query string

hasQuery

public boolean hasQuery()

is at least one query defined

Returns:

true if query is set

addSort

public void addSort(PsaRstApiQue.SortEntry entry)

add a sort entry

Parameters:

entry - entry

hasSort

public boolean hasSort()

is at least one sorting set

Returns:

true if sorting is defined

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

get

public static PsaRstApiQue get(PsaRstApiEvtHdlDat data)
                        throws de.pisa.psc.srv.glb.PscExc

get the query object from the event data

Parameters:

data - event data

Returns:

query

Throws:

de.pisa.psc.srv.glb.PscExc