Package adalid.core.interfaces

Interface Entity

All Superinterfaces:
Artifact, Comparable<Entity>, DataArtifact, EntityReferenceContainer, Nullable, Serializable, TypedArtifact
All Known Subinterfaces:
DatabaseEntity, EntityReference, PersistentEntity, PersistentEntityReference, PersistentEnumerationEntity, PersistentEnumerationEntityReference
All Known Implementing Classes:
AbstractContextualEntity, AbstractDatabaseEntity, AbstractEntity, AbstractEnumerationEntity, AbstractPersistentEntity, AbstractPersistentEnumerationEntity, AbstractProceduralEntity, AbstractVirtualEntity, AccionArchivoCargado, AmbientePrueba, Aplicacion, ArchivoAdjunto, AtributoAplicacion, CampoValorTemporal, CasoPrueba, ClaseFabricador, ClaseJava, ClaseRecurso, ClaseRecurso, ColumnasOcultas, CondicionEjeFun, CondicionTarea, ConjuntoSegmento, DialogoDinamicoRemoto, DocumentoPrueba, DocumentoPruebaX1, DocumentoPruebaX2, DocumentoPruebaX3, DocumentoPruebaX4, DocumentoPruebaX5, DocumentoPruebaX6, Dominio, Dominio, DominioParametro, EjecucionLineaPrueba, EjecucionPrueba, ElementoSegmento, EscenarioPrueba, FiltroFuncion, FiltroFuncionPar, FormatoPaginaInforme, Funcion, Funcion, FuncionParametro, FuncionParametro, GrupoProceso, GrupoUsuario, LineaPrueba, MensajeAplicacion, ModuloAplicacion, NivelOpcionMenu, OpcionMenu, OperadorCom, Pagina, PaginaEspecial, PaginaInicio, PaginaUsuario, PaquetePrueba, Parametro, ParametroLineaPrueba, ParteAmbientePrueba, PasoRutina, PersistentEntityBase, PersistentEnumerationEntityBase, PiezaAmbientePrueba, ProgramaPrueba, RangoAgregacion, RangoComparacion, RastroFuncion, RastroFuncionPar, RastroInforme, RastroProceso, RecursoValor, Rol, RolAplicacion, RolFiltroFuncion, RolFuncion, RolFuncionPar, RolPagina, RolPaginaEspecial, RolUsuario, RolVistaFuncion, RutinaUsuario, Segmento, SeveridadMensaje, SubtipoGrafico, TareaUsuario, TareaUsuarioCorreo, TareaVirtual, TipoAgregacion, TipoClaseRecurso, TipoComparacion, TipoDatoPar, TipoDocumentoPrueba, TipoDominio, TipoFuncion, TipoGrafico, TipoInforme, TipoNodo, TipoPagina, TipoParametro, TipoParametroDom, TipoPiezaPrueba, TipoRastroFun, TipoRecurso, TipoRestriccionFormatos, TipoResultadoPrueba, TipoRol, TipoUsuario, TipoValor, TipoValorCriterio, TransicionAbstracta, TransicionTareaUsuario, Usuario, Usuario, UsuarioFuncion, UsuarioFuncionPar, UsuarioModulo, UsuarioSegmento, VariableRutina, VersionAdalid, VistaFuncion, VistaFuncionCol
public interface Entity extends Comparable<Entity>, DataArtifact, EntityReferenceContainer
Author:
Jorge Campins

  • Method Details

    • isAssignableFrom

      default boolean isAssignableFrom(Entity entity)
      Determina si la clase de esta entidad es la misma o es una superclase de la clase de la entidad especificada en el parámetro entity.
      Parameters:
      entity - la entidad a examinar.
      Returns:
      el valor boolean que indica si la clase de entity se puede asignar a la clase de esta entidad.
      Throws:
      NullPointerException - si el parámetro entity especificado es nulo.

    • isInitialised

      boolean isInitialised()
      Returns:
      the initialised indicator

    • isSettled

      boolean isSettled()
      Returns:
      the settled indicator

    • isRootInstance

      boolean isRootInstance()
      Returns:
      the root indicator

    • isExplicitlyDeclared

      boolean isExplicitlyDeclared()
      Returns:
      the explicitly declared indicator

    • isImplicitlyDeclared

      boolean isImplicitlyDeclared()
      Returns:
      the implicitly declared indicator

    • getReferenceIndex

      int getReferenceIndex()
      Returns:
      the reference index

    • getDefaultLabel

      String getDefaultLabel(EntityReference reference)
      Parameters:
      reference - entity reference
      Returns:
      the default label

    • getDefaultShortLabel

      String getDefaultShortLabel(EntityReference reference)
      Parameters:
      reference - entity reference
      Returns:
      the default short label

    • getDefaultCollectionLabel

      String getDefaultCollectionLabel(EntityReference reference)
      Parameters:
      reference - entity reference
      Returns:
      the default collection label

    • getDefaultCollectionShortLabel

      String getDefaultCollectionShortLabel(EntityReference reference)
      Parameters:
      reference - entity reference
      Returns:
      the default collection short label

    • getDefaultMenuOptionLabel

      String getDefaultMenuOptionLabel(DisplayFormat format)
      Parameters:
      format - the display format
      Returns:
      the localized menu option label

    • getLocalizedLabel

      String getLocalizedLabel(Locale locale, EntityReference reference)
      Parameters:
      locale - locale
      reference - entity reference
      Returns:
      the localized label

    • getLocalizedShortLabel

      String getLocalizedShortLabel(Locale locale, EntityReference reference)
      Parameters:
      locale - locale
      reference - entity reference
      Returns:
      the localized short label

    • getLocalizedCollectionLabel

      String getLocalizedCollectionLabel(Locale locale, EntityReference reference)
      Parameters:
      locale - locale
      reference - entity reference
      Returns:
      the localized collection label

    • getLocalizedCollectionShortLabel

      String getLocalizedCollectionShortLabel(Locale locale, EntityReference reference)
      Parameters:
      locale - locale
      reference - entity reference
      Returns:
      the localized collection short label

    • getLocalizedMenuOptionLabel

      String getLocalizedMenuOptionLabel(Locale locale, DisplayFormat format)
      Parameters:
      locale - the locale for the label
      format - the display format
      Returns:
      the localized menu option label

    • getReferencePropertiesCount

      int getReferencePropertiesCount()
      Returns:
      the number of reference properties

    • getPropertiesList

      List<Property> getPropertiesList()
      Returns:
      the properties list

    • getEntityCollectionsList

      List<EntityCollection> getEntityCollectionsList()
      Returns:
      the entity collection list

    • getReferencesList

      List<Property> getReferencesList()
      Returns:
      the references list

    • getParameterReferencesList

      List<Parameter> getParameterReferencesList()
      Returns:
      the parameter references list

    • getKeysList

      List<Key> getKeysList()
      Returns:
      the keys list

    • getStepsList

      List<Step> getStepsList()
      Returns:
      the steps list

    • getTabsList

      List<Tab> getTabsList()
      Returns:
      the tabs list

    • getViewsList

      List<View> getViewsList()
      Returns:
      the views list

    • getInstancesList

      List<Instance> getInstancesList()
      Returns:
      the instances list

    • getNamedValuesList

      List<NamedValue> getNamedValuesList()
      Returns:
      the named values list

    • getExpressionsList

      List<Expression> getExpressionsList()
      Returns:
      the expressions list

    • getTransitionsList

      List<Transition> getTransitionsList()
      Returns:
      the transitions list

    • getOperationsList

      List<Operation> getOperationsList()
      Returns:
      the operations list

    • getOperationClassesList

      List<Class<?>> getOperationClassesList()
      Returns:
      the operation classes list

    • getTriggersList

      List<Trigger> getTriggersList()
      Returns:
      the triggers list

    • getCalculablePropertiesList

      List<Property> getCalculablePropertiesList()
      Returns:
      the calculable properties list

    • getOverlayPropertiesList

      List<Property> getOverlayPropertiesList()
      Returns:
      the overlay properties list

    • getQueryPropertiesList

      List<Property> getQueryPropertiesList()
      Returns:
      the query properties list

    • getPropertiesMap

      Map<String,Property> getPropertiesMap()
      Returns:
      the properties map

    • getEntityCollectionsMap

      Map<String,EntityCollection> getEntityCollectionsMap()
      Returns:
      the entity collection map

    • getReferencesMap

      Map<String,Property> getReferencesMap()
      Returns:
      the references map

    • getParameterReferencesMap

      Map<String,Parameter> getParameterReferencesMap()
      Returns:
      the parameter references map

    • getKeysMap

      Map<String,Key> getKeysMap()
      Returns:
      the keys map

    • getStepsMap

      Map<String,Step> getStepsMap()
      Returns:
      the staps map

    • getTabsMap

      Map<String,Tab> getTabsMap()
      Returns:
      the tabs map

    • getViewsMap

      Map<String,View> getViewsMap()
      Returns:
      the views map

    • getInstancesMap

      Map<String,Instance> getInstancesMap()
      Returns:
      the instances map

    • getNamedValuesMap

      Map<String,NamedValue> getNamedValuesMap()
      Returns:
      the named values map

    • getExpressionsMap

      Map<String,Expression> getExpressionsMap()
      Returns:
      the expressions map

    • getTransitionsMap

      Map<String,Transition> getTransitionsMap()
      Returns:
      the transitions map

    • getOperationsMap

      Map<String,Operation> getOperationsMap()
      Returns:
      the operations map

    • getOperationClassesMap

      Map<String,Class<?>> getOperationClassesMap()
      Returns:
      the operation classes map

    • getTriggersMap

      Map<String,Trigger> getTriggersMap()
      Returns:
      the triggers map

    • getCalculablePropertiesMap

      Map<String,Property> getCalculablePropertiesMap()
      Returns:
      the calculable properties map

    • getOverlayPropertiesMap

      Map<String,Property> getOverlayPropertiesMap()
      Returns:
      the overlay properties map

    • getQueryPropertiesMap

      Map<String,Property> getQueryPropertiesMap()
      Returns:
      the query properties map

    • getMainEntityReferenceFrom

      EntityReference getMainEntityReferenceFrom(Class<?> type)
      Parameters:
      type - an entity class
      Returns:
      the main entity reference from another entity class

    • isAbstractClass

      boolean isAbstractClass()
      Returns:
      true if the entity is an abstract entity class

    • getBaseClass

      Class<?> getBaseClass()
      Returns:
      the base class

    • getSubclassesList

      List<Class<?>> getSubclassesList()
      Returns:
      the direct known subclasses list

    • getSubclassesMap

      Map<String,Class<?>> getSubclassesMap()
      Returns:
      the direct known subclasses map

    • getSubentitiesMap

      Map<String,Entity> getSubentitiesMap()
      Returns:
      the direct known subentities map

    • getAllocationOverridesList

      List<AllocationOverride> getAllocationOverridesList()
      Returns:
      the allocation overrides list

    • getAllocationOverridesMap

      Map<String,AllocationOverride> getAllocationOverridesMap()
      Returns:
      the allocation overrides map

    • getSuperViewName

      String getSuperViewName()
      Returns:
      the super-view name

    • setSuperViewName

      void setSuperViewName(String viewName)
      El método setSuperViewName se utiliza para establecer el nombre de la super-vista de la entidad. Si este método no es ejecutado, el nombre de la super-vista se determina a partir del nombre SQL de la entidad.
      Parameters:
      viewName - nombre de la super-vista

    • getSupraViewName

      String getSupraViewName()
      Returns:
      the supra-view name

    • setSupraViewName

      void setSupraViewName(String viewName)
      El método setSupraViewName se utiliza para establecer el nombre de la supra-vista de la entidad. Si este método no es ejecutado, el nombre de la supra-vista se determina a partir del nombre SQL de la entidad.
      Parameters:
      viewName - nombre de la supra-vista

    • getPrimaryKeyFieldName

      String getPrimaryKeyFieldName()
      Returns:
      the primary key field name

    • getSequenceFieldName

      String getSequenceFieldName()
      Returns:
      the sequence field name

    • getVersionFieldName

      String getVersionFieldName()
      Returns:
      the version field name

    • getNumericKeyFieldName

      String getNumericKeyFieldName()
      Returns:
      the numeric key field name

    • getCharacterKeyFieldName

      String getCharacterKeyFieldName()
      Returns:
      the character key field name

    • getNameFieldName

      String getNameFieldName()
      Returns:
      the name field name

    • getDescriptionFieldName

      String getDescriptionFieldName()
      Returns:
      the description field name

    • getImageFieldName

      String getImageFieldName()
      Returns:
      the image field name

    • getInactiveIndicatorFieldName

      String getInactiveIndicatorFieldName()
      Returns:
      the inactive indicator field name

    • getUrlFieldName

      String getUrlFieldName()
      Returns:
      the url field name

    • getParentFieldName

      String getParentFieldName()
      Returns:
      the parent field name

    • getOwnerFieldName

      String getOwnerFieldName()
      Returns:
      the owner field name

    • getUserFieldName

      String getUserFieldName()
      Returns:
      the user field name

    • getSegmentFieldName

      String getSegmentFieldName()
      Returns:
      the segment field name

    • getBusinessKeyFieldName

      String getBusinessKeyFieldName()
      Returns:
      the business key field name

    • getStateFieldName

      String getStateFieldName()
      Returns:
      the state field name

    • getBusinessKeyValueOf

      default String getBusinessKeyValueOf(Instance instance)

    • getDefaultPropertyValueOf

      default Object getDefaultPropertyValueOf(Instance instance, Property property)

    • getPrimaryKeyField

      Field getPrimaryKeyField()
      Returns:
      the primary key field

    • getSequenceField

      Field getSequenceField()
      Returns:
      the sequence field

    • getVersionField

      Field getVersionField()
      Returns:
      the version field

    • getNumericKeyField

      Field getNumericKeyField()
      Returns:
      the numeric key field

    • getCharacterKeyField

      Field getCharacterKeyField()
      Returns:
      the character key field

    • getNameField

      Field getNameField()
      Returns:
      the name field

    • getDescriptionField

      Field getDescriptionField()
      Returns:
      the description field

    • getImageField

      Field getImageField()
      Returns:
      the image field

    • getInactiveIndicatorField

      Field getInactiveIndicatorField()
      Returns:
      the inactive indicator field

    • getUrlField

      Field getUrlField()
      Returns:
      the url field

    • getParentField

      Field getParentField()
      Returns:
      the parent field

    • getOwnerField

      Field getOwnerField()
      Returns:
      the owner field

    • getUserField

      Field getUserField()
      Returns:
      the user field

    • getSegmentField

      Field getSegmentField()
      Returns:
      the segment field

    • getBusinessKeyField

      Field getBusinessKeyField()
      Returns:
      the business key field

    • getStateField

      Field getStateField()
      Returns:
      the state field

    • getPrimaryKeyProperty

      Property getPrimaryKeyProperty()
      Returns:
      the primary key property

    • getSequenceProperty

      LongProperty getSequenceProperty()
      Returns:
      the sequence property

    • getVersionProperty

      LongProperty getVersionProperty()
      Returns:
      the version property

    • getNumericKeyProperty

      IntegerProperty getNumericKeyProperty()
      Returns:
      the numeric key property

    • getCharacterKeyProperty

      StringProperty getCharacterKeyProperty()
      Returns:
      the character key property

    • getNameProperty

      StringProperty getNameProperty()
      Returns:
      the name property

    • getDescriptionProperty

      StringProperty getDescriptionProperty()
      Returns:
      the description property

    • getImageProperty

      BinaryProperty getImageProperty()
      Returns:
      the image property

    • getInactiveIndicatorProperty

      BooleanProperty getInactiveIndicatorProperty()
      Returns:
      the inactive indicator property

    • getUrlProperty

      StringProperty getUrlProperty()
      Returns:
      the url property

    • getParentProperty

      Entity getParentProperty()
      Returns:
      the parent property

    • getOwnerProperty

      Entity getOwnerProperty()
      Returns:
      the owner property

    • getUserProperty

      Entity getUserProperty()
      Returns:
      the user property

    • getSegmentProperty

      DataArtifact getSegmentProperty()
      Returns:
      the segment property

    • getBusinessKeyProperty

      Property getBusinessKeyProperty()
      Returns:
      the business key property

    • getBusinessKeyType

      BusinessKeyType getBusinessKeyType()
      Returns:
      the business key type

    • getStateProperty

      Entity getStateProperty()
      Returns:
      the state property

    • isBasicOperationEntity

      boolean isBasicOperationEntity()
      Returns:
      the basic operation entity indicator

    • isCatalogEntity

      boolean isCatalogEntity()
      Returns:
      the catalog entity indicator

    • isContextualEntity

      boolean isContextualEntity()
      Returns:
      true if it is a contextual entity; otherwise false

    • isEnumerationEntity

      boolean isEnumerationEntity()
      Returns:
      true if it is a enumeration entity; otherwise false

    • isBooleanEnumerationEntity

      boolean isBooleanEnumerationEntity()
      Returns:
      true if it is a boolean enumeration entity; otherwise false

    • isNonEnumerationEntity

      boolean isNonEnumerationEntity()
      Returns:
      true if it is a non-enumeration entity; otherwise false

    • isDatabaseEntity

      boolean isDatabaseEntity()
      Returns:
      true if it is a database entity; otherwise false

    • isPersistentEntity

      boolean isPersistentEntity()
      Returns:
      true if it is a persistent entity; otherwise false

    • isPersistentEnumerationEntity

      boolean isPersistentEnumerationEntity()
      Returns:
      true if it is a persistent enumeration entity; otherwise false

    • isPersistentNonEnumerationEntity

      boolean isPersistentNonEnumerationEntity()
      Returns:
      true if it is a persistent non-enumeration entity; otherwise false

    • isEntityCollector

      boolean isEntityCollector()
      Returns:
      true if it is an entity collector; otherwise false

    • isOverlayableEntity

      boolean isOverlayableEntity()
      Returns:
      true if is a overlayable entity; otherwise false

    • isOverlayableEntityReference

      boolean isOverlayableEntityReference()
      Returns:
      true if is a overlayable entity reference; otherwise false

    • isExistentiallyIndependent

      boolean isExistentiallyIndependent()
      Returns:
      the existentially independent indicator

    • getEntityViewType

      EntityViewType getEntityViewType()
      Returns:
      the entity view type

    • isVariantEntity

      boolean isVariantEntity()
      Returns:
      the variant entity indicator

    • isInvariantEntity

      boolean isInvariantEntity()
      Returns:
      the invariant entity indicator

    • isSegmentEqualToOwner

      boolean isSegmentEqualToOwner()
      Returns:
      true if the segment property and the owner property are the same property

    • isSegmentEqualToPrimaryKey

      boolean isSegmentEqualToPrimaryKey()
      Returns:
      true if the segment property and the primary key property are the same property

    • getResourceType

      ResourceType getResourceType()
      Returns:
      the resource yype

    • getResourceGender

      ResourceGender getResourceGender()
      Returns:
      the resource gender

    • getPropertiesPrefix

      String getPropertiesPrefix()
      Returns:
      the properties prefix

    • getPropertiesSuffix

      String getPropertiesSuffix()
      Returns:
      the properties suffix

    • getCollectionName

      String getCollectionName()
      Returns:
      the collection name

    • getHelpDocument

      String getHelpDocument()
      Returns:
      the help document

    • setHelpDocument

      void setHelpDocument(String document)
      sets the help document.
      Parameters:
      document - definición del documento incrustado de ayuda

    • getHelpFileName

      String getHelpFileName()
      Returns:
      the help file name

    • setHelpFileName

      void setHelpFileName(String fileName)
      sets the help file name.
      Parameters:
      fileName - nombre del archivo de ayuda

    • getHelpFileAutoName

      HelpFileAutoName getHelpFileAutoName()
      Returns:
      the help file auto name

    • getHelpFileAutoType

      String getHelpFileAutoType()
      Returns:
      the help file auto type

    • isSelectEnabled

      boolean isSelectEnabled()
      Returns:
      the select allowed indicator

    • setSelectEnabled

      void setSelectEnabled(boolean enabled)
      Parameters:
      enabled - the select enabled indicator to set

    • isSelectOperationAccess

      OperationAccess isSelectOperationAccess()
      Returns:
      the select operation access mode

    • getSelectOnloadOption

      SelectOnloadOption getSelectOnloadOption()
      Returns:
      the select onload option

    • getStartWith

      int getStartWith()
      Returns:
      the start-with

    • getSelectRowsLimit

      int getSelectRowsLimit()
      Returns:
      the select rows limit

    • getSelectSortOption

      SortOption getSelectSortOption()
      Returns:
      the select sort option

    • isInsertEnabled

      boolean isInsertEnabled()
      Returns:
      the insert allowed indicator

    • setInsertEnabled

      void setInsertEnabled(boolean enabled)
      Parameters:
      enabled - the insert enabled indicator to set

    • isInsertConfirmationRequired

      boolean isInsertConfirmationRequired()
      Returns:
      the insert confirmation required indicator

    • getInsertOperationAccess

      OperationAccess getInsertOperationAccess()
      Returns:
      the insert operation access mode

    • getInsertLogging

      OperationLogging getInsertLogging()
      Returns:
      the insert logging mode

    • isUpdateEnabled

      boolean isUpdateEnabled()
      Returns:
      the update allowed indicator

    • setUpdateEnabled

      void setUpdateEnabled(boolean enabled)
      Parameters:
      enabled - the update enabled indicator to set

    • isUpdateConfirmationRequired

      boolean isUpdateConfirmationRequired()
      Returns:
      the update confirmation required indicator

    • getUpdateOperationAccess

      OperationAccess getUpdateOperationAccess()
      Returns:
      the update operation access mode

    • getUpdateLogging

      OperationLogging getUpdateLogging()
      Returns:
      the update logging mode

    • isDeleteEnabled

      boolean isDeleteEnabled()
      Returns:
      the delete allowed indicator

    • setDeleteEnabled

      void setDeleteEnabled(boolean enabled)
      Parameters:
      enabled - the delete enabled indicator to set

    • isDeleteConfirmationRequired

      boolean isDeleteConfirmationRequired()
      Returns:
      the delete confirmation required indicator

    • getDeleteOperationAccess

      OperationAccess getDeleteOperationAccess()
      Returns:
      the delete operation access mode

    • getDeleteLogging

      OperationLogging getDeleteLogging()
      Returns:
      the delete logging mode

    • isReportEnabled

      boolean isReportEnabled()
      Returns:
      the report allowed indicator

    • setReportEnabled

      void setReportEnabled(boolean enabled)
      Parameters:
      enabled - the report enabled indicator to set

    • getReportRowsLimit

      int getReportRowsLimit()
      Returns:
      the report rows limit

    • getReportSortOption

      SortOption getReportSortOption()
      Returns:
      the report sort option

    • isExportEnabled

      boolean isExportEnabled()
      Returns:
      the export allowed indicator

    • setExportEnabled

      void setExportEnabled(boolean enabled)
      Parameters:
      enabled - the export enabled indicator to set

    • getExportRowsLimit

      int getExportRowsLimit()
      Returns:
      the export rows limit

    • getExportSortOption

      SortOption getExportSortOption()
      Returns:
      the export sort option

    • isForeignEntityClass

      boolean isForeignEntityClass()
      Returns:
      the foreign entity class indicator

    • setForeignEntityClass

      void setForeignEntityClass(Boolean foreignEntityClass)
      El método setForeignEntityClass se utiliza para especificar si la entidad se debe agregar, o no, al conjunto de entidades foráneas de la aplicación. Las entidades foráneas son entidades cuyas correspondientes tablas no están definidas en la base de datos de la aplicación, sino en otra que tipicamente reside en un servidor diferente.
      Parameters:
      foreignEntityClass - true o false para agregar o no la entidad, respectivamente; null, para agregar la entidad solo si pertenece a un módulo de entidades foráneas (vea el elemento foreign de la Anotación ProjectModule)

    • isPrivateEntityClass

      boolean isPrivateEntityClass()
      Returns:
      the private entity class indicator

    • setPrivateEntityClass

      void setPrivateEntityClass(Boolean privateEntityClass)
      El método setPrivateEntityClass se utiliza para especificar si la entidad se debe agregar, o no, al conjunto de entidades privadas de la aplicación. Las entidades privadas son entidades para las que no se deben generar vistas.
      Parameters:
      privateEntityClass - true o false para agregar o no la entidad, respectivamente; null, para agregar la entidad solo si pertenece a un módulo de entidades privadas (vea el elemento privacy de la Anotación ProjectModule)

    • isLinkOuterChildren

      boolean isLinkOuterChildren()
      Returns:
      the link-outer-children indicator

    • isLinkOuterCollaterals

      boolean isLinkOuterCollaterals()
      Returns:
      the link-outer-collaterals indicator

    • isLinkOuterSiblings

      boolean isLinkOuterSiblings()
      Returns:
      the link-outer-siblings indicator

    • isTableViewEnabled

      boolean isTableViewEnabled()
      Returns:
      the table view enabled indicator

    • setTableViewEnabled

      void setTableViewEnabled(boolean enabled)
      Parameters:
      enabled - the table view enabled indicator to set

    • isTableViewWithInsertEnabled

      boolean isTableViewWithInsertEnabled()
      Returns:
      the table-view-with-insert-enabled indicator

    • isTableViewWithUpdateEnabled

      boolean isTableViewWithUpdateEnabled()
      Returns:
      the table-view-with-update-enabled indicator

    • isTableViewWithDeleteEnabled

      boolean isTableViewWithDeleteEnabled()
      Returns:
      the table-view-with-delete-enabled indicator

    • isTableViewWithMasterHeading

      boolean isTableViewWithMasterHeading()
      Returns:
      the table-view-with-master-heading indicator

    • isTableViewWithQuickFilterSnippet

      boolean isTableViewWithQuickFilterSnippet()
      Returns:
      the table-view-with-quick-filter-snippet indicator

    • isTableViewWithStickyHeader

      boolean isTableViewWithStickyHeader()
      Returns:
      the table-view-with-sticky-header indicator

    • getTableViewQuickFilterSnippetPath

      String getTableViewQuickFilterSnippetPath()
      Returns:
      the quick-filter-snippet path

    • getTableResponsiveMode

      TableResponsiveMode getTableResponsiveMode()
      Returns:
      the table responsive mode

    • getTableViewHelpDocument

      String getTableViewHelpDocument()
      Returns:
      the table view help document

    • getTableViewHelpFileName

      String getTableViewHelpFileName()
      Returns:
      the table view help file name

    • isDetailViewEnabled

      boolean isDetailViewEnabled()
      Returns:
      the detail view enabled indicator

    • setDetailViewEnabled

      void setDetailViewEnabled(boolean enabled)
      Parameters:
      enabled - the detail view enabled indicator to set

    • getDetailViewHelpDocument

      String getDetailViewHelpDocument()
      Returns:
      the detail view help document

    • getDetailViewHelpFileName

      String getDetailViewHelpFileName()
      Returns:
      the detail view help file name

    • isTreeViewEnabled

      boolean isTreeViewEnabled()
      Returns:
      the tree view enabled indicator

    • setTreeViewEnabled

      void setTreeViewEnabled(boolean enabled)
      Parameters:
      enabled - the tree view enabled indicator to set

    • getTreeViewHelpDocument

      String getTreeViewHelpDocument()
      Returns:
      the tree view help document

    • getTreeViewHelpFileName

      String getTreeViewHelpFileName()
      Returns:
      the tree view help file name

    • isConsoleViewEnabled

      boolean isConsoleViewEnabled()
      Returns:
      the console view enabled indicator

    • setConsoleViewEnabled

      void setConsoleViewEnabled(boolean enabled)
      Parameters:
      enabled - the console view enabled indicator to set

    • getConsoleViewHelpDocument

      String getConsoleViewHelpDocument()
      Returns:
      the console view help document

    • getConsoleViewHelpFileName

      String getConsoleViewHelpFileName()
      Returns:
      the console view help file name

    • isWarningsEnabled

      boolean isWarningsEnabled()
      Returns:
      the warnings enabled indicator

    • isSpecialExpressionsWarningsEnabled

      boolean isSpecialExpressionsWarningsEnabled()
      Returns:
      the special expressions warnings enabled indicator

    • isUnusualExpressionsWarningsEnabled

      boolean isUnusualExpressionsWarningsEnabled()
      Returns:
      the unusual expressions warnings enabled indicator

    • isBplCodeGenEnabled

      boolean isBplCodeGenEnabled()
      Returns:
      the business process logic code generation enabled indicator

    • setBplCodeGenEnabled

      void setBplCodeGenEnabled(boolean enabled)
      Parameters:
      enabled - the business process logic code generation enabled indicator to set

    • isBwsCodeGenEnabled

      boolean isBwsCodeGenEnabled()
      Returns:
      the business web service code generation enabled indicator

    • setBwsCodeGenEnabled

      void setBwsCodeGenEnabled(boolean enabled)
      Parameters:
      enabled - the business web service code generation enabled indicator to set

    • isDaoCodeGenEnabled

      boolean isDaoCodeGenEnabled()
      Returns:
      the data access object code generation enabled indicator

    • setDaoCodeGenEnabled

      void setDaoCodeGenEnabled(boolean enabled)
      Parameters:
      enabled - the data access object code generation enabled indicator to set

    • isDafCodeGenEnabled

      boolean isDafCodeGenEnabled()
      Returns:
      the data access facade code generation enabled indicator

    • setDafCodeGenEnabled

      void setDafCodeGenEnabled(boolean enabled)
      Parameters:
      enabled - the data access facade code generation enabled indicator to set

    • isFwsCodeGenEnabled

      boolean isFwsCodeGenEnabled()
      Returns:
      the facade web service code generation enabled indicator

    • setFwsCodeGenEnabled

      void setFwsCodeGenEnabled(boolean enabled)
      Parameters:
      enabled - the facade web service code generation enabled indicator to set

    • isGuiCodeGenEnabled

      boolean isGuiCodeGenEnabled()
      Returns:
      the GUI code generation enabled indicator

    • setGuiCodeGenEnabled

      void setGuiCodeGenEnabled(boolean enabled)
      Parameters:
      enabled - the GUI code generation enabled indicator to set

    • isSqlCodeGenEnabled

      boolean isSqlCodeGenEnabled()
      Returns:
      the SQL code generation enabled indicator

    • setSqlCodeGenEnabled

      void setSqlCodeGenEnabled(boolean enabled)
      Parameters:
      enabled - the SQL code generation enabled indicator to set

    • isEntityStateCodeGenEnabled

      boolean isEntityStateCodeGenEnabled()
      Returns:
      the entity state machine code generation enabled indicator

    • isEntityClassDiagramGenEnabled

      boolean isEntityClassDiagramGenEnabled()
      Returns:
      the entity class diagram generation indicator

    • isEntityStateDiagramGenEnabled

      boolean isEntityStateDiagramGenEnabled()
      Returns:
      the entity state diagram generation indicator

    • isEntityInsertActivityDiagramGenEnabled

      boolean isEntityInsertActivityDiagramGenEnabled()
      Returns:
      the entity insert activity diagram generation indicator

    • isEntityUpdateActivityDiagramGenEnabled

      boolean isEntityUpdateActivityDiagramGenEnabled()
      Returns:
      the entity update activity diagram generation indicator

    • getProperty

      Property getProperty(String name)
      Parameters:
      name - property's name
      Returns:
      the property with the specified name

    • getReferenceStyle

      EntityReferenceStyle getReferenceStyle()
      Returns:
      the reference style

    • getReferenceFilterBy

      EntityReferenceProperty getReferenceFilterBy()
      Returns:
      the reference filter-by

    • getReferenceFilterByProperty

      Property getReferenceFilterByProperty()
      Returns:
      the reference filter-by proerty

    • getReferenceSortBy

      EntityReferenceProperty getReferenceSortBy()
      Returns:
      the reference sort-by

    • getReferenceSortByProperty

      Property getReferenceSortByProperty()
      Returns:
      the reference sort-by proerty

    • getSearchType

      SearchType getSearchType()
      Returns:
      the search type

    • getListStyle

      ListStyle getListStyle()
      Returns:
      the list style

    • getSearchDisplayFormat

      SearchDisplayFormat getSearchDisplayFormat()
      Returns:
      the search display format

    • getSearchDisplayMode

      DisplayMode getSearchDisplayMode()
      Returns:
      the search display mode

    • getApplicationOrigin

      String getApplicationOrigin()
      Returns:
      the origin (protocol + server + port) of the application containing the entity views

    • setApplicationOrigin

      void setApplicationOrigin(String origin)

    • getApplicationContextRoot

      String getApplicationContextRoot()
      Returns:
      the context-root of the application containing the entity views

    • setApplicationContextRoot

      void setApplicationContextRoot(String contextRoot)

    • getApplicationConsolePath

      String getApplicationConsolePath()
      Returns:
      the path of the processing consoles within the context-root of the application that contains the entity views

    • setApplicationConsolePath

      void setApplicationConsolePath(String consolePath)

    • getApplicationReadingPath

      String getApplicationReadingPath()
      Returns:
      the path of the reading views within the context-root of the application that contains the entity views

    • setApplicationReadingPath

      void setApplicationReadingPath(String readingPath)

    • getApplicationWritingPath

      String getApplicationWritingPath()
      Returns:
      the path of the writing views within the context-root of the application that contains the entity views

    • setApplicationWritingPath

      void setApplicationWritingPath(String writingPath)

    • isApplicationDefaultLocation

      boolean isApplicationDefaultLocation()
      Returns:
      true if the views are in the generated application (default origin and context-root)

    • getSearchQueryFilter

      BooleanExpression getSearchQueryFilter()
      Returns:
      the search query filter

    • getSelectFilter

      BooleanExpression getSelectFilter()
      Returns:
      the select filter

    • getInsertFilter

      BooleanExpression getInsertFilter(EntityReference reference)
      Parameters:
      reference - entity reference
      Returns:
      the insert filter

    • getUpdateFilter

      BooleanExpression getUpdateFilter()
      Returns:
      the update filter

    • getDeleteFilter

      BooleanExpression getDeleteFilter()
      Returns:
      the delete filter

    • getMasterDetailFilter

      BooleanExpression getMasterDetailFilter(EntityReference reference)
      Parameters:
      reference - entity reference
      Returns:
      the master/detail filter

    • getInitialValue

      Object getInitialValue()
      Returns:
      the initial value

    • setInitialValue

      void setInitialValue(Entity initialValue)
      El método setInitialValue se utiliza para establecer el valor inicial de propiedades y parámetros. El valor inicial de las propiedades se utiliza para inicializar el valor de la propiedad en la operación insert de las vistas (páginas) de registro. El valor inicial de los parámetros se utiliza para inicializar el valor del parámetro al ejecutar la operación.
      Parameters:
      initialValue - valor inicial de la propiedad o el parámetro

    • setInitialValue

      void setInitialValue(Instance initialValue)
      El método setInitialValue se utiliza para establecer el valor inicial de propiedades y parámetros. El valor inicial de las propiedades se utiliza para inicializar el valor de la propiedad en la operación insert de las vistas (páginas) de registro. El valor inicial de los parámetros se utiliza para inicializar el valor del parámetro al ejecutar la operación.
      Parameters:
      initialValue - valor inicial de la propiedad o el parámetro

    • setInitialValue

      void setInitialValue(EntityExpression initialValue)
      El método setInitialValue se utiliza para establecer el valor inicial de propiedades y parámetros. El valor inicial de las propiedades se utiliza para inicializar el valor de la propiedad en la operación insert de las vistas (páginas) de registro. El valor inicial de los parámetros se utiliza para inicializar el valor del parámetro al ejecutar la operación.
      Parameters:
      initialValue - valor inicial de la propiedad o el parámetro

    • setInitialValue

      void setInitialValue(SpecialEntityValue initialValue)
      El método setInitialValue se utiliza para establecer el valor inicial de propiedades y parámetros. El valor inicial de las propiedades se utiliza para inicializar el valor de la propiedad en la operación insert de las vistas (páginas) de registro. El valor inicial de los parámetros se utiliza para inicializar el valor del parámetro al ejecutar la operación.
      Parameters:
      initialValue - valor inicial de la propiedad o el parámetro

    • getDefaultValue

      Object getDefaultValue()
      Returns:
      the default value

    • setDefaultValue

      void setDefaultValue(Entity defaultValue)
      El método setDefaultValue se utiliza para establecer el valor por omisión de propiedades y parámetros. El valor por omisión de las propiedades se utiliza al almacenar el valor de la propiedad en la base de datos, dependiendo de la opción seleccionada para el elemento defaultCondition de la anotación PropertyField. El valor por omisión de los parámetros se utiliza al ejecutar la operación.
      Parameters:
      defaultValue - valor por omisión de la propiedad o el parámetro

    • setDefaultValue

      void setDefaultValue(Instance defaultValue)
      El método setDefaultValue se utiliza para establecer el valor por omisión de propiedades y parámetros. El valor por omisión de las propiedades se utiliza al almacenar el valor de la propiedad en la base de datos, dependiendo de la opción seleccionada para el elemento defaultCondition de la anotación PropertyField. El valor por omisión de los parámetros se utiliza al ejecutar la operación.
      Parameters:
      defaultValue - valor por omisión de la propiedad o el parámetro

    • setDefaultValue

      void setDefaultValue(EntityExpression defaultValue)
      El método setDefaultValue se utiliza para establecer el valor por omisión de propiedades y parámetros. El valor por omisión de las propiedades se utiliza al almacenar el valor de la propiedad en la base de datos, dependiendo de la opción seleccionada para el elemento defaultCondition de la anotación PropertyField. El valor por omisión de los parámetros se utiliza al ejecutar la operación.
      Parameters:
      defaultValue - valor por omisión de la propiedad o el parámetro

    • setDefaultValue

      void setDefaultValue(SpecialEntityValue defaultValue)
      El método setDefaultValue se utiliza para establecer el valor por omisión de propiedades y parámetros. El valor por omisión de las propiedades se utiliza al almacenar el valor de la propiedad en la base de datos, dependiendo de la opción seleccionada para el elemento defaultCondition de la anotación PropertyField. El valor por omisión de los parámetros se utiliza al ejecutar la operación.
      Parameters:
      defaultValue - valor por omisión de la propiedad o el parámetro

    • isDisplayAvailable

      boolean isDisplayAvailable()
      Returns:
      true if the entity has at least one display

    • setDisplayAvailable

      void setDisplayAvailable(Boolean displayAvailable)

    • isWritingPageMaster

      boolean isWritingPageMaster()
      Returns:
      true if the entity is master of at least one detail

    • initialise

      void initialise()

    • prepare

      void prepare()

    • settle

      void settle()

    • addAttribute

      Object addAttribute(Property property, String name, Object value)

    • getDeclaringProject

      Project getDeclaringProject()
      Returns:
      the declaring project, if any; null otherwise

    • getRoot

      Entity getRoot()
      Returns:
      the root entity instance of the same class

    • getBaseRoot

      Entity getBaseRoot()
      Returns:
      the root entity instance of the base class

    • getHierarchyRoot

      Entity getHierarchyRoot()
      Returns:
      the root entity instance of the top of the class hierarchy

    • getHierarchyNodeType

      HierarchyNodeType getHierarchyNodeType()
      Returns:
      the class hierarchy node type; null if the entity is not part of a hierarchy

    • getAncestorsList

      List<Entity> getAncestorsList()
      Returns:
      the ancestors list

    • getExtensionsList

      List<Entity> getExtensionsList()
      Returns:
      the known extensions list

    • getExtensionsMap

      Map<String,Entity> getExtensionsMap()
      Returns:
      the direct known extensions map

    • getOverlayEntitiesList

      List<Entity> getOverlayEntitiesList()
      Returns:
      the overlay entities list

    • getOverlayEntitiesMap

      Map<String,Entity> getOverlayEntitiesMap()
      Returns:
      the overlay entities map

    • getAccesibleOperationsOverlayEntitiesList

      List<Entity> getAccesibleOperationsOverlayEntitiesList()
      Returns:
      the accesible operations overlay entities list

    • getAccesibleOperationsOverlayEntitiesMap

      Map<String,Entity> getAccesibleOperationsOverlayEntitiesMap()
      Returns:
      the accesible operations overlay entities map

    • getOperation

      <T extends Operation> T getOperation(Class<T> type)
      Type Parameters:
      T - generic operation type
      Parameters:
      type - operation type
      Returns:
      the operation of the specified class

    • getCrudOperationsList

      List<Operation> getCrudOperationsList()
      Returns:
      the CRUD operation list

    • getBusinessOperationsList

      List<Operation> getBusinessOperationsList()
      Returns:
      the user-defined business operation list

    • getAccesibleBusinessOperationsList

      List<Operation> getAccesibleBusinessOperationsList()
      Returns:
      the user-defined accesible business operation list

    • getRemoveHeadingPropertyArray

      Property[] getRemoveHeadingPropertyArray()
      Returns:
      the array of properties that should be excluded from the heading of Master/Detail views (pages)

    • isRemovePropertiesInRemoveHeadingPropertyArray

      boolean isRemovePropertiesInRemoveHeadingPropertyArray()
      Returns:
      true if the array contains the properties that should be excluded from the heading of Master/Detail views (pages); false, if the array contains the properties that should not be excluded from the heading.

    • isNull

      BooleanComparisonX isNull()
      El método isNull contruye una expresión lógica que genera la comparación de esta entidad con el valor nulo. La comparación resulta en verdadero si el valor de la entidad es nulo.
      Specified by:
      isNull in interface Nullable
      Returns:
      expresión lógica que genera la comparación con el valor nulo.

    • isNotNull

      BooleanComparisonX isNotNull()
      El método isNotNull contruye una expresión lógica que genera la comparación de esta entidad con el valor nulo. La comparación resulta en verdadero si el valor de la entidad no es nulo.
      Specified by:
      isNotNull in interface Nullable
      Returns:
      expresión lógica que genera la comparación con el valor nulo.

    • isEqualTo

      BooleanComparisonX isEqualTo(Entity y)
      El método isEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la entidad que recibe como argumento (operando Y). La comparación resulta en verdadero si ambos operandos son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isEqualTo

      BooleanComparisonX isEqualTo(Instance y)
      El método isEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la instancia que recibe como argumento (operando Y). La comparación resulta en verdadero si ambos operandos son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isEqualTo

      BooleanComparisonX isEqualTo(EntityExpression y)
      El método isEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la expresión que recibe como argumento (operando Y). La comparación resulta en verdadero si ambos operandos son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isNotEqualTo

      BooleanComparisonX isNotEqualTo(Entity y)
      El método isNotEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la entidad que recibe como argumento (operando Y). La comparación resulta en verdadero si ambos operandos no son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isNotEqualTo

      BooleanComparisonX isNotEqualTo(Instance y)
      El método isNotEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la instancia que recibe como argumento (operando Y). La comparación resulta en verdadero si ambos operandos no son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isNotEqualTo

      BooleanComparisonX isNotEqualTo(EntityExpression y)
      El método isNotEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la expresión que recibe como argumento (operando Y). La comparación resulta en verdadero si ambos operandos no son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isNullOrEqualTo

      BooleanComparisonX isNullOrEqualTo(Entity y)
      El método isNullOrEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la entidad que recibe como argumento (operando Y). La comparación resulta en verdadero si el valor del operando X es nulo o si ambos operandos son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isNullOrEqualTo

      BooleanComparisonX isNullOrEqualTo(Instance y)
      El método isNullOrEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la instancia que recibe como argumento (operando Y). La comparación resulta en verdadero si el valor del operando X es nulo o si ambos operandos son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isNullOrEqualTo

      BooleanComparisonX isNullOrEqualTo(EntityExpression y)
      El método isNullOrEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la expresión que recibe como argumento (operando Y). La comparación resulta en verdadero si el valor del operando X es nulo o si ambos operandos son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isNullOrNotEqualTo

      BooleanComparisonX isNullOrNotEqualTo(Entity y)
      El método isNullOrNotEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la entidad que recibe como argumento (operando Y). La comparación resulta en verdadero si el valor del operando X es nulo o si ambos operandos no son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isNullOrNotEqualTo

      BooleanComparisonX isNullOrNotEqualTo(Instance y)
      El método isNullOrNotEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la instancia que recibe como argumento (operando Y). La comparación resulta en verdadero si el valor del operando X es nulo o si ambos operandos no son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • isNullOrNotEqualTo

      BooleanComparisonX isNullOrNotEqualTo(EntityExpression y)
      El método isNullOrNotEqualTo contruye una expresión lógica que genera la comparación de esta entidad (operando X) con la expresión que recibe como argumento (operando Y). La comparación resulta en verdadero si el valor del operando X es nulo o si ambos operandos no son iguales.
      Parameters:
      y - operando Y
      Returns:
      expresión lógica que genera la comparación de ambos operandos.

    • self

      EntityScalarX self()
      El método self contruye una expresión que da como resultado esta entidad.
      Returns:
      expresión que da como resultado esta entidad.

    • coalesce

      EntityOrderedPairX coalesce(Entity y)
      El método coalesce contruye una expresión que genera la comparación de esta entidad (operando X) y de la entidad que recibe como argumento (operando Y) con el valor nulo, en ese orden. La expresión generada retorna el primero de los operandos que no sea nulo.
      Parameters:
      y - operando Y
      Returns:
      expresión que genera el primero de de los operandos que no sea nulo.

    • coalesce

      EntityOrderedPairX coalesce(Instance y)
      El método coalesce contruye una expresión que genera la comparación de esta entidad (operando X) y de la instancia que recibe como argumento (operando Y) con el valor nulo, en ese orden. La expresión generada retorna el primero de los operandos que no sea nulo.
      Parameters:
      y - operando Y
      Returns:
      expresión que genera el primero de de los operandos que no sea nulo.

    • coalesce

      EntityOrderedPairX coalesce(EntityExpression y)
      El método coalesce contruye una expresión que genera la comparación de esta entidad (operando X) y de la expresión que recibe como argumento (operando Y) con el valor nulo, en ese orden. La expresión generada retorna el primero de los operandos que no sea nulo.
      Parameters:
      y - operando Y
      Returns:
      expresión que genera el primero de de los operandos que no sea nulo.