Package overit.geocall.edm.model

Record Class EntityIndexUpdateResult

java.lang.Object

java.lang.Record

overit.geocall.edm.model.EntityIndexUpdateResult

Record Components:

dataEntity - DataEntity about the data entity for which index update is requested.

indexRealName - String about the real name of the index.

result - EntityIndexUpdateResult.Result about the update operation result.

detailMessage - String about a possible detail message.

exception - Exception about a possible error occurred while updating the index.

All Implemented Interfaces:

Serializable

public record EntityIndexUpdateResult(DataEntity dataEntity, String indexRealName, EntityIndexUpdateResult.Result result, String detailMessage, Exception exception)
extends Record
implements Serializable

Record about the result of the update of an index associated with the provided DataEntity.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EntityIndexUpdateResult.Result

Constructor Summary

Constructors

Constructor	Description
EntityIndexUpdateResult(DataEntity dataEntity, String indexRealName, String detailMessage, Exception exception)	Creates and return a new EntityIndexUpdateResult instance using the provided parameters.
EntityIndexUpdateResult(DataEntity dataEntity, String indexRealName, EntityIndexUpdateResult.Result result, String detailMessage)	Creates and return a new EntityIndexUpdateResult instance using the provided parameters.
EntityIndexUpdateResult(DataEntity dataEntity, String indexRealName, EntityIndexUpdateResult.Result result, String detailMessage, Exception exception)	Creates an instance of a EntityIndexUpdateResult record class.

Method Summary

Modifier and Type	Method	Description
DataEntity	dataEntity()	Returns the value of the dataEntity record component.
String	detailMessage()	Returns the value of the detailMessage record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Exception	exception()	Returns the value of the exception record component.
final int	hashCode()	Returns a hash code value for this object.
String	indexRealName()	Returns the value of the indexRealName record component.
boolean	isError()	Returns true in case the update operation has failed; false otherwise.
void	launchEventIndexUpdatedEvent()	Launches the EntityIndexUpdatedEvent event using the current instance as payload.
EntityIndexUpdateResult.Result	result()	Returns the value of the result record component.
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

EntityIndexUpdateResult

public EntityIndexUpdateResult(DataEntity dataEntity,
 String indexRealName,
 String detailMessage,
 Exception exception)

Creates and return a new EntityIndexUpdateResult instance using the provided parameters.

Parameters:

dataEntity - DataEntity about the data entity for which index update is requested.

indexRealName - String about the real name of the index.

detailMessage - String about a possible detail message.

exception - Exception about an error occurred while updating the index.

EntityIndexUpdateResult

public EntityIndexUpdateResult(DataEntity dataEntity,
 String indexRealName,
 EntityIndexUpdateResult.Result result,
 String detailMessage)

Creates and return a new EntityIndexUpdateResult instance using the provided parameters.

Parameters:

dataEntity - DataEntity about the data entity for which index update is requested.

indexRealName - String about the real name of the index.

result - EntityIndexUpdateResult.Result about the update operation result.

detailMessage - String about a possible detail message.

EntityIndexUpdateResult

public EntityIndexUpdateResult(DataEntity dataEntity,
 String indexRealName,
 EntityIndexUpdateResult.Result result,
 String detailMessage,
 Exception exception)

Creates an instance of a EntityIndexUpdateResult record class.

Parameters:

dataEntity - the value for the dataEntity record component

indexRealName - the value for the indexRealName record component

result - the value for the result record component

detailMessage - the value for the detailMessage record component

exception - the value for the exception record component

Method Details

launchEventIndexUpdatedEvent

public void launchEventIndexUpdatedEvent()

Launches the EntityIndexUpdatedEvent event using the current instance as payload.

isError

public boolean isError()

Returns true in case the update operation has failed; false otherwise.

Returns:

true in case the update operation has failed; false otherwise.

toString

public 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.

dataEntity

public DataEntity dataEntity()

Returns the value of the dataEntity record component.

Returns:

the value of the dataEntity record component

indexRealName

public String indexRealName()

Returns the value of the indexRealName record component.

Returns:

the value of the indexRealName record component

result

public EntityIndexUpdateResult.Result result()

Returns the value of the result record component.

Returns:

the value of the result record component

detailMessage

public String detailMessage()

Returns the value of the detailMessage record component.

Returns:

the value of the detailMessage record component

exception

public Exception exception()

Returns the value of the exception record component.

Returns:

the value of the exception record component