Package adalid.core.interfaces

Interface Entity

    • Method Detail

      • 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

        java.lang.String getDefaultLabel​(EntityReference reference)
        Parameters:
        reference - entity reference
        Returns:
        the default label

      • getDefaultShortLabel

        java.lang.String getDefaultShortLabel​(EntityReference reference)
        Parameters:
        reference - entity reference
        Returns:
        the default short label

      • getDefaultCollectionLabel

        java.lang.String getDefaultCollectionLabel​(EntityReference reference)
        Parameters:
        reference - entity reference
        Returns:
        the default collection label

      • getDefaultCollectionShortLabel

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

      • getDefaultMenuOptionLabel

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

      • getLocalizedLabel

        java.lang.String getLocalizedLabel​(java.util.Locale locale,
                                   EntityReference reference)
        Parameters:
        locale - locale
        reference - entity reference
        Returns:
        the localized label

      • getLocalizedShortLabel

        java.lang.String getLocalizedShortLabel​(java.util.Locale locale,
                                        EntityReference reference)
        Parameters:
        locale - locale
        reference - entity reference
        Returns:
        the localized short label

      • getLocalizedCollectionLabel

        java.lang.String getLocalizedCollectionLabel​(java.util.Locale locale,
                                             EntityReference reference)
        Parameters:
        locale - locale
        reference - entity reference
        Returns:
        the localized collection label

      • getLocalizedCollectionShortLabel

        java.lang.String getLocalizedCollectionShortLabel​(java.util.Locale locale,
                                                  EntityReference reference)
        Parameters:
        locale - locale
        reference - entity reference
        Returns:
        the localized collection short label

      • getLocalizedMenuOptionLabel

        java.lang.String getLocalizedMenuOptionLabel​(java.util.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

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

      • getEntityCollectionsList

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

      • getReferencesList

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

      • getParameterReferencesList

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

      • getKeysList

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

      • getStepsList

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

      • getTabsList

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

      • getViewsList

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

      • getInstancesList

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

      • getNamedValuesList

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

      • getExpressionsList

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

      • getTransitionsList

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

      • getOperationsList

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

      • getOperationClassesList

        java.util.List<java.lang.Class<?>> getOperationClassesList()
        Returns:
        the operation classes list

      • getTriggersList

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

      • getCalculablePropertiesList

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

      • getOverlayPropertiesList

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

      • getQueryPropertiesList

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

      • getPropertiesMap

        java.util.Map<java.lang.String,​Property> getPropertiesMap()
        Returns:
        the properties map

      • getEntityCollectionsMap

        java.util.Map<java.lang.String,​EntityCollection> getEntityCollectionsMap()
        Returns:
        the entity collection map

      • getReferencesMap

        java.util.Map<java.lang.String,​Property> getReferencesMap()
        Returns:
        the references map

      • getParameterReferencesMap

        java.util.Map<java.lang.String,​Parameter> getParameterReferencesMap()
        Returns:
        the parameter references map

      • getKeysMap

        java.util.Map<java.lang.String,​Key> getKeysMap()
        Returns:
        the keys map

      • getStepsMap

        java.util.Map<java.lang.String,​Step> getStepsMap()
        Returns:
        the staps map

      • getTabsMap

        java.util.Map<java.lang.String,​Tab> getTabsMap()
        Returns:
        the tabs map

      • getViewsMap

        java.util.Map<java.lang.String,​View> getViewsMap()
        Returns:
        the views map

      • getInstancesMap

        java.util.Map<java.lang.String,​Instance> getInstancesMap()
        Returns:
        the instances map

      • getNamedValuesMap

        java.util.Map<java.lang.String,​NamedValue> getNamedValuesMap()
        Returns:
        the named values map

      • getExpressionsMap

        java.util.Map<java.lang.String,​Expression> getExpressionsMap()
        Returns:
        the expressions map

      • getTransitionsMap

        java.util.Map<java.lang.String,​Transition> getTransitionsMap()
        Returns:
        the transitions map

      • getOperationsMap

        java.util.Map<java.lang.String,​Operation> getOperationsMap()
        Returns:
        the operations map

      • getOperationClassesMap

        java.util.Map<java.lang.String,​java.lang.Class<?>> getOperationClassesMap()
        Returns:
        the operation classes map

      • getTriggersMap

        java.util.Map<java.lang.String,​Trigger> getTriggersMap()
        Returns:
        the triggers map

      • getCalculablePropertiesMap

        java.util.Map<java.lang.String,​Property> getCalculablePropertiesMap()
        Returns:
        the calculable properties map

      • getOverlayPropertiesMap

        java.util.Map<java.lang.String,​Property> getOverlayPropertiesMap()
        Returns:
        the overlay properties map

      • getQueryPropertiesMap

        java.util.Map<java.lang.String,​Property> getQueryPropertiesMap()
        Returns:
        the query properties map

      • getMainEntityReferenceFrom

        EntityReference getMainEntityReferenceFrom​(java.lang.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

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

      • getSubclassesList

        java.util.List<java.lang.Class<?>> getSubclassesList()
        Returns:
        the direct known subclasses list

      • getSubclassesMap

        java.util.Map<java.lang.String,​java.lang.Class<?>> getSubclassesMap()
        Returns:
        the direct known subclasses map

      • getAllocationOverridesList

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

      • getAllocationOverridesMap

        java.util.Map<java.lang.String,​AllocationOverride> getAllocationOverridesMap()
        Returns:
        the allocation overrides map

      • getPrimaryKeyFieldName

        java.lang.String getPrimaryKeyFieldName()
        Returns:
        the primary key field name

      • getSequenceFieldName

        java.lang.String getSequenceFieldName()
        Returns:
        the sequence field name

      • getVersionFieldName

        java.lang.String getVersionFieldName()
        Returns:
        the version field name

      • getNumericKeyFieldName

        java.lang.String getNumericKeyFieldName()
        Returns:
        the numeric key field name

      • getCharacterKeyFieldName

        java.lang.String getCharacterKeyFieldName()
        Returns:
        the character key field name

      • getNameFieldName

        java.lang.String getNameFieldName()
        Returns:
        the name field name

      • getDescriptionFieldName

        java.lang.String getDescriptionFieldName()
        Returns:
        the description field name

      • getImageFieldName

        java.lang.String getImageFieldName()
        Returns:
        the image field name

      • getInactiveIndicatorFieldName

        java.lang.String getInactiveIndicatorFieldName()
        Returns:
        the inactive indicator field name

      • getUrlFieldName

        java.lang.String getUrlFieldName()
        Returns:
        the url field name

      • getParentFieldName

        java.lang.String getParentFieldName()
        Returns:
        the parent field name

      • getOwnerFieldName

        java.lang.String getOwnerFieldName()
        Returns:
        the owner field name

      • getUserFieldName

        java.lang.String getUserFieldName()
        Returns:
        the user field name

      • getSegmentFieldName

        java.lang.String getSegmentFieldName()
        Returns:
        the segment field name

      • getBusinessKeyFieldName

        java.lang.String getBusinessKeyFieldName()
        Returns:
        the business key field name

      • getStateFieldName

        java.lang.String getStateFieldName()
        Returns:
        the state field name

      • getBusinessKeyValueOf

        default java.lang.String getBusinessKeyValueOf​(Instance instance)

      • getDefaultPropertyValueOf

        default java.lang.Object getDefaultPropertyValueOf​(Instance instance,
                                                   Property property)

      • getPrimaryKeyField

        java.lang.reflect.Field getPrimaryKeyField()
        Returns:
        the primary key field

      • getSequenceField

        java.lang.reflect.Field getSequenceField()
        Returns:
        the sequence field

      • getVersionField

        java.lang.reflect.Field getVersionField()
        Returns:
        the version field

      • getNumericKeyField

        java.lang.reflect.Field getNumericKeyField()
        Returns:
        the numeric key field

      • getCharacterKeyField

        java.lang.reflect.Field getCharacterKeyField()
        Returns:
        the character key field

      • getNameField

        java.lang.reflect.Field getNameField()
        Returns:
        the name field

      • getDescriptionField

        java.lang.reflect.Field getDescriptionField()
        Returns:
        the description field

      • getImageField

        java.lang.reflect.Field getImageField()
        Returns:
        the image field

      • getInactiveIndicatorField

        java.lang.reflect.Field getInactiveIndicatorField()
        Returns:
        the inactive indicator field

      • getUrlField

        java.lang.reflect.Field getUrlField()
        Returns:
        the url field

      • getParentField

        java.lang.reflect.Field getParentField()
        Returns:
        the parent field

      • getOwnerField

        java.lang.reflect.Field getOwnerField()
        Returns:
        the owner field

      • getUserField

        java.lang.reflect.Field getUserField()
        Returns:
        the user field

      • getSegmentField

        java.lang.reflect.Field getSegmentField()
        Returns:
        the segment field

      • getBusinessKeyField

        java.lang.reflect.Field getBusinessKeyField()
        Returns:
        the business key field

      • getStateField

        java.lang.reflect.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

      • 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

        java.lang.String getPropertiesPrefix()
        Returns:
        the properties prefix

      • getPropertiesSuffix

        java.lang.String getPropertiesSuffix()
        Returns:
        the properties suffix

      • getCollectionName

        java.lang.String getCollectionName()
        Returns:
        the collection name

      • getHelpDocument

        java.lang.String getHelpDocument()
        Returns:
        the help document

      • setHelpDocument

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

      • getHelpFileName

        java.lang.String getHelpFileName()
        Returns:
        the help file name

      • setHelpFileName

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

      • getHelpFileAutoName

        HelpFileAutoName getHelpFileAutoName()
        Returns:
        the help file auto name

      • getHelpFileAutoType

        java.lang.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​(java.lang.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​(java.lang.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

      • getTableViewHelpDocument

        java.lang.String getTableViewHelpDocument()
        Returns:
        the table view help document

      • getTableViewHelpFileName

        java.lang.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

        java.lang.String getDetailViewHelpDocument()
        Returns:
        the detail view help document

      • getDetailViewHelpFileName

        java.lang.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

        java.lang.String getTreeViewHelpDocument()
        Returns:
        the tree view help document

      • getTreeViewHelpFileName

        java.lang.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

        java.lang.String getConsoleViewHelpDocument()
        Returns:
        the console view help document

      • getConsoleViewHelpFileName

        java.lang.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

      • 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​(java.lang.String name)
        Parameters:
        name - property's name
        Returns:
        the property with the specified name

      • 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

      • getSearchDisplayFormat

        SearchDisplayFormat getSearchDisplayFormat()
        Returns:
        the search display format

      • getSearchDisplayMode

        DisplayMode getSearchDisplayMode()
        Returns:
        the search display mode

      • getApplicationOrigin

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

      • setApplicationOrigin

        void setApplicationOrigin​(java.lang.String origin)

      • getApplicationContextRoot

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

      • setApplicationContextRoot

        void setApplicationContextRoot​(java.lang.String contextRoot)

      • getApplicationConsolePath

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

      • setApplicationConsolePath

        void setApplicationConsolePath​(java.lang.String consolePath)

      • getApplicationReadingPath

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

      • setApplicationReadingPath

        void setApplicationReadingPath​(java.lang.String readingPath)

      • getApplicationWritingPath

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

      • setApplicationWritingPath

        void setApplicationWritingPath​(java.lang.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

      • getMasterDetailFilter

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

      • getInitialValue

        java.lang.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

        java.lang.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​(java.lang.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

        java.lang.Object addAttribute​(Property property,
                              java.lang.String name,
                              java.lang.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

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

      • getExtensionsList

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

      • getExtensionsMap

        java.util.Map<java.lang.String,​Entity> getExtensionsMap()
        Returns:
        the direct known extensions map

      • getOverlayEntitiesList

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

      • getOverlayEntitiesMap

        java.util.Map<java.lang.String,​Entity> getOverlayEntitiesMap()
        Returns:
        the overlay entities map

      • getAccesibleOperationsOverlayEntitiesList

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

      • getAccesibleOperationsOverlayEntitiesMap

        java.util.Map<java.lang.String,​Entity> getAccesibleOperationsOverlayEntitiesMap()
        Returns:
        the accesible operations overlay entities map

      • getOperation

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

      • getCrudOperationsList

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

      • getBusinessOperationsList

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

      • getAccesibleBusinessOperationsList

        java.util.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.