io.evitadb.api.proxy.SealedEntityProxy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation
Module contains external API of the evitaDB.
There is a newer version: 2024.10.0
/*
 *
 *                         _ _        ____  ____
 *               _____   _(_) |_ __ _|  _ \| __ )
 *              / _ \ \ / / | __/ _` | | | |  _ \
 *             |  __/\ V /| | || (_| | |_| | |_) |
 *              \___| \_/ |_|\__\__,_|____/|____/
 *
 *   Copyright (c) 2023
 *
 *   Licensed under the Business Source License, Version 1.1 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   https://github.com/FgForrest/evitaDB/blob/master/LICENSE
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

package io.evitadb.api.proxy;

import io.evitadb.api.EvitaSessionContract;
import io.evitadb.api.requestResponse.data.EntityEditor.EntityBuilder;
import io.evitadb.api.requestResponse.data.SealedEntity;
import io.evitadb.api.requestResponse.data.structure.EntityReference;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.Serializable;
import java.util.Optional;
import java.util.function.Consumer;

/**
 * This interface is implemented by all proxy types that wrap a sealed entity and provide access to an instance of
 * the {@link SealedEntity} trapped in the proxy state object.
 *
 * @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2023
 */
public interface SealedEntityProxy extends
	EvitaProxy,
	WithEntityContract,
	WithEntityBuilder,
	ReferencedEntityBuilderProvider
{

	/**
	 * Returns the primary key of the underlying sealed entity. The primary key might be null if the entity hasn't been
	 * yet upserted to the database.
	 *
	 * @return the primary key of the underlying sealed entity
	 */
	@Nullable
	Integer getPrimaryKey();

	/**
	 * Retrieves an {@link Optional} that contains an {@link EntityBuilderWithCallback} instance.
	 * The {@link EntityBuilderWithCallback} contains both {@link EntityBuilder} and callback that should be called
	 * when the builder mutations is applied via {@link EvitaSessionContract#upsertEntity(Serializable)} method.
	 *
	 * @return an {@link Optional} that contains an {@link EntityBuilderWithCallback} instance, if present
	 */
	@Nonnull
	Optional getEntityBuilderWithCallback();

	/**
	 * Types of generated proxies.
	 */
	enum ProxyType {
		PARENT,
		REFERENCE,
		REFERENCED_ENTITY
	}

	/**
	 * Record wrapping {@link EntityBuilder} and callback that is called when the builder mutations is applied via
	 * {@link EvitaSessionContract#upsertEntityDeeply(Serializable)} method.
	 */
	record EntityBuilderWithCallback(
		@Nonnull EntityBuilder builder,
		@Nullable Consumer upsertCallback
	) {

		/**
		 * Method invokes the {@link #upsertCallback} callback if it is present.
		 */
		public void updateEntityReference(@Nonnull EntityReference entityReference) {
			if (upsertCallback != null) {
				upsertCallback.accept(entityReference);
			}
		}

	}

}