Interface Entity

    • Method Detail

      • isInitialised

        boolean isInitialised()
        Returns:
        the initialised indicator
      • isSettled

        boolean isSettled()
        Returns:
        the settled indicator
      • isFinished

        boolean isFinished()
        Returns:
        the finished 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
      • 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
      • 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
      • 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
      • getAllocationOverridesList

        List<AllocationOverride> getAllocationOverridesList()
        Returns:
        the allocation overrides list
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • isInsertConfirmationRequired

        boolean isInsertConfirmationRequired()
        Returns:
        the insert confirmation required indicator
      • isInsertOperationAccess

        OperationAccess isInsertOperationAccess()
        Returns:
        the insert operation access mode
      • getInsertLogging

        OperationLogging getInsertLogging()
        Returns:
        the insert logging mode
      • isUpdateEnabled

        boolean isUpdateEnabled()
        Returns:
        the update allowed indicator
      • isUpdateConfirmationRequired

        boolean isUpdateConfirmationRequired()
        Returns:
        the update confirmation required indicator
      • isUpdateOperationAccess

        OperationAccess isUpdateOperationAccess()
        Returns:
        the update operation access mode
      • getUpdateLogging

        OperationLogging getUpdateLogging()
        Returns:
        the update logging mode
      • isDeleteEnabled

        boolean isDeleteEnabled()
        Returns:
        the delete allowed indicator
      • isDeleteConfirmationRequired

        boolean isDeleteConfirmationRequired()
        Returns:
        the delete confirmation required indicator
      • isDeleteOperationAccess

        OperationAccess isDeleteOperationAccess()
        Returns:
        the delete operation access mode
      • getDeleteLogging

        OperationLogging getDeleteLogging()
        Returns:
        the delete logging mode
      • isReportEnabled

        boolean isReportEnabled()
        Returns:
        the report allowed indicator
      • getReportRowsLimit

        int getReportRowsLimit()
        Returns:
        the report rows limit
      • getReportSortOption

        SortOption getReportSortOption()
        Returns:
        the report sort option
      • isExportEnabled

        boolean isExportEnabled()
        Returns:
        the export allowed indicator
      • 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
      • isPrivateEntityClass

        boolean isPrivateEntityClass()
        Returns:
        the private entity class indicator
      • 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 allowed indicator
      • 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 allowed indicator
      • 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 allowed indicator
      • 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 allowed indicator
      • 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
      • isBwsCodeGenEnabled

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

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

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

        boolean isSqlCodeGenEnabled()
        Returns:
        the SQL code generation enabled indicator
      • 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
      • getReferenceFilterByProperty

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

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

        SearchType getSearchType()
        Returns:
        the search type
      • getListStyle

        ListStyle getListStyle()
        Returns:
        the list style
      • getSearchDisplayMode

        DisplayMode getSearchDisplayMode()
        Returns:
        the search display mode
      • getSearchQueryFilter

        BooleanExpression getSearchQueryFilter()
        Returns:
        the search query 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
      • isWritingPageMaster

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

        void initialise()
      • prepare

        void prepare()
      • settle

        void settle()
      • finish

        void finish()
      • 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
      • getExtensionsList

        List<Entity> getExtensionsList()
        Returns:
        the direct 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
      • 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
      • getAccesibleConstructionOperationsList

        List<Operation> getAccesibleConstructionOperationsList()
        Returns:
        the user-defined accesible construction operation list of this entity class
      • getAccesibleConstructionOperationsList

        List<Operation> getAccesibleConstructionOperationsList​(Entity master)
        Parameters:
        master - a second entity class to search for construction operations of this entity class.
        Returns:
        the user-defined accesible construction operation list of this entity class; if parameter master is not null, construction operations defined in the master entity class are also included.
      • 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.