Package io.jmix.restds.impl

Record Class RestInvoker.LoadParams

java.lang.Object

java.lang.Record

io.jmix.restds.impl.RestInvoker.LoadParams

Record Components:

additionalParams - parameters added to the query string of the request. Names that the store sets itself (fetchPlan, limit, offset, sort, filter, returnCount) and null values are not allowed.

Enclosing class:

RestInvoker

public static record RestInvoker.LoadParams(String entityName, Object id, @Nullable String fetchPlan, Map<String,Object> additionalParams)
extends Record

Parameters of loading one entity by id.

Constructor Summary

Constructors

Constructor	Description
LoadParams(String entityName, Object id)
LoadParams(String entityName, Object id, @Nullable String fetchPlan)
LoadParams(String entityName, Object id, @Nullable String fetchPlan, Map<String,Object> additionalParams)	Creates an instance of a LoadParams record class.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	additionalParams()	Returns the value of the additionalParams record component.
String	entityName()	Returns the value of the entityName record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable String	fetchPlan()	Returns the value of the fetchPlan record component.
final int	hashCode()	Returns a hash code value for this object.
Object	id()	Returns the value of the id record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LoadParams

public LoadParams(String entityName,
 Object id,
 @Nullable String fetchPlan,
 Map<String,Object> additionalParams)

Creates an instance of a LoadParams record class.

Parameters:

entityName - the value for the entityName record component

id - the value for the id record component

fetchPlan - the value for the fetchPlan record component

additionalParams - the value for the additionalParams record component

LoadParams

public LoadParams(String entityName,
 Object id,
 @Nullable String fetchPlan)

LoadParams

public LoadParams(String entityName,
 Object id)

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

entityName

public String entityName()

Returns the value of the entityName record component.

Returns:

the value of the entityName record component

id

public Object id()

Returns the value of the id record component.

Returns:

the value of the id record component

fetchPlan

public @Nullable String fetchPlan()

Returns the value of the fetchPlan record component.

Returns:

the value of the fetchPlan record component

additionalParams

public Map<String,Object> additionalParams()

Returns the value of the additionalParams record component.

Returns:

the value of the additionalParams record component