Package de.pisa.psa.rst.obj

Klasse PsaRstApiQue

java.lang.Object

de.pisa.psa.rst.obj.PsaRstApiQue

public class PsaRstApiQue
extends Object

REST API: query

Seit:

05.07.2023

Autor:

weiland

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	PsaRstApiQue.SortEntry	sort entry

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
String	eureka	EUREKA query which will be executed first
int	maximum	maximum number of records
Map<String,String>	query	query
List<PsaRstApiQue.SortEntry>	sort	sorting

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
PsaRstApiQue()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addQuery(String field, 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
Optional<String>	getQuery(String field)	get a query
Optional<PsaRstApiQue.SortEntry>	getSort(String field)	get a sort entry for a field
boolean	hasQuery()	is at least one query defined
boolean	hasSort()	is at least one sorting set
int	indexOfSort(String field)	get the index of a field in the sort list
String	toString()

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

query

public Map<String,String> query

query

sort

public List<PsaRstApiQue.SortEntry> sort

sorting

maximum

public int maximum

maximum number of records

eureka

public String eureka

EUREKA query which will be executed first

Konstruktordetails

PsaRstApiQue

public PsaRstApiQue()

Methodendetails

addQuery

public void addQuery(String field,
 String string)

add a query

Parameter:

field - field

string - query string

getQuery

public Optional<String> getQuery(String field)

get a query

Parameter:

field - field

Gibt zurück:

query string

hasQuery

public boolean hasQuery()

is at least one query defined

Gibt zurück:

true if query is set

addSort

public void addSort(PsaRstApiQue.SortEntry entry)

add a sort entry

Parameter:

entry - entry

indexOfSort

public int indexOfSort(String field)

get the index of a field in the sort list

Parameter:

field - name of the field to search

Gibt zurück:

index in the sort array. -1 if the field was not found

getSort

public Optional<PsaRstApiQue.SortEntry> getSort(String field)

get a sort entry for a field

Parameter:

field - name of the field to search

Gibt zurück:

entry

hasSort

public boolean hasSort()

is at least one sorting set

Gibt zurück:

true if sorting is defined

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object

Siehe auch:

• Object.toString()

get

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

get the query object from the event data

Parameter:

data - event data

Gibt zurück:

query

Löst aus:

de.pisa.psc.srv.glb.PscExc