io.evitadb.api.requestResponse.schema.EntityAttributeSchemaContract 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
Show all versions of evita_api Show documentation
Module contains external API of the evitaDB.
/*
*
* _ _ ____ ____
* _____ _(_) |_ __ _| _ \| __ )
* / _ \ \ / / | __/ _` | | | | _ \
* | __/\ 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;
/**
* Interface extends the base {@link AttributeSchemaContract} with the ability to mark the attribute as representative.
* This attribute contract can be used only at {@link EntitySchemaContract} level.
*
* @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2023
*/
public interface EntityAttributeSchemaContract extends AttributeSchemaContract {
/**
* If an attribute is flagged as representative, it should be used in developer tools along with the entity's
* primary key to describe the entity or reference to that entity. The flag is completely optional and doesn't
* affect the core functionality of the database in any way. However, if it's used correctly, it can be very
* helpful to developers in quickly finding their way around the data. There should be very few representative
* attributes in the entity type, and the unique ones are usually the best to choose.
*/
boolean isRepresentative();
}