io.konga.metadata.definition.KongaEntity Maven / Gradle / Ivy
package io.konga.metadata.definition;
import java.util.List;
import io.konga.metadata.annotations.FieldType;
import io.konga.metadata.annotations.Linked;
import io.konga.metadata.annotations.Action;
import io.konga.metadata.annotations.Actions;
import io.konga.metadata.annotations.ApiPath;
import io.konga.metadata.annotations.Categories;
import io.konga.metadata.annotations.Createable;
import io.konga.metadata.annotations.Defaults;
import io.konga.metadata.annotations.Deleteable;
import io.konga.metadata.annotations.Editable;
import io.konga.metadata.annotations.Entity;
import io.konga.metadata.annotations.EntityId;
import io.konga.metadata.annotations.EntityKey;
import io.konga.metadata.annotations.EntityLabel;
import io.konga.metadata.annotations.Field;
import io.konga.metadata.annotations.FieldSets;
import io.konga.metadata.annotations.FieldSet;
import io.konga.metadata.annotations.FormStyle;
import io.konga.metadata.annotations.FormType;
import io.konga.metadata.annotations.Hint;
import io.konga.metadata.annotations.Label;
import io.konga.metadata.annotations.MaxLength;
import io.konga.metadata.annotations.Multiplicity;
import io.konga.metadata.annotations.OverrideDefaults;
import io.konga.metadata.annotations.Raw;
import io.konga.metadata.annotations.Required;
import io.konga.metadata.annotations.Searchable;
import io.konga.metadata.annotations.ShowInResults;
import io.konga.metadata.annotations.ShowInUpdate;
import io.konga.metadata.annotations.Type;
import io.konga.metadata.definition.enumerations.AccessModes;
import io.konga.metadata.definition.enumerations.DataTypes;
import io.konga.metadata.definition.enumerations.FieldTypes;
import io.konga.metadata.definition.enumerations.FormModes;
import io.konga.metadata.definition.enumerations.FormStyles;
import io.konga.metadata.definition.enumerations.FormTypes;
import io.konga.metadata.definition.enumerations.Multiplicities;
import io.konga.metadata.definition.enumerations.Stereotypes;
@Entity("konga-entity")
@Label("Entity")
@ApiPath("entities")
@Searchable
@Createable
@Editable
@Deleteable
@FormType(update= FormTypes.TABBED)
@FormStyle(update= FormStyles.HORIZONTAL)
@OverrideDefaults(
@Action(overrides="save", name="inner-save")
)
@FieldSets({
@FieldSet("General"),
@FieldSet("Operations"),
@FieldSet("Appearance")
})
public class KongaEntity {
private Class classFor;
@Field
@EntityId
@Searchable("SUPER_ADMIN")
@ShowInResults("SUPER_ADMIN")
@ShowInUpdate("SUPER_ADMIN")
@Editable("SUPER_ADMIN")
private Integer id;
/**
* Name of the entity
*/
@Field
@Label("Name")
@Hint("Unique name for your entity. This name will be used to identify your entity within Konga.")
@Type(DataTypes.STRING)
@EntityKey
@Searchable
@ShowInResults
@ShowInUpdate
@Editable
@Required
@MaxLength(40)
@FieldSet("General")
private String name;
/**
* Superclass of the entity
*/
@Field
@Label("Parent entity")
@Hint("Parent of this entity. This is useful if you are defining hierarchized items - e.g. if you are creating a \"Car\", whose parent would be \"Vehicle\"")
@Type(value=DataTypes.COMPLEX, complexType="konga-entity")
@io.konga.metadata.annotations.FieldType(FieldTypes.SELECT)
@EntityLabel
@Searchable
@ShowInResults
@ShowInUpdate
@Editable
@FieldSet("General")
private String superClass;
/**
* Label for the entity (placeholder name)
*/
@Field
@Label("Label")
@Hint("A label renders the human-readable name for the entity. You can either use plain Strings, or a placeholder to a translated text")
@EntityLabel
@ShowInResults
@ShowInUpdate
@Editable
@Required
@FieldSet("General")
private String label;
/**
* Short Label for the entity (placeholder name)
*/
@Field
@Label("Short label")
@Hint("Short version of the label. You can optionally define tables to render this label instead of the long one, to save screen space")
@ShowInUpdate
@Editable
@FieldSet("General")
private String shortLabel;
/**
* Access configuration
*/
@Field
@Label("Visibility")
@Hint("Define how your entity will be shown in the app. PUBLIC entities are those who can work standalone - i.e. Users can perform operations directly on it - while SYSTEM entities define relationships that are hidden to the user")
@Searchable
@ShowInUpdate
@Editable
@Type(value=DataTypes.STRING, list={
@Raw(key="public", value="Visible"),
@Raw(key="hidden", value="Hidden (System entity)"),
})
@Defaults("public")
@io.konga.metadata.annotations.FieldType(FieldTypes.COMBOBOX)
@FieldSet("Operations")
private AccessModes access;
/**
* Stereotypes for the entity
*/
private List stereotypes;
/**
* Permission needed for searching the entity
*/
@Field("searchEnabled")
@Label("Searchable")
@Type(DataTypes.BOOLEAN)
@io.konga.metadata.annotations.FieldType(update=FieldTypes.SWITCH)
@Editable
@Defaults("false")
@FieldSet("Operations")
private boolean searchEnabled;
@Field("searchable")
@Label("For who?")
@Hint("Permission for search. Left blank for public")
@Editable
@FieldSet("Operations")
@io.konga.metadata.annotations.Linked(to="searchEnabled", via="permissions-checked")
private String searchable;
/**
* Permission needed for creating entities
*/
@Field("createEnabled")
@Label("Createable")
@Type(DataTypes.BOOLEAN)
@io.konga.metadata.annotations.FieldType(update=FieldTypes.SWITCH)
@Editable
@Defaults("false")
@FieldSet("Operations")
private boolean createEnabled;
@Field("createable")
@Label("For who?")
@Hint("Permission for creating. Left blank for public")
@Editable
@FieldSet("Operations")
@io.konga.metadata.annotations.Linked(to="createEnabled", via="permissions-checked")
private String createable;
/**
* Permission needed for updating the entity
*/
@Field("editEnabled")
@Label("Editable")
@Type(DataTypes.BOOLEAN)
@io.konga.metadata.annotations.FieldType(update=FieldTypes.SWITCH)
@Editable
@Defaults("false")
@FieldSet("Operations")
private boolean editEnabled;
@Field("editable")
@Label("For who?")
@Hint("Permission for edition. Left blank for public")
@Editable
@FieldSet("Operations")
@io.konga.metadata.annotations.Linked(to="editEnabled", via="permissions-checked")
private String editable;
/**
* Permission needed for deleting
*/
@Field("deleteEnabled")
@Label("Deleteable")
@Type(DataTypes.BOOLEAN)
@io.konga.metadata.annotations.FieldType(update=FieldTypes.SWITCH)
@Editable
@Defaults("false")
@FieldSet("Operations")
private boolean deletePermissions;
@Field("deleteable")
@Label("For who?")
@Hint("Permission for search. If left blank, anybody could search this entity")
@Editable
@FieldSet("Operations")
@Linked(to="deleteEnabled", via="permissions-checked")
private String deleteable;
/**
* Form type for searching the entity
*/
@Field
@Label("Search form")
@ShowInUpdate
@Editable
@Type(value=DataTypes.STRING, list={
@Raw(key="CASCADE", value="Cascade"),
@Raw(key="CATEGORIZED_CASCADE", value="Categorized Cascade"),
@Raw(key="TABBED", value="Tabbed"),
@Raw(key="STEPPED", value="Stepped"),
@Raw(key="CUSTOM_TABBED", value="Fieldset tabbed (custom views)"),
@Raw(key="CUSTOM", value="Custom")
})
@Defaults("CASCADE")
@FieldSet("Appearance")
@io.konga.metadata.annotations.FieldType(FieldTypes.COMBOBOX)
private FormTypes searchType;
/**
* Form style for search panels
*/
@Field
@Label("Search form style")
@Type(value=DataTypes.STRING, list={
@Raw(key="STANDARD", value="Label and input in block"),
@Raw(key="HORIZONTAL", value="Label and input inline")
})
@Defaults("HORIZONTAL")
@FieldSet("Appearance")
@io.konga.metadata.annotations.FieldType(FieldTypes.COMBOBOX)
private FormStyles searchStyle;
/**
* Form type for the results pane
*/
@Field
@Label("Results form type")
@ShowInUpdate
@Editable
@Type(value=DataTypes.STRING, list={
@Raw(key="CASCADE", value="Cascade"),
@Raw(key="CATEGORIZED_CASCADE", value="Categorized Cascade"),
@Raw(key="TABBED", value="Tabbed"),
@Raw(key="STEPPED", value="Stepped"),
@Raw(key="CUSTOM_TABBED", value="Fieldset tabbed (custom views)"),
@Raw(key="CUSTOM", value="Custom")
})
@Defaults("CASCADE")
@FieldSet("Appearance")
@io.konga.metadata.annotations.FieldType(FieldTypes.COMBOBOX)
private FormTypes resultsType;
/**
* Form style for results panels
*/
@Field
@Label("Results form style")
@Type(value=DataTypes.STRING, list={
@Raw(key="STANDARD", value="Label and input in block"),
@Raw(key="HORIZONTAL", value="Label and input inline")
})
@Defaults("HORIZONTAL")
@FieldSet("Appearance")
@io.konga.metadata.annotations.FieldType(FieldTypes.COMBOBOX)
private FormStyles resultsStyle;
/**
* Form type for the details pane
*/
@Field
@Label("Details form type")
@ShowInUpdate
@Editable
@Type(value=DataTypes.STRING, list={
@Raw(key="CASCADE", value="Cascade"),
@Raw(key="CATEGORIZED_CASCADE", value="Categorized Cascade"),
@Raw(key="TABBED", value="Tabbed"),
@Raw(key="STEPPED", value="Stepped"),
@Raw(key="CUSTOM_TABBED", value="Fieldset tabbed (custom views)"),
@Raw(key="CUSTOM", value="Custom")
})
@Defaults("CASCADE")
@FieldSet("Appearance")
@io.konga.metadata.annotations.FieldType(FieldTypes.COMBOBOX)
private FormTypes detailsType;
/**
* Form style for details panels
*/
@Field
@Label("Details form style")
@Type(value=DataTypes.STRING, list={
@Raw(key="STANDARD", value="Label and input in block"),
@Raw(key="HORIZONTAL", value="Label and input inline")
})
@Defaults("HORIZONTAL")
@FieldSet("Appearance")
@io.konga.metadata.annotations.FieldType(FieldTypes.COMBOBOX)
private FormStyles detailsStyle;
/**
* Form type for the update pane
*/
@Field
@Label("Update form type")
@ShowInUpdate
@Editable
@Type(value=DataTypes.STRING, list={
@Raw(key="CASCADE", value="Cascade"),
@Raw(key="CATEGORIZED_CASCADE", value="Categorized Cascade"),
@Raw(key="TABBED", value="Tabbed"),
@Raw(key="STEPPED", value="Stepped"),
@Raw(key="CUSTOM_TABBED", value="Fieldset tabbed (custom views)"),
@Raw(key="CUSTOM", value="Custom")
})
@Defaults("CASCADE")
@FieldSet("Appearance")
@io.konga.metadata.annotations.FieldType(FieldTypes.COMBOBOX)
private FormTypes updateType;
/**
* Form style for update panels
*/
@Field
@Label("Update form style")
@Type(value=DataTypes.STRING, list={
@Raw(key="STANDARD", value="Label and input in block"),
@Raw(key="HORIZONTAL", value="Label and input inline")
})
@Defaults("HORIZONTAL")
@FieldSet("Appearance")
@io.konga.metadata.annotations.FieldType(FieldTypes.COMBOBOX)
private FormStyles updateStyle;
/**
* Template for the update form
* TODO Change to allow customization on all forms
*/
private String template;
/**
* Overrides the name of the entity for api requests
*/
private String apiName;
/**
* Overrides the standard api path for requests
*/
@Field
@Label("API Path")
@Searchable("SUPER_ADMIN")
@ShowInUpdate("SUPER_ADMIN")
@Editable("SUPER_ADMIN")
@Categories("Configuration")
private String apiPath;
/**
* Set of categories of the entity
*/
@Field
@Label("API Path")
@Searchable
@ShowInUpdate
@Editable
@Type(DataTypes.STRING)
@Multiplicity(Multiplicities.MANY)
@FieldSet("General")
private List categories;
/**
* Security configuration for the entity
*/
private Security security;
/**
* Entity fields
*/
@Field
@Label("Fields")
// @ShowInUpdate(fields={"id", "name", "type"})
@Editable
@Type(value=DataTypes.COMPLEX, complexType="konga-field")
@io.konga.metadata.annotations.FieldType(FieldTypes.PICK_LIST)
@Multiplicity(Multiplicities.MANY)
@Categories("Fields")
@OverrideDefaults(
@Action(overrides="add", name="add-field-to-entity")
)
@Actions({
@Action(icon="fa fa-edit", name="edit-field", label="Edit", scope=FormModes.UPDATE),
@Action(icon="fa fa-remove", name="remove-field", label="Remove", scope=FormModes.UPDATE)
})
private List fields;
/**
* List of field sets for the entity
*/
@Field
@Label("Field sets")
@Hint("Define here your field groupings, if you are going to do any customization to them")
@ShowInUpdate("SUPER_ADMIN")
@Editable("SUPER_ADMIN")
@Type(value=DataTypes.COMPLEX, complexType="konga-fieldset")
@io.konga.metadata.annotations.FieldType(FieldTypes.PICK_LIST)
@Multiplicity(Multiplicities.MANY)
@Categories("Fields")
private List fieldSets;
/**
* Entity actions
*/
@Field
@Label("Actions")
@Hint("Define here the custom actions you will implement over this entity")
@ShowInUpdate("SUPER_ADMIN")
@Editable("SUPER_ADMIN")
@Type(value=DataTypes.COMPLEX, complexType="konga-action")
@io.konga.metadata.annotations.FieldType(FieldTypes.PICK_LIST)
@Multiplicity(Multiplicities.MANY)
@Categories("Customization")
private List actions;
/**
* Override defaults
*/
@Field
@Label("Defaults overriden")
@Hint("Add here the actions you will develop for overriding standard content")
@ShowInUpdate("SUPER_ADMIN")
@Editable("SUPER_ADMIN")
@Type(value=DataTypes.COMPLEX, complexType="konga-action")
@io.konga.metadata.annotations.FieldType(FieldTypes.PICK_LIST)
@Multiplicity(Multiplicities.MANY)
@Categories("Customization")
private List overrideDefaults;
/**
* Entity configuration
*/
@Field
@Label("Configuration")
@Hint("Configure your entity here")
@ShowInUpdate("SUPER_ADMIN")
@Editable("SUPER_ADMIN")
@Type(value=DataTypes.COMPLEX, complexType="konga-configuration")
@FieldType(FieldTypes.PICK_LIST)
@Multiplicity(Multiplicities.MANY)
private List configuration;
/**
* Defines whether the entity could save favorite filters
*/
private Boolean favoriteable;
/**
* Overrides native action on clicking a result row
*/
private List resultClick;
public Class getClassFor() {
return classFor;
}
public void setClassFor(Class classFor) {
this.classFor = classFor;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getSuperClass() {
return superClass;
}
public void setSuperClass(String superClass) {
this.superClass = superClass;
}
public String getLabel() {
return label;
}
public void setLabel(String label) {
this.label = label;
}
public String getShortLabel() {
return shortLabel;
}
public void setShortLabel(String shortLabel) {
this.shortLabel = shortLabel;
}
public AccessModes getAccess() {
return access;
}
public void setAccess(AccessModes access) {
this.access = access;
}
public List getStereotypes() {
return stereotypes;
}
public void setStereotypes(List stereotypes) {
this.stereotypes = stereotypes;
}
public String getSearchable() {
return searchable;
}
public void setSearchable(String searchable) {
this.searchable = searchable;
}
public String getCreateable() {
return createable;
}
public void setCreateable(String createable) {
this.createable = createable;
}
public String getEditable() {
return editable;
}
public void setEditable(String editable) {
this.editable = editable;
}
public String getDeleteable() {
return deleteable;
}
public void setDeleteable(String deleteable) {
this.deleteable = deleteable;
}
public FormTypes getSearchType() {
return searchType;
}
public void setSearchType(FormTypes searchType) {
this.searchType = searchType;
}
public FormTypes getResultsType() {
return resultsType;
}
public void setResultsType(FormTypes resultsType) {
this.resultsType = resultsType;
}
public FormTypes getDetailsType() {
return detailsType;
}
public void setDetailsType(FormTypes detailsType) {
this.detailsType = detailsType;
}
public FormTypes getUpdateType() {
return updateType;
}
public void setUpdateType(FormTypes updateType) {
this.updateType = updateType;
}
public String getTemplate() {
return template;
}
public void setTemplate(String template) {
this.template = template;
}
public String getApiName() {
return apiName;
}
public void setApiName(String apiName) {
this.apiName = apiName;
}
public String getApiPath() {
return apiPath;
}
public void setApiPath(String apiPath) {
this.apiPath = apiPath;
}
public List getCategories() {
return categories;
}
public void setCategories(List categories) {
this.categories = categories;
}
public Security getSecurity() {
return security;
}
public void setSecurity(Security security) {
this.security = security;
}
public List getFields() {
return fields;
}
public void setFields(List fields) {
this.fields = fields;
}
public List getActions() {
return actions;
}
public void setActions(List actions) {
this.actions = actions;
}
public List getResultClick() {
return resultClick;
}
public void setResultClick(List resultClick) {
this.resultClick = resultClick;
}
public List getFieldSets() {
return fieldSets;
}
public void setFieldSets(List fieldSets) {
this.fieldSets = fieldSets;
}
public FormStyles getSearchStyle() {
return searchStyle;
}
public void setSearchStyle(FormStyles searchStyle) {
this.searchStyle = searchStyle;
}
public FormStyles getResultsStyle() {
return resultsStyle;
}
public void setResultsStyle(FormStyles resultsStyle) {
this.resultsStyle = resultsStyle;
}
public FormStyles getDetailsStyle() {
return detailsStyle;
}
public void setDetailsStyle(FormStyles detailsStyle) {
this.detailsStyle = detailsStyle;
}
public FormStyles getUpdateStyle() {
return updateStyle;
}
public void setUpdateStyle(FormStyles updateStyle) {
this.updateStyle = updateStyle;
}
public List getConfiguration() {
return configuration;
}
public void setConfiguration(List configuration) {
this.configuration = configuration;
}
public List getOverrideDefaults() {
return overrideDefaults;
}
public void setOverrideDefaults(List overrideDefaults) {
this.overrideDefaults = overrideDefaults;
}
public Boolean getFavoriteable() {
return favoriteable;
}
public void setFavoriteable(Boolean favoriteable) {
this.favoriteable = favoriteable;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy