io.evitadb.api.requestResponse.schema.dto.EntitySchemaProvider 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.requestResponse.schema.dto;

import io.evitadb.api.requestResponse.schema.EntitySchemaContract;

import javax.annotation.Nonnull;
import java.util.Collection;
import java.util.Optional;

/**
 * An interface for accessing entity schemas.
 */
public interface EntitySchemaProvider {

	/**
	 * Returns a collection of all entity schemas in catalog.
	 *
	 * @return a collection of entity schemas in catalog
	 */
	@Nonnull
	Collection getEntitySchemas();

	/**
	 * Retrieves the entity schema for the given entity type.
	 *
	 * @param entityType the type of entity for which to retrieve the schema
	 * @return an optional containing the entity schema, empty if the schema does not exist
	 */
	@Nonnull
	Optional getEntitySchema(@Nonnull String entityType);

}